Documentos de Académico
Documentos de Profesional
Documentos de Cultura
User Guide
AVEVA Solutions Ltd
Disclaimer
Information of a technical nature, and particulars of the product and its use, is given by AVEVA
Solutions Ltd and its subsidiaries without warranty. AVEVA Solutions Ltd and its subsidiaries disclaim
any and all warranties and conditions, expressed or implied, to the fullest extent permitted by law.
Neither the author nor AVEVA Solutions Ltd, or any of its subsidiaries, shall be liable to any person or
entity for any actions, claims, loss or damage arising from the use or possession of any information,
particulars, or errors in this publication, or any incorrect use of the product, whatsoever.
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 AVEVA Solutions Ltd or its subsidiaries.
All other rights are reserved to AVEVA Solutions Ltd 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 Ltd. Where such
permission is granted, it expressly requires that this Disclaimer and Copyright notice 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 Ltd. The user may also not
reverse engineer, decompile, copy, or adapt the associated software. Neither the whole, nor part of the
product described in this publication may be incorporated into any third-party software, product,
machine, or system without the prior written permission of AVEVA Solutions Ltd, save as permitted by
law. Any such unauthorised action is strictly prohibited, and may give rise to civil liabilities and criminal
prosecution.
The AVEVA products described in this guide are to be installed and operated strictly in accordance with
the terms and conditions of the respective license agreements, and in accordance with the relevant
User Documentation. Unauthorised or unlicensed use of the product is strictly prohibited.
AVEVA Solutions Ltd, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom
Trademarks
AVEVA and Tribon are registered trademarks of AVEVA Solutions Ltd or its subsidiaries. Unauthorised
use of the AVEVA or Tribon trademarks is strictly forbidden.
AVEVA product names are trademarks or registered trademarks of AVEVA Solutions Ltd or its
subsidiaries, registered in the UK, Europe and other countries (worldwide).
The copyright, trade mark rights, or other intellectual property rights in any other product, its name or
logo belongs to its respective owner.
Diagrams User Guide
Contents Page
Diagrams
Diagrams Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Document Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Diagrams Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Database Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:2
Main Operating Principles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:3
i 12.0
Diagrams User Guide
ii 12.0
Diagrams User Guide
iii 12.0
Diagrams User Guide
iv 12.0
Diagrams User Guide
v 12.0
Diagrams User Guide
Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:1
Releasing Information for 3D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:1
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:1
Setting the Release Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:2
Visualizing Release and Link to 3D Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:6
Warnings and Restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:7
Released but not Linked Items. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:7
Released and Linked Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:8
vi 12.0
Diagrams User Guide
Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:1
Batch Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:1
Batch Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:2
Batch Consistency Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:8
Batch Print . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:9
Project Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:10
Clean Old Session Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:10
AVEVA Instrumentation Data Update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:11
DWG Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:12
Visio Drawing Items Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:14
User Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:16
Settings Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:17
Lines Map Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:18
Layers Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:19
Configuration - DWG Export Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:20
Creating Line Patterns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:20
Appendices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A:1
Attribute Presentation Notation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:1
Pseudo Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:2
Customisation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:2
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:2
Using the Visio Drawing Control. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:3
vii 12.0
Diagrams User Guide
viii 12.0
Diagrams User Guide
Diagrams Overview
1 Diagrams Overview
1.2 Prerequisites
Before starting to use the Diagrams application, it is recommended that users acquire some
general knowledge about using applications based on the AVEVA Design platform:
Database principles, such as MDBs, sessions, DB elements, attributes, references etc.
Using the command line
Handling of the Application framework GUI, with docking windows etc.
General Microsoft Visio knowledge.
You also need to be familiar with the main principles of using Catalogues and
Specifications. Please refer to the Catalogues and Specifications User Guide for more
information.
These functions are relevant for the usage of the Diagrams application, but are outside the
scope for this manual.
1:1 12.0
Diagrams User Guide
Diagrams Overview
The diagram documents created through the Diagrams application will be stored in the file
system or an external document management system. There are index elements in the
1:2 12.0
Diagrams User Guide
Diagrams Overview
database for each diagram, stencil and template. Diagrams, stencils and templates are
listed and opened through the DB index elements.
In addition to the MS Visio Diagram files the application also creates SVG format files for the
purpose of viewing the diagrams in the Schematic 3D Integrator.
1:3 12.0
Diagrams User Guide
Diagrams Overview
1:4 12.0
Diagrams User Guide
Application Setup
2 Application Setup
This chapter covers the database setup and runtime environment for the application. It is
primarily intended for administrators who will set up the project environment for using
Diagrams and for advanced users who need a deeper knowledge in how the application
operates on a technical level.
2:1 12.0
Diagrams User Guide
Application Setup
delete obsolete versions of the files when a database session merge is executed, however
the Diagrams application provides a tool for removing old session files from a project. It
could be used manually when KEEP_SESSION_FILES is set to False. For more information
please refer to Clean Old Session Files in Chapter Utilities.
At the same time as a diagram file is saved, an SVG format file is optionally created. This is
for the purpose of viewing the diagrams in other applications such as the Schematic 3D
Integrator without having the need for an MS Visio installation. In the same way as querying
the VISF attribute on the SCDIAG element for obtaining the MS Visio diagram file name, the
SVG file name can be found by querying the NVIEWF attribute.
On large diagrams, or diagrams that contain detailed imported background drawings, the
creation of the SVG file may take some time to execute. This could affect the performance
of the Save Work command. For that reason a possibility to control the SVG creation has
been introduced.
Whether the SVG file is created or not depends on the General Options > System
configuration > SVG setting in Diagrams Options.
If this setting is False, then the SVG file will only be created if the drawing contains or
has contained any items released to 3D.
If this setting is True, the SVG file will always be created.
When an SVG file is created, there will be a message in the message log indicating this.
Note: By changing the KEEP_SESSION_FILES default setting to False, only the latest
version of the Visio diagram file as well as the SVG file will be kept. Please consider
that using this setting will not make it possible to restore a previous session including
the corresponding diagram file version.
MS Visio templates and stencils are handled in the same way as the diagrams, using
SCTEMP and SCSTEN index elements in the database. One difference however, is that no
SVG format files are created when templates and stencils are saved by the application.
The setting provides possibility to choose if drawings, templates and stencils should be
stored in binary (*.vsd, *.vst, *.vss) or XML format (*.vdx, *.vtx, *.vsx).
It is recommended to save documents in a binary format which is more efficient and
improves performance of Save Work and Open operations. For that reason it is used by
default in the Diagrams application.
2:2 12.0
Diagrams User Guide
Application Setup
It is possible to check in which format the document was last saved by querying SCHFF
(schematic file format) attribute of SCDIAG, SCTEMP or SCSTEN. It can have the following
values:
0 - Visio XML format
1 - binary format
When Save Work is performed all opened documents (also unchanged) with file format not
corresponding to the Save documents in Visio XML format setting will be saved again in an
appropriate format.
2:3 12.0
Diagrams User Guide
Application Setup
RECONFIGURE
6. All data have now been copied together with associated files (for diagrams, templates
and stencils) and no other action is required before they can be used.
For more information please refer to chapter Reconfigure in the Administrator Command
Reference Manual.
2.3.1 Schematic DB
A new schematic (SCHE) database must be created in a project where Diagrams will be
used. For more information on how to create databases please refer to your Data
Management and Data Base / Administrator User Guide.
2.3.3 Groups
When a schematic database has been set up, any number of Schematic Group elements
(SCGROU) can be created to form the primary hierarchy in the database. This can be
considered similar to a folder structure in the file system. Schematic groups can be used to
hold schematic elements, such as diagrams, stencils, templates, equipment, pipelines,
cables and HVACLines. Schematic groups can also be nested in an arbitrary number of
levels (having groups within groups). To create Schematic Groups, right click in the
Schematic Explorer, or use the command line. It is also possible to import a standard Group
structure into the database from a spreadsheet using the Spreadsheet Import function
(please refer to Import in Chapter Working with Diagrams).
2:4 12.0
Diagrams User Guide
Application Setup
2.3.4 Systems
The System Hierarchy can be created and maintained through the Tools > Utilities >
System Hierarchy command. For each system, there is also a subordinate SYSCDA
element containing default values per system for the Diagrams application. For instance,
when creating a new pipeline, the Pipe spec, Insulation Spec, Fluid Ref etc. can
automatically be picked up from the defaults set up in the SYSCDA element. Please refer to
the Design Common Functionality User Guide for setting up this data.
The System Hierarchy command is also available in the 3D Design applications.
Note: To be able to create and modify the System Hierarchy, it is required that the MDB
contains a writeable Design DB where the System Hierarchy resides.
Note: The SYSCDA elements are not visible in the System Explorer.
2:5 12.0
Diagrams User Guide
Application Setup
2:6 12.0
Diagrams User Guide
Getting Started
3 Getting Started
This chapter describes how to get started with the Diagrams application, making settings
and creating base data etc. This chapter is primarily aimed at users who will be setting up
the working environment for users. These could be super-users or CAD co-ordinators.
Note: Chapters Starting the Application and Making Settings for the Program Session
apply to all users.
Note: The Diagrams application requires an MDB that contains one or more schematic
databases. Please refer to section Database Setup in Chapter Application Setup for
more details.
3:1 12.0
Diagrams User Guide
Getting Started
3:2 12.0
Diagrams User Guide
Getting Started
By clicking on the line for each type, a browse button will appear and a suitable group
can be selected by clicking this button.
If the same group is wanted for all elements, use the Apply to All button to set the group for
all elements in one go. The initial group for this option is calculated from CE (Current
Element) when the dialogue is entered. If there is a need to change this, use the button
to browse the database for a new group.
In case new groups need to be created, this will have to be done before going into this
dialogue. New groups can be created by right clicking on the schematic world or on existing
groups in the Schematic Explorer and selecting the Create Group command. This must
then be done before the Default Groups can be selected.
3:3 12.0
Diagrams User Guide
Getting Started
3:4 12.0
Diagrams User Guide
Getting Started
Note: This is however not done by clicking in the status bar, but is instead done by
selecting a line in the schematic explorer.
3.3.1 Overview
In the Tools menu the following commands are available:
Visio Options. This is the standard MS Visio Options dialogue (available at Tools >
Options in MS Visio). Please refer to the MS Visio documentation for more information.
Note: In Vision options, there is an option to disable Automation events (Advanced tab-
>Enable Automation events). AVEVA Diagrams is depending on these events.
Without them, the application is blind and if they are disabled, AVEVA Diagrams will
stop working.
3:5 12.0
Diagrams User Guide
Getting Started
Defaults
In the Diagrams Options dialogue, there are a several settings that will control the operation
of the application. Below the settings pane is a grey box providing an explanation for each
setting. The settings are further described in the documentation for the respective functions.
If changes have been made when the dialogue is closed by clicking the OK button, the
dialogue window below will appear. In case the user clicks Yes the default settings will be
3:6 12.0
Diagrams User Guide
Getting Started
saved for the next program session. If the user clicks No, the settings will only apply to the
current program session.
By default Diagrams Defaults are machine specific and should be configured separately on
each machine, but it is also possible to make them specific for the project. For more
information about handling settings files please see Working with Diagrams Options in
Document Files, Sessions etc. in Chapter Application Setup.
Attribute Presentation
3:7 12.0
Diagrams User Guide
Getting Started
On the Attribute Presentation tab the user can set up the attribute presentation to be used
in the Custom Properties Window / Shape Data Window as well as in the Item List. To the
left there is a tree-view containing the different element types relevant to the Diagrams
application. In case UDETs have been defined, these will be included in the list.
For each element type selected in the tree-view, the attribute presentation can be
individually controlled by the settings in the right hand list view. The columns in the table are
as follows:
By clicking the Move Up and Move Down buttons, the presentation order of the currently
selected attribute can be changed.
In the Import Shape Wizard there is a possibility to override the default attribute presentation
settings for individual shapes. In case this override should be enabled, the Allow individual
shape settings to override default settings should be checked. This setting can be
applied individually for each element type by first selecting a type in the tree before clicking
the checkbox. If this is not checked, any attribute presentation settings done in the Import
Shape Wizard for individual shapes will be ignored.
By clicking the Referenced attributes button, it is possible to add attributes from
referenced or hierarchically superior elements.
If changes have been made when the dialogue is closed by clicking the OK button, the
below dialogue will be shown. In case the user clicks Yes the attribute presentation settings
will be saved for the next program session. If the user clicks No, the settings will only apply
to the current program session.
By default Attribute Presentation settings are machine specific and should be configured
separately on each machine, but it is also possible to make them specific for the project. For
more information about handling settings files please see Working with Diagrams Options
chapter Document Files, Sessions etc. in Chapter Application Setup.
3:8 12.0
Diagrams User Guide
Getting Started
3:9 12.0
Diagrams User Guide
Getting Started
Note: Pseudo attributes are not shown in the list of attributes in Attribute Presentation
and Referenced Attributes dialogues. In case pseudo attributes should be
presented, these will have to be added manually by using the Key-in method
described above. A few pseudo attributes that can be useful for the Diagrams user
are described in Pseudo Attributes in Chapter Appendices.
After a drawing is opened it is possible to force updating all shapes by calling Tools
>Upgrade>Upgrade Drawing. The function will traverse the shapes on the current drawing
and upgrade the ones created in previous versions of the Diagrams application. The shapes
that have a format that is not recognized will be ignored. Please note that the command
Upgrade Drawing will update the shapes' formats only and will not create or delete any
links between shapes and database elements.
3:10 12.0
Diagrams User Guide
Getting Started
3.5.1 Overview
A major part of the Diagrams functionality is based on a set of specialized 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 equivalence 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 Diagrams and handled by the application logic must
be created through the Import Shape Wizard accessible through the Tools menu. Examples
of these are as follows:
Shapes corresponding to DB elements, for instance branches, valves, instruments and
fittings.
Off-page connector shapes.
Label shapes presenting attribute information.
Shapes processed by the Import Shape Wizard will be stored in a user-selected stencil and
will contain data specific to the 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 they will not be handled intelligently by the
application.
Diagrams shapes can also contain default attribute values, which can enable users to
create specialized shapes and will reduce the amount of information that is necessary to
enter when diagrams are created.
By investing some time and effort in the creation of stencils and shapes, the application can
be tailored to work as efficiently as possible for the needs of the user. Thereby time and
effort can later be saved when these shapes are used to build up diagrams.
Note: To be able to create shapes with special features, the MS Visio Shape Sheet has to
be used. For technical reasons, this is not available in the Diagrams application. In
case you need to access the Shape Sheet for making special settings in the shapes
before import, you will have to copy the shape to the Standard MS Office Visio
application, access the Shape Sheet, and then copy the shape back to Diagrams.
When drawing the shape, it is recommended to use the same grid setting that will apply
when the shape will be used in the drawing, thereby avoiding alignment and snapping
problems. To minimize the risk for mistakes when different zoom settings are used, the grid
can be set to Fixed. A suitable grid size is suggested to be 1 mm. The Ruler & Grid
3:11 12.0
Diagrams User Guide
Getting Started
dialogue is available from the Tools > Ruler and Grid command in the main application
menu.
It is also preferable to use a X any Y size of the shape that is evenly dividable with 2, so that
connection points can be conveniently placed at grid intersections.
Connection points can be added to shapes by using the Connection Point Tool available
on the dropdown for connector tool in the Standard toolbar.
3:12 12.0
Diagrams User Guide
Getting Started
To add connection points, Ctrl+Click using this tool. For inline pipe/HVAC parts, the order in
which connection points are added is relevant, as the first added connection point will
correspond to ppoint 1 on the catalogue item. When an inline fitting is connected, Arrive and
Leave are resolved depending on the connections. I.e. if conn 1 is connected to Leave of
another fitting during define, conn 1 will be Arrive and vice versa. If it is not connected when
defined, Arrive and Leave will default to 1 and 2. The direction of the connection points can
be changed by right clicking on a connection point and selecting Inward, Outward or
Inward & Outward.
Note: These directions are NOT related to flow directions of the component. This only
relates to Visio mechanisms for connecting shapes to each other. Connection points
for 2D shapes (such as Equipment, Valves, Fittings etc.) should normally be Inward.
Only use Outward connection points if you intend the shape to be directly connected
to other 2D shapes. The normal approach is to always use Inward when shapes are
created, and to change them to Outward after dropping on a drawing only in case the
shape should be connected to another 2D shape. (refer to Connecting Fittings
without a Tube in between in Chapter Piping & Instrumentation Diagrams (P&IDs)).
Note: When creating grouped piping/HVAC shapes having connection points, please make
sure to first group the shapes and then add the connection points to the group. In
case connection points are added to the members of the group, this could result in
difficulties to connect pipes/HVACs when the shapes are used. For electrical items, it
is OK to have connection points on group members as this is specially handled by
the application when cables are connected.
3:13 12.0
Diagrams User Guide
Getting Started
Note: When grouping shapes, use the Group command rather than Convert to group, as
the former works better with the Diagrams application.
For shapes that can be attached to other shapes using a control handle, such as labels and
off-line instruments, it can be preferred to have an attach line showing where the item is
connected. This can be achieved by going though the following steps:
1. Create the shape in MS Visio by using the drawing tools.
2. Group the shape (required for the attachment line to appear behind).
3. Access the Shape Sheet (available on the right click menu).
4. If there is not any Controls section, create a new (Right click > Insert section).
5. Create a new Geometry section having a MoveTo at the desired origin point of the line
(centre of the shape is =Width*0.5 and =Height*0.5).
6. In the LineTo, refer to =Controls.Row_1 and Controls.Row_1.Y.
7. In order to get the attachment line behind the shape rather than in front of it, right click
on the shape and select Format > Behaviour. Then change Group Data to Behind
member shapes.
3:14 12.0
Diagrams User Guide
Getting Started
8. If the attachment line should originate from the corner points rather than from the
centre point, the following formulas could be entered on the MoveTo line of the
Geometry section: =IF(Controls.Row_1>Width*0.5,Width,0) and
=IF(Geometry1.Y2>Height*0.5,Height,0).
3:15 12.0
Diagrams User Guide
Getting Started
9. The attachment line will now snap to the nearest corner point as the control point is
being moved.
10. 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.Ch
ecked))) action and referring the Checked property using the
=NOT(Actions.Row_1.Checked)formula from the NoShow property of the
Geometry section:
11. The attachment line can now be turned on and off by using the shape right click menu.
3:16 12.0
Diagrams User Guide
Getting Started
Note: It is also possible to add features to the Visio shapes after they have been imported
using the Import Shape Wizard. When this wizard is executed, it will add properties in
sections such as Custom Properties, User-defined cells, Controls etc. To avoid
malfunctions in the Diagrams application, these rows must not be modified.
However, adding new rows to these sections is allowed.
The table below provides some specific information for each kind of shape to be imported:
3:17 12.0
Diagrams User Guide
Getting Started
3:18 12.0
Diagrams User Guide
Getting Started
3:19 12.0
Diagrams User Guide
Getting Started
2. If the shape has been drawn as separate entities, e.g. two separate lines, or a line and
a text etc., it must be grouped before proceeding. Normally shapes should be grouped
BEFORE connection points are added, refer to further information in Creating MS Visio
Shapes
3. If relevant, attach connection points by using the Connection Point tool and
Ctrl+Click to add the points to the shape.
4. Make sure that the stencil that you want to add the shapes to is open.
5. Select the shape(s), (several shapes can be imported in one go, but they must be of
the same type).
6. Select Tools > Import Shape. This will start the Import Shape Wizard that will guide
you through the steps to transform the shapes into Diagrams shapes.
An alternative way of doing this is to create the Diagrams shape directly on the drawing. To
achieve that the below steps should be followed:
1. Create a shape in a diagram drawing using standard Visio drawing tools and according
to the instructions in Creating MS Visio Shapes shapes.
2. If the shape has been drawn as separate entities, e.g. two separate lines, or a line and
a text etc., it must be grouped before proceeding. Normally shapes should be grouped
BEFORE connection points are added, refer to further information in Creating MS Visio
Shapes.
3. f relevant, attach the connection points by using the Connection Point tool and
Ctrl+Click to add the points to the shape.
4. Select the Object > Define command from the menu or click the appropriate button on
the Object toolbar. The Define Item Wizard window will open and by the following
steps similar to the Import Shape Wizard, it will be possible to configure the shape and
transform it to a Diagrams shape. In addition after the dialogue is closed, the shape will
be defined in the way it would be after dropping it from a stencil.
Overview
Prior to starting the Import Shape Wizard, one or more shapes must have been selected on
the current drawing. In case more than one shape has been selected, they will all receive a
common type, common presentation settings etc. when the wizard has completed. Only the
name will be different. If shapes of different types should be imported, the wizard must be
executed once for each type of shape.
When the Import Shape Wizard starts, it will perform an optional scale check of the shape.
In the Diagrams Options > System Configuration > Import Shape a min/max height/width
can be set up. Import Shape will check against these values and give a warning to the user
in case the shape exceeds or falls below the set limits.
3:20 12.0
Diagrams User Guide
Getting Started
The four steps of the import shape wizard allows the user to set up the following information
for the imported shapes:
Note: For piping and HVAC branches, a Denote to dropdown box will appear. This can be
used to select the tube/duct type that a branch should be denoted to when dropped
on to the drawing.
When a branch shape is dropped on to a drawing, a new branch element will be created in
the pipeline hierarchy. At the same time, the actual shape will be denoted to become a tube/
3:21 12.0
Diagrams User Guide
Getting Started
duct shape, and a corresponding tube/duct element will be created in the DB as well. In
case a shape having a UDET type derived from a branch is dropped on the drawing, the
application must know which UDET type it should be denoted to.
When the Next button is clicked, the wizard will continue to the next step. At this time, there
is also a check that the shape has the correct number and direction of connection points.
Figure 3:5. Example of error message dialogue box shown when the number of connections on the
shape is not correct
In this step you should select the stencil to which the shape should be added. The dialogue
will show the currently open stencils, so the stencil must have been opened before starting
the Import Shape Wizard.
Note: When import shape is performed, the stencil is automatically saved, but to make this
save permanent, the user will have to perform a Save Work.
3:22 12.0
Diagrams User Guide
Getting Started
In this step the default annotation can be set up. The default annotation is represented by
the shape text as well as a number of default labels that can be automatically placed on the
drawing when the shape is dropped. The number of default annotations varies depending
on the type of item and can be controlled by changing the settings under General Options
> Annotation Settings in Diagrams Options.
3:23 12.0
Diagrams User Guide
Getting Started
Shape text options Use defaults If this is set to True, the Shape Text settings will
be fetched from the default set up in Diagrams
Options > Element Options for the relevant
type. If it is set to False, it will be possible to
override the default settings with a specific
setting for the shape to be imported in this
dialogue. Other Shape text options can only be
changed if Use defaults is set to False.
Shape text The shape text can be specified using attribute
references and dot notation (refer to Attribute
Presentation Notation in Chapter Appendices).
Text frame style The setting is available for 2D shapes except
annotating shapes (e.g. Labels). It allows
adding a frame around the shape's text.
Possible values are: None-no text frame,
Rectangle-rectangular frame will be added to
the shape text, RoundedRectangle-rectangular
frame with rounded corners will be wrapped
around text.
Rotate text with The setting is available for 2D shapes except
shape annotating shapes (e.g. Labels). Its value
determines the shape text orientation. When
set to False, the text will always be oriented
horizontally regardless of the shape's rotation.
When it is set to True - the text orientation will
be corresponding to the shape's rotation.
Shape text The colour of the shape text can be freely
colour selected from a Windows standard colour
palette.
Shape text font The shape text font can be freely selected from
a Windows standard font dialogue.
XRef XRef can be set to CENTRE, RIGHT or LEFT.
It represents the reference point in the shape to
which the X offset of shape text is related. The
setting is available for 2D shapes only.
YRef YRef can be set to CENTRE, TOP or
BOTTOM. It represents the reference point in
the shape to which the Y offset of shape text is
related. The setting is available for 2D shapes
only.
Offset X Horizontal offset for shape text placement in
relation to XRef. The setting is available for 2D
shapes only.
Offset Y Vertical offset for shape text placement in
relation to YRef. The setting is available for 2D
shapes only.
3:24 12.0
Diagrams User Guide
Getting Started
3:25 12.0
Diagrams User Guide
Getting Started
3:26 12.0
Diagrams User Guide
Getting Started
In this step the attribute presentation can be set up. If the Use default attribute
presentation settings checkbox is checked, all presentation settings will be taken from the
default that has been set up using the Attribute Presentation tab of the Diagrams Options
dialogue (refer to Diagrams Options).
In addition to the default presentation settings, it is in this step also possible to set up a
default value (the Value column) for each attribute. This can still be provided even if the
presentation settings are taken from the default.
For a description of the columns, please refer to the Attribute presentation tab of the
Diagrams Options dialogue.
Note: In the Diagrams Options dialogue, there is also an Allow individual shape
settings to override default settings checkbox related to the behaviour of this step.
If that checkbox is checked, the presentation settings specified in this step of the
Import Shape Wizard will be ignored. In case the user wants to override the default
settings for certain shapes, this checkbox will have to be unchecked when the
shapes are dropped on to the diagram drawing.
Note: The value of the Text attribute is controlled by Annotation Settings in step 3, and is
therefore disabled in step 4.
3:27 12.0
Diagrams User Guide
Getting Started
In this step, it is possible to specify a default catalogue search filter for the shape. If this is
done, the filter will be applied in subsequent catalogue search operations using the Manual
Catalogue Selection (refer to Manual Component Selection in Chapter Working with
Diagrams). This can for instance be used in a way that for a cable shape, 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 pre-defined filter so only relevant cable catalogue items will be
shown.
Default filters for each type of item can be specified in Diagrams Options by using the
Catalogue search settings > Default filters for non-pipeline elements settings. If these
should be used, the Use filter from Diagrams default settings should be checked.
Otherwise a specific filter for the particular shape can be specified in the Default catalogue
search filter textbox.
Note: If specification search for pipeline parts is not active, the following settings are also
available, Catalogue search settings > Default filters for pipeline elements.
When step 5 has been completed and the Finish command has been given, the shape(s)
will be added to the selected stencil. The user will also be prompted if he/she wants to make
a Save Work or not. The reason for this is that if the application subsequently will be closed
without any Save Work command being issued, the imported shapes will be lost. So if the
user clicks NO, then he/she will have to remember to perform a SaveWork at a later time.
3:28 12.0
Diagrams User Guide
Getting Started
3:29 12.0
Diagrams User Guide
Getting Started
Recommendations:
1. Only use the Refresh command when necessary, e.g when you suspect something
has been updated in the DB and you need to see it reflected in your drawing.
2. If only 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.
3. 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 Diagrams user. E.g. there exists a
lot of .Pmg... UDAs in the sample project. In many cases these attributes are not
being used and take up unnecessary time during the Refresh. When these kinds of
attributes are not being used the UDAs can simply be removed from the project. It is
also 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.
Recommendations
1. As mentioned above, it is possible to disable the SVG creation until it is really needed
(when the diagram has been released to 3D).
2. There is a setting to control whether to use binary Visio files or XML format Visio files.
XML format requires much more storage space, so make sure to use the binary format.
3:30 12.0
Diagrams User Guide
Getting Started
3. 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 SaveWork or not. With this setting you can
balance between more data management capability & more storage space required or
less data management capability & less storage space required as is described below:
With 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 here is, of course, that it may take a significant amount of storage
space to save the related files for all sessions.
With 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.
When Keep session files is set to True, and sessions are to be merged, then select
Tools>Utilities>Project Maintenance>Clean Old Session Files to get rid of 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.
3:31 12.0
Diagrams User Guide
Getting Started
3:32 12.0
Diagrams User Guide
Working with Diagrams
This chapter describes all the standard functions and procedures for using the application,
and is therefore of interest to all users of Diagrams.
4.1 Introduction
Symbols are added to drawings by dragging and dropping shapes from the stencil to the
drawing area. As soon as a shape that corresponds to a DB element is dropped, it will if
possible be defined (refer to section Define / Undefine), which means that a corresponding
database element will be created in the current database session. Some shapes will need a
context to be defined. For example, if a valve shape is dropped by itself, it will not be defined
until it is connected to a defined member of a pipeline branch, for instance a SCTUB shape.
When a shape is defined, the corresponding database element can also be seen appearing
in the DB explorer. When using the Consistency Check function (refer to section
Consistency Check), a warning will be issued for undefined shapes.
Default attributes defined in the shape in the stencil will automatically be assigned to the
element. There is also a function to prompt the user for attribute values when a shape is
dropped is also supported.
The attributes of a shape are available through the Custom Properties / Shape Data
window. As soon as an attribute is changed by the user, it will be updated into the database
session. The data will then be written to the database and be available to other users after
issuing a Save Work command.
Shapes can be connected to other shapes directly when dropped, or they can be connected
afterwards.
4:1 12.0
Diagrams User Guide
Working with Diagrams
Figure 4:1. Attributes for a shape can be viewed and updated through the Custom Properties /
Shape Data window. Updated attributes are automatically stored in the corresponding
DB element.
4:2 12.0
Diagrams User Guide
Working with Diagrams
Note: The Schematic Explorer shows the entire contents of the database and not only the
current drawing. Also, operations done through the explorer such as rename etc., will
only affect the database. To see such changes in an open drawing, the user will have
to use the Refresh command (refer to section Refresh).
4:3 12.0
Diagrams User Guide
Working with Diagrams
In this explorer you can see the secondary Systems hierarchy. Below each system, the
items are further sub-grouped by Folders. Folders do not exist in the database, they are only
a way to display items of the same type, together, and provide a better navigation and
overview.
Main schematic items such as Pipelines, HVAC lines, Equipment items and Cables are
members in the system hierarchy through their SCSYSF attribute, which contains an array
of system references. This means that a schematic item can be a member of more than one
system simultaneously, thereby appearing in several places in the System Explorer tree.
The first system in the array is considered the primary system, and others are considered
secondary. By default, all subordinate items are considered to be members of the same
system as the parent Pipeline / HVACline / Equipment item. It is however possible to
override this by setting a different system reference on a subordinate item, such as a special
valve or a sub-equipment item.
In this case that particular item would both appear below the parent item (Pipeline,
Equipment) in the system explorer, and also by itself under the system set for that item.
Diagrams are shown under all systems to which the items on the diagram belong. This
includes both primary and secondary systems.
Above the navigation tree is a Filter checkbox as well as a dropdown list where predefined
filters can be selected. If the Filter checkbox is checked, the selected filter will be applied to
the explorer tree. Currently there are tree filters available, one for each discipline (Piping,
HVAC, Electrical).
The System Explorer features a context sensitive right mouse button menu that provides
common commands.
Note: The System Explorer shows the entire contents of the database and not only the
current drawing. Some administrative elements such as the SYSCDA and SYSMDA
are however hidden in order not to clutter the view. These elements can be seen and
manipulated through the systems hierarchy administration function. Please refer to
Systems in Chapter Application Setup for further information.
4:4 12.0
Diagrams User Guide
Working with Diagrams
4:5 12.0
Diagrams User Guide
Working with Diagrams
Shape attributes are available through the Custom Properties / Shape Data window
(see below).
There are right-click menus available for shapes as well as for the drawing background
providing context sensitive short-cuts for common functions.
When an item is selected on the drawing, it will automatically be made the Current
Element (CE), which means that it will be selected in the explorer and other windows
that track the CE.
When an item is selected in the explorer, it will however not be selected in the drawing
automatically. In case the user wants to select it, there is a Select in Drawing
command on the right click menu in the explorer.
Navigation such as Scrolling, Panning, Zooming in the drawing window can be
achieved through standard Visio functions such as Ctrl+Shift+Click on left and right
mouse buttons. See table below.
A number of Function Keys are available for easy access and commonly used
commands. Please refer to section Keyboard Shortcuts and Function Keys for more
information.
Please refer to the MS Visio documentation for further information about the drawing
window.
4:6 12.0
Diagrams User Guide
Working with Diagrams
Note: The Custom Properties Window has been renamed to Shape Data Window in
Visio 2007.
If the Custom Properties / Shape Data window is not visible, it can be shown using the
View > Custom Properties / Shape Data Window command in the main menu. The
attributes presented for each kind of item can be changed using the Attribute Presentation
settings in Diagrams Options in Chapter Getting Started.
When the value of an attribute is changed through Shape Data, it will automatically be
changed in the related database item using the current Dabacon Session as well. To
permanently save the changes to the database, the Save Work command must be issued.
For further information about this, refer to section Save Work and Save As.
To enter multiple values for an array type attribute, the values can be entered separated by
a blank (using space bar).
In case more than one shape is selected in the drawing, Shape Data will show the attributes
for the first selected item. If the user will then update an attribute value, it will be applied to
all selected shapes.
4:7 12.0
Diagrams User Guide
Working with Diagrams
The Item List is synchronized with the drawing, so that any items added to or removed from
the current drawing page will immediately be reflected in the Item List.
Note: When drawings with many items are being worked on, the automatic synchronization
between the drawing and the Item List might lead to a noticeable delay in some
situations, depending on the computer performance rating. In case this happens, the
automatic updating can be turned off by setting the System configuration > Item
List > Automatic updating default setting in Diagrams Options to False. Then the
Item List can be refreshed manually by using the Refresh command on the right click
menu.
When items are selected in the drawing, they will also be selected in the Item List and vice
versa. This behaviour can be turned off by setting the Connect Item List with Drawing
default option to False.
In the Pipe inline components and HVAC inline components tabs, Tube and Duct elements
are by default not shown in the list. It is however possible to turn on the display of Tubes/
Ducts by changing the System configuration > Item List > Tube/Duct visible default
setting in Diagrams Options to True.
The Item List is using the AVEVA Grid Control which provides a number of filtering, sorting
and grouping functions. For more information about the AVEVA Grid Control, please refer to
Getting started with PDMS documentation. The presentation of attributes in the Item List is
configurable by the Attribute Presentation tab in the Tools > Diagrams Options dialogue.
Please refer to Attribute Presentation in Chapter Getting Started for further information.
Attribute data can be edited in the Item List as well as in the Custom Properties / Shape
Data Window (refer to section Custom Properties Window / Shape Data Window).
The Item List features a right click menu that contains the same item specific commands as
in the Schematic Explorer as well as some presentation options such as Show Filter Line,
Show Group Panel etc.
The Item List also includes an Export to spreadsheet feature. This is further described
under section Export.
4:8 12.0
Diagrams User Guide
Working with Diagrams
Note: The command line should be used with care, and it is important to fully understand
the consequences of the commands issued. Some commands might not work as
expected in the Diagrams context. A few examples of these are listed below:
If changing modules by issuing the PDMS or similar commands, the Diagrams exit
handling will be bypassed, so settings and data will not be properly saved.
By using the Savework command, the diagram document might not be saved if the
user subsequently clicks Cancel in the following dialogue.
Any DB element data that is changed through command line commands will not be
available in the diagram until the Refresh command has been used.
4:9 12.0
Diagrams User Guide
Working with Diagrams
The Message Log can be shown by issuing the View > Message Log command from the
main application menu, or by clicking on the Message Log in the Status Bar (refer to
section Status Bar for more information).
The Message Log shows messages that occur when the application is being used.
Messages can have different severity (Error, Warning or Information) as indicated by the
icon. In case a message is related to a particular shape in the drawing, this is indicated by
the shape name in the Shape column and the page number in the Page column. In this case
it is also possible to click on the message to select the related shape in the drawing. If the
shape is not available on the drawing any more (i.e. was deleted or drawing is closed), the
page number disappears after the first click on the line with this shape. When the shape is
not visible in the drawing window, the window will pan/zoom as necessary.
The Message Log can be cleared of all messages by right clicking and selecting Clear
Message Log.
The columns are as follows:
Column Explanation
Message 1. The icon indicates the severity of the message (Error, Warning or
Information)
2. Message text
Shape Name of the Visio shape that the message is related to.
Connection Connection number of the shape which the message is related to. This is
only shown in case the message is related with a certain connection
point on the shape.
DB Element Name of DB element that the shape is related to. This is only shown in
case the message is related to a shape that has a corresponding DB
element.
Page Page number in the drawing on which the related shape exists. This is
only shown in case the message is related to a shape.
Time The time that the message was generated.
Note: When the Message Log window is not open, any error or warning (but not
informational messages) that occurs will cause the status bar panel to flash in an
orange colour. The flashing will stop as soon as the user moves the mouse to the
status bar panel. Please note that in some cases several messages can be
generated by a single user operation. In the example below, it is not the SPRE
changed informational message that caused the flashing, but rather the previous
error message. Opening the Message Log will show that a previous error message
caused the flashing.
4:10 12.0
Diagrams User Guide
Working with Diagrams
Status bar panel flashes when the Message Log window is not open.
Opening the Message Log reveals the actual error message that caused the flashing.
There is also a functionality which allows exporting the Message log and Consistency check
results to a txt or xls file. This is available in the right click contex menu of the Message Log
and Consistency Check window.
The status bar contains the following panels from left to right:
Panel Description
Status message Shows status messages, for instance how many shapes are
selected at the moment.
Message Log Shows the latest message in the Message Log. By clicking on
this panel, the Message Log window will be shown (refer to the
section Message Log for more information).
4:11 12.0
Diagrams User Guide
Working with Diagrams
Panel Description
Current Line Shows the name of the current Pipeline/HVACline. The
application remembers the latest Pipeline/HVACline that was
selected by the user. In case the CE moves to another part of the
schematic hierarchy, for instance by selecting an equipment
item, the latest selected Pipeline/HVACline will still be
remembered and shown in this panel. If any new branches are
added, they will be created in the line shown in this panel. If you
click on this panel, the line shown will become CE.
Sessions Defaults When the mouse pointer is hovered over this panel the following
tooltip will be shown:
4:12 12.0
Diagrams User Guide
Working with Diagrams
4.2.11 Search
The Search command is available in the View menu. This function searches the database
for elements based on name, element type or other criteria and can be useful for finding
elements in case the user is not familiar with their location in the schematic hierarchy and
are therefore difficult to locate in the explorer. The Search Results shows a list of elements
found, and features a right-click menu with common commands.
4:13 12.0
Diagrams User Guide
Working with Diagrams
4:14 12.0
Diagrams User Guide
Working with Diagrams
When the Zoom To button is activated the application will zoom and/or pan so that the
entire selection is visible.
By using the dropdown for Defined/Undefined Shapes this function can be set up to
search for only Defined shapes, Undefined shapes or both.
On the History dropdown there is a list of previous searches that the user has made. By
selecting one of these, a previous search can be recalled and the Type, Attribute,
Operator and Value fields will be updated accordingly. The user will then have to click the
Find and Select or Find and Highlight button to perform the search.
4:15 12.0
Diagrams User Guide
Working with Diagrams
In the Database Tree tab only relevant parts of the database for the current context is
shown. In case the user is supposed to select a certain kind of element, only this kind of
element together with necessary hierarchy elements will be shown.
Using the Search tab, it is possible to make a text search in the database.
4:16 12.0
Diagrams User Guide
Working with Diagrams
In case the user has selected a hierarchy node in the Database Tree tab, the search will be
limited within that part of the hierarchy. The current search scope can be seen after the
Search in label above the text criteria field.
The text criteria should be keyed into the criteria field. This will be matched against a
concatenation of the Name and Description attributes as the search is being carried out. In
case no wildcard characters are used, only items with a whole word matching the criteria will
be found. In case more than one word is entered, this will be considered as a complete
string to be matched. This means that if you want to find a string that contains two or more
words which might be separated by other words, you will have to use asterisks in between
(see wildcards below).
The asterisk (*) character can be used as a wildcard denominator. Asterisks can be placed
before (e.g. *A3), after (e.g. A3*) or in between (e.g. system*spec). This can also be
combined (e.g. *A3*).
4:17 12.0
Diagrams User Guide
Working with Diagrams
4:18 12.0
Diagrams User Guide
Working with Diagrams
4:19 12.0
Diagrams User Guide
Working with Diagrams
Figure 4:4. Right-mouse button menus in the Auto Formatting Rules window
Rules and Rule Sets can also be re-ordered using the Drag&Drop functionality.
It is also possible to turn on/off rules or whole rule sets using check boxes in the left part of
the window. If the main node is turned off all the rule sets and rules are not active. Turning a
rule or rule set off means that it will be skipped when rules are executed either manually or
automatically on events.
4:20 12.0
Diagrams User Guide
Working with Diagrams
Figure 4:5. Defining selection criteria using the Type & attribute value option
If the Type & attribute value is selected it provides the possibility to select the type of
elements to which the rule should be applied and then to define the number of attribute
filters. It is also possible to select All types which means that the attribute filters will be
matched to all elements. To specify attribute filters select the Attribute from the drop down
in the Attribute column in the grid. It is possible to use regular attributes as well as
referenced attributes. It is also possible to key in the attribute name rather than select it from
the list. The attributes list contains system attributes and UDAs valid for the selected type
including referenced attributes defined in Attribute Presentation in Diagrams Options. It
does not contain pseudo attributes unless they are added in the Attribute Presentation. If
there is no type specified for the rule (All is selected in the Type drop down) the list consists
of merged attributes for all database types that can be represented on a diagram. After the
attribute is selected, the operator and value to compare should be specified as shown in the
screenshot above. A new row for the next attribute filter is added automatically after the
current row is edited. To delete an existing attribute filter row select the whole row and press
the Delete key on the keyboard.
When several attribute filters are defined it is possible to decide if all of them should meet
the rule for a specified shape or if it is enough that one of them is valid for a given shape.
This depends on the state of the Require all the following check box.
If the selection criteria type is set to PML expression then there will be a text box displayed
to key in the expression. It will be executed on all database elements represented on the
drawing and the element will be considered as satisfying the rule criteria if the expression
returnes True. Therefore the expression must be of boolean type, e.g. FUNC EQ PIPE. For
4:21 12.0
Diagrams User Guide
Working with Diagrams
more information about constructing PML expression see User Guide Software
Customisation / Customisation Guide / PML Expressions.
Figure 4:6. Defining selection criteria using the PML expression option
After the selection criteria are defined it is possible to check to which shapes the rule will be
applied on the current drawing using the Highlight link placed at the right bottom of the
dialogue. After this is clicked all shapes meeting the criteria will be highlighted on the current
drawing.
4:22 12.0
Diagrams User Guide
Working with Diagrams
The tab page contains a list of all format properties possible to assign using the rule. If the
associated value is not set (blank) it means that the property is not going to be set.
The following properties can be assigned:
line colour if the value for the property is set, then the line colour of the shapes
meeting the rule criteria will be set appropriately. This will override the Defined,
Released To 3D and Associated With 3D colours. The Value can be defined in the
dialogue presented after clicking the button in the field:
4:23 12.0
Diagrams User Guide
Working with Diagrams
line pattern can be defined by selecting the desired value from the drop down in the
corresponding field. The value can also be keyed in. It determines which line pattern
can be assigned to shapes matching the rule. If a selected pattern is defined, it should
be added to the drawing before applying the rule. Otherwise there will be no visible
effect (only the formula will be set appropriately).
line weight line weight can be selected from the list or be put into the corresponding
field as a text. If the value is keyed in without a unit string, then when the rule is being
applied, the default page unit will be used.
4:24 12.0
Diagrams User Guide
Working with Diagrams
line cap can be selected from a list or keyed in, in the same way as line pattern
line transparency should be selected from the list or keyed in into the appropriate
field. It should be a numeric value and it will be considered to be expressed in %
If <No layer> is selected from the list, then after the rule is executed, all shapes meeting its
criteria will belong to no layer. If the <Auto> option is chosen, then shapes will be put into
layers depending on their catalogue reference for each spec a corresponding layer will be
created and all shapes having reference to the spec will be added to the layer.
text font defines the font to be used in the text of shapes matching the rule. It can be
selected from the following list:
4:25 12.0
Diagrams User Guide
Working with Diagrams
text size can be selected from a list of typical font sizes or keyed in:
text transparency should be selected from the list or keyed in as a number and it will
be considered to be expressed in %
Sometimes there is a need to clear previous formatting before applying the new one. In
such a case, the Clear auto formatting check box placed on the format tab below the table
can be used:
If this check box is ticked then the previous formatting done by the rules will be cleaned for
all shapes fulfilling current rule criteria. Also, in such a case the formatting table will be
disabled for editing.
4:26 12.0
Diagrams User Guide
Working with Diagrams
Note: The option will be ignored and disabled for editing when Clear auto formatting is
checked in the Format to be assigned tab.
4:27 12.0
Diagrams User Guide
Working with Diagrams
overwrite guarded Visio formulas if the option is not checked then the format will not
be applied if corresponding cell in shape sheet is guarded, e.g. line colour will not be
applied to shape if its LineColor cell contains formula=GUARD(7).
Note: The option will be ignored and disabled for editing when Clear auto formatting is
checked in the Format to be assigned tab.
apply rule automatically on events (if enabled) if the option is not checked then rule
will not be executed automatically even if Auto apply rules is on, see also Executing
Rules below.
handling annotations if a shape matches the rule, then this setting provides the
possibility to decide if the format should be applied to the shape only, to the shape and
its annotations (attached labels) or only for the shapes annotations.
Executing Rules
Rules and rule sets are controlled by the Auto Formatting Rules toolbar which allows the
turn on/off of several options and to manually execute rule sets:
To manually execute the rule set on a current drawing, the appropriate value (name of the
rule set to be executed) should be selected from the drop down on the toolbar and after that
the Apply rules button should be clicked.
After that the active rules from the selected rule set are executed and the format they define
is applied to matching shapes. If All rule sets is selected, then all rules are executed.
Note: Rules are applied in sequence and if one of them is specifying the same property,
e.g. colour as the previous rule, then the previous value will be overwritten. It could
be used to define the sequence of rules going from a very general criteria to more
specified conditions, but it is important to keep the appropriate rules order.
If the Zoom to option is on, then the zoom of the current page is adjusted to show all
changed shapes.
After the rules are executed and the appropriate formats are applied, it is possible to restore
the original format from the shapes on the current drawing using the Reverse button: .
To turn on the automatic executing, select the Auto apply rules button: . When this
button is checked, the active rules with set Apply rule automatically on events option are
executed after different events. The events can be determined in Diagrams Options:
4:28 12.0
Diagrams User Guide
Working with Diagrams
Figure 4:17. Specifying events which should trigger executing formatting rules
4:29 12.0
Diagrams User Guide
Working with Diagrams
4:30 12.0
Diagrams User Guide
Working with Diagrams
4:31 12.0
Diagrams User Guide
Working with Diagrams
Other main application menus do not contain any standard MS Visio commands.
4:32 12.0
Diagrams User Guide
Working with Diagrams
4.6.1 Overview
All diagrams, stencils and templates are handled through proxy elements in the database,
even if the actual files are stored in the file system. Please refer to Database Architecture in
Chapter Diagrams Overview for an overview of how these documents are managed.
Note: It is possible to choose binary or XML format for saving Visio documents. For more
information please see Document file formats in Document Files, Sessions etc. in
Chapter Application Setup.
4:33 12.0
Diagrams User Guide
Working with Diagrams
4.6.2 New
New diagrams, templates and stencils can be created through the New Diagram and New
Stencil commands in the file menu.
If desired, a template for a new diagram can be chosen from the database. If no template
should be used, then click the No template button.
4:34 12.0
Diagrams User Guide
Working with Diagrams
To ensure integrity between data on the drawing and its database representation, when a
new diagram is created (from a template or not) it should be saved to the database. For that
reason the user is immediately prompted for a name and database location for the new
document via the standard Save Diagram As dialogue as seen below:
There is a possibility to create a new drawing without saving it to the database. This is done
by clicking the Cancel button as it states in the dialogue title bar. However, then the
document is considered read-only and any database related changes to its content are not
allowed.
Note: The same occurs when an external drawing is imported using File >Import
>Drawing. The imported drawing should be either saved to the database or be
opened in read-only mode.
4.6.3 Open
Existing diagrams, stencils and templates can be opened through the File menu.
4:35 12.0
Diagrams User Guide
Working with Diagrams
When the Open command is issued, the Open dialogue is shown. This dialogue shows a
list of the diagram, stencil and template index elements in the database, through which the
diagrams can be opened.
Diagrams, stencils and templates can also be opened by double clicking or using the right-
click menu of the Schematic Explorer.
4:36 12.0
Diagrams User Guide
Working with Diagrams
In case the diagram is connected to other diagrams through off-page connectors, the
Connected Diagrams command will be available. By selecting this command either of two
things will happen:
1. If the diagram is connected to one other diagram only, this diagram will open.
2. If the diagram is connected to several other diagrams, a list of diagrams will be shown
so the user can select which one(s) to open.
4:37 12.0
Diagrams User Guide
Working with Diagrams
Note: When the user tries to open a diagram that is already claimed a dialogue will be
shown where the user gets the opportunity to open in read only mode.
4:38 12.0
Diagrams User Guide
Working with Diagrams
4:39 12.0
Diagrams User Guide
Working with Diagrams
Figure 4:20. Context menus on SCPLIN or its members (also SCEQUI etc.)
4:40 12.0
Diagrams User Guide
Working with Diagrams
4:41 12.0
Diagrams User Guide
Working with Diagrams
4:42 12.0
Diagrams User Guide
Working with Diagrams
4:43 12.0
Diagrams User Guide
Working with Diagrams
4:44 12.0
Diagrams User Guide
Working with Diagrams
1. Saving the Visio drawing and modified stencils to the file system, also re-saving all
opened documents with a file format not corresponding to Save documents in the Visio
XML format setting.
2. Updating the SCDIAG and SCSTEN index elements in the database with Visio drawing
related data.
3. Performing the Dabacon SaveWork, thereby flushing all session data to the database.
The Save As command will provide the user with a possibility to save the drawing under a
different name and with the option to duplicate all the presented data. In order to keep
consistency between the database and drawings it is not possible to execute the Save As
command on a drawing containing unsaved database related changes. In such a case the
changes must first be saved and therefore the operation is cancelled with the following
warning message.
After the Save As command has been executed and the drawing does not contain any
database related changes, the name and location for a new drawing should be specified in
the Save As dialog.
4:45 12.0
Diagrams User Guide
Working with Diagrams
The location for a new diagram is assigned by selecting the schematic group element below
which the diagram should be created. It is also possible to create new schematic groups by
right-clicking on the Schematic World element or on an existing Schematic Group element in
the element tree to the left.
Depending on the Copy DB items option, shown in the picture above, the new diagram can
be saved in two different ways:
When the option is checked, all items that are defined in the database are duplicated
together with the drawing containing the changes. For more information refer to Save
As with Copy of Data.
When the option is unchecked, the drawing is duplicated but all the containing shapes
are undefined on the copy of the diagram.
When the drawing has been successfully saved with Saved As, with a copy of the database
data or not, the user is prompted to perform a Save Work.
Note: If the Diagrams application is closed without the execution of Save Work the newly
created copy of the drawing will not be saved between sessions.
Note: If more than one diagram is open, all open diagrams will be saved when Save Work
is performed.
4:46 12.0
Diagrams User Guide
Working with Diagrams
Overview
To reduce time for the Save Work function to complete it is possible to choose when to
create SVG files for the diagram. The basic concept of this functionality is described in the
flowchart below.
4:47 12.0
Diagrams User Guide
Working with Diagrams
You can change the Save Work behaviour via the Diagrams Options>Create SVG on
Save Work option:
4:48 12.0
Diagrams User Guide
Working with Diagrams
4:49 12.0
Diagrams User Guide
Working with Diagrams
On the next form there is no need to select any options, just click Update!.
All selected diagrams that had SVG files created for them will have SVG files generated
again for all pages in the diagram. If a diagram had no SVG files created it will not be
modified and no SVG files will be created.
Note: This option only updates pages that were previously exported. Dummy pages will not
be updated.
4:50 12.0
Diagrams User Guide
Working with Diagrams
Click the Release Diagram to 3D button or select it from the File menu and select the
pages for releasing items to 3D.
This is a simple way to release all items to 3D on selected pages of the diagram. It will affect
all elements on the selected pages.
If a page was previously released to 3D then it will be pre-selected and the date of the
recent release will be displayed.
If you are working with extracts, then the Flush extract checkbox will be active. By checking
it, all data that were released on sthe elected pages will be flushed to the master database.
Note: It is strongly recommended to set the Keep session files option to True. Otherwise,
each Save Work in the extract will replace and rename existing Visio and SVG files
and may make them inaccessible at the master location
4:51 12.0
Diagrams User Guide
Working with Diagrams
At this stage it is possible to cancel the Save As by clicking the Cancel button. The
operation is then aborted and no copy of the drawing is created.
The settings available on the Copy DB Items dialog, shown above, are described below:
Note: If a default group is not set for an element type, then elements of such type will not
be copied and appropriate shapes will be undefined on the destination drawing.
4:52 12.0
Diagrams User Guide
Working with Diagrams
Copy Options
Refresh
4:53 12.0
Diagrams User Guide
Working with Diagrams
4.6.10 Delete
Diagrams can be deleted using the Delete command on the right click menu on the
SCDIAG element in the schematic explorer. When a diagram is deleted, any related items
on that diagram will not be deleted from the database. However, all references to that
diagram will be cleared. This means that if the diagram for instance contains an equipment
shape, the DIAREFARRAY on the equipment item will be updated, but the equipment item
as such will not be deleted.
Any orphan items left over when diagrams are deleted can be found by searching for items
where DIAREFARRAY is empty.
Note: When a single page within a diagram is deleted, the user will be presented with a
question regarding deleting all items from the database or not.
4:54 12.0
Diagrams User Guide
Working with Diagrams
Note: When Undefine is performed, the attributes will be cleared using the same rules as
when a shape is copied, refer to the Copy with shape setting in Step 4: Attribute
Presentation in Chapter Getting Started.
During normal drafting of diagrams by dragging and dropping shapes from a stencil and
connecting together in the drawing, the Define operation will be handled automatically by
the application. The manual define/undefined only has to be used in special situations. For
example, if a number of inline fitting shapes (a branch or part of a branch) are copied and
pasted, they will not automatically be defined, so the user will have to first select a current
Pipe-/HVAC-line and then issue the Define command.
It is possible to disable the automatic Define mechanism by setting the Define shape on
drop to False.
As a visual feedback to the user, it is possible to set up a default colour that is automatically
assigned to shapes when they are defined. This is done by the Colour setting for each kind
of item under Element Options in Diagrams Options in Chapter Getting Started. Using the
default application settings from the installation, this means that Equipment and Pipework
shapes will turn blue as they are defined, HVAC ducting and fittings will turn green etc. In
case the colour does not change on drop/connect, the user will see that the shape could not
be defined.
4.8 Refresh
The relation between Visio shapes and their corresponding database elements means that
attribute data is actually stored in two places during program execution. The architecture is
designed in such a way that the database element is considered the master.
Under some circumstances the attribute data might become out-of-sync, so that the
database element becomes updated while the shape is not. This can for instance occur
when attribute data has been updated from the command line, or when a shape text refers
to other database elements and these element have been updated.
In this case the Refresh command can be used. The Refresh command updates the shape
attributes from the corresponding database element data. Refresh can be performed on a
single shape, on a group of shapes or on all shapes in the drawing.The Refresh command
can be called from the main application Object menu, from the Object toolbar or from the
Shape and Drawing right-click menus, but it is also executed automatically after some of
operations, e.g. after Refit/Resize, Rename Elements or other commands available from
the menu.
4:55 12.0
Diagrams User Guide
Working with Diagrams
The settings controlling feedback given by highlighting a shape and/or its annotation are as
follows:
Reset highlight before refresh indicates whether the Reset Highlight command
should be executed before the Refresh command is executed.
Highlight shape with changed attributes - if this option is set to true, then a shape that
has attributes updated by the Refresh command will be highlighted.
Highlight changed annotation - if this option is set to true, then after the Refresh
command is executed and the shape's text has been changed, the text will be
highlighted. If the text on the Labels/Multi-labels, attached to the shape being
refreshed, was changed, the annotation will be highlighted as well.
Figure 4:32. Changed shape and its annotation (text and attached label) being highlighted after
Refresh
Apart from highlighting the modified shape or annotation the changes are also indicated by
messages in the message log. There is possibility to adjust the level of information
4:56 12.0
Diagrams User Guide
Working with Diagrams
according to individual user needs using the Message level setting. It can be set to the
following values:
Summary message for refresh operation - only one summary message with
information of the number of changed shapes will be given:
Message per shape a summary message and also one message for each changed
shape with information about the number of changed attributes will be displayed:
Message per attribute there will be a summary message and also one message for
each updated attribute (except attributes listed in Ignore changed attributes setting):
Another option controlling the feedback on Refresh is Zoom out to show all changes.
When this option is set to True it gives a possibility to zoom out to see all changes, then after
the refresh, zoom is adjusted to show all changed shapes on the current page.
To avoid indications on any insignificant changes, it is possible to set attributes which should
be skipped by feedback on Refresh. They can be listed as value Ignore changed
attributes. The attributes to be ignored should be separated by commas or spaces like on
the examples below:
4:57 12.0
Diagrams User Guide
Working with Diagrams
Referenced attributes cannot be listed in the setting, but they are ignored if any of their parts
are skipped, e.g. OWNER_NAME will be ignored if the Ignore changed attributes list
contains an OWNER or NAME attribute. A change made to ignored attributes during refresh
will be skipped in the message log information (there will be no message if the level is set to
Per attribute and also the change will not be counted in Per shape and summary
information). If all changed attributes for the refreshed shape are listed in the Ignore
changed attributes list, the shape will not be highlighted even if Highlight shape with
changed attributes is on. However, if the ignored attribute causes any modification of the
shape's text or label text, the text and the label will still be highlighted if Highlight changed
annotation is set to True.
By default the feedback is given only if the Refresh operation is executed from the menu or
if it is called after a drawing is opened and the Refresh drawing on opening is set to True.
However, it is possible to set the 'Give feedback on automatic refresh' to On to get feedback
on the automatically called Refresh operations, e.g. after Refit and Resize.
In case any inconsistencies are found, these will be listed in the Consistency Check
Result window. Inconsistencies are classified as Errors, Warnings and Informational
messages as indicated by the status icon.
The columns are as follows:
Column Explanation
Shape 1. The icon indicates the severity of the problem (Error, Warning or
Information).
2. Name of the Visio shape that the problem is related to.
Connection Connection number of the shape which the problem is related to. This
is only shown in case the problem is related to a certain connection
point on the shape.
4:58 12.0
Diagrams User Guide
Working with Diagrams
DB Element Name of DB element that the shape is related to. This is only shown
in case the problem is related to a shape that has a corresponding DB
element.
Page Page number in the drawing on which the related shape exists. This
is only shown in case the message is related to a shape.
Problem Problem text. See below for the list of problems that can be detected
by the Consistency Check function.
Corrective action In case any corrective action has been taken, this will be indicated in
this column.
By clicking on each line in the dialogue, the corresponding shape will be highlighted in the
drawing. In case the shape is not visible in the current view, the system will pan and if
necessary zoom out to make the entire shape visible.
The system will also attempt to bring back the drawing to a consistent state against the
database in case any inconsistencies have been detected. This normally means that
shapes will be disconnected or undefined in the drawing. No automatic updates will be done
to the database.
Below is a table showing the different checks that are performed during the Consistency
Check operation.
4:59 12.0
Diagrams User Guide
Working with Diagrams
4:60 12.0
Diagrams User Guide
Working with Diagrams
There is also a functionality which allows exporting the Message Log and Consistency
Check results to a txt or xls file. This is available in the right click contex menu of the
Message Log and Consistency Check window.
The Consistency Check command can be issued through the following UI commands:
Object pull-down menu
Shape right-click menu (also works on a selection of shapes)
Drawing background right-click menu
A summary of the consistency check result can also be seen in the Message Log. In case
no inconsistencies are detected, the Consistency Check Result pane will not appear.
4:61 12.0
Diagrams User Guide
Working with Diagrams
In the Save As dialogue there is a possibility to choose the export file format to be used,
either text file format or Excel file format.
4:62 12.0
Diagrams User Guide
Working with Diagrams
4.10 Annotation
4.10.1 Overview
Diagrams supports the standard Visio Shape Text field as well as predefined label shapes.
The users can create their own label shapes, including multi-field labels. When such a label
is dropped on the drawing and connected to a DB element shape, it can display arbitrary
attributes.
4:63 12.0
Diagrams User Guide
Working with Diagrams
4:64 12.0
Diagrams User Guide
Working with Diagrams
will be invisible by default. This function can be enabled by setting the Show Text on first
segment only default setting in Diagrams Options to True. However, depending on the
sequence of operations when the branches and segments are built, some extra texts might
be left in the middle of a segment. These can then be manually hidden by using the right
click command.
This option is available for 2D shapes except for annotating shapes (Label, Multi-label, Title
Block). The option allows the user to determine whether the shape text should be wrapped
with a frame and if so, it is also possible to choose between different frame styles. The text
frame styles are:
Name Description
None No text frame
Rectangle Rectangular frame around text
RoundedRectangle Rectangular frame with rounded corners
The image below illustrates the result of selecting the particular values:
4:65 12.0
Diagrams User Guide
Working with Diagrams
Note: The colour of the text frame is always the same as the colour of the shape text.
4.10.3 Labels
Shapes for custom labels and multilabels can be created using the Import Shape Wizard.
The annotation strings can be formatted according to the Attribute Presentation Notation
(please refer to Attribute Presentation Notation in Chapter Appendices) in order to present
attribute values from the related shape.
Default labels can also be set up for shapes, so that for instance an equipment shape will
get a number of pre-defined labels when it is dropped on the drawing. This can be done in
the type specific settings in Diagrams Options and can also be overridden in step 3
(Annotation settings) of the Import Shape Wizard in case individual settings are required.
A number of annotation settings are available in Diagrams Options that controls the label
shape to be used for annotation as well as the number of annotation labels that should be
available for each type of item in Import Shape Wizard. These settings can be found under
General Options > Annotation Settings.
Line breaks are supported in the same way for labels as for the Shape Text.
4:66 12.0
Diagrams User Guide
Working with Diagrams
Figure 4:33. Sample method of preparing a shape for the Title Block
Similar to other annotation shapes, texts for particular fields can be formatted according to
the Attribute Presentation Notation (please refer to Attribute Presentation Notation in
Chapter Appendices) and line breaks are supported in the same way as for Shape Text.
During importing Title Block, font and colour of text can be defined separately for each field:
4:67 12.0
Diagrams User Guide
Working with Diagrams
Figure 4:34. Configuration of texts for separate fields of Title Block in the Import Shape Wizard
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 custom properties of a single text field:
4:68 12.0
Diagrams User Guide
Working with Diagrams
below, there are different Pspec (A300 vs. A150) and Ptspec (PS007 vs. PS008) between
the tee and the following tubing.
The attributes that will be shown can be configured using the General Options
>Annotation settings > Property Break settings in Diagrams Options. This setting is
represented by a comma separated list of attributes. Only the attribute values that differ will
be shown.
4:69 12.0
Diagrams User Guide
Working with Diagrams
An outgoing OPC can be connected to an incoming (or vice versa) using the Connect OPC
command in the shape right-click menu.
This command will bring up a Selection dialogue (Standard DB Browse Dialogue) where all
unconnected OPCs of the opposite kind will be listed.
4:70 12.0
Diagrams User Guide
Working with Diagrams
When examining the database explorer, it can be seen that a new SCSEG element has
been created. The purpose of these administrative elements is to serve as containers for the
parts of a branch that is divided by OPCs.
The shape text shown in the OPC can be controlled by the Attribute Presentation Notation.
Refer to Attribute Presentation Notation in Chapter Appendices for further information. It is
for example possible to show the name of the drawing and the page of the OPC that the
current one is connected to by using the following format:
[opcref.owner.diaref(1)] - Page: [opcref.owner.page(1)].
It is possible to navigate between connected OPCs by using the Go to Connected OPC
command available on the right click menu.
The OPC connections can also be listed and navigated on a diagram level. By right clicking
on a Diagram Element in the database explorer and choosing the Connected Diagrams
command, all diagrams connected to the current one will be listed.
4:71 12.0
Diagrams User Guide
Working with Diagrams
4:72 12.0
Diagrams User Guide
Working with Diagrams
The default set of attributes can be then overridden during Import Shape:
4:73 12.0
Diagrams User Guide
Working with Diagrams
Any item dragged inside the limits of Area Shape will automatically receive default values
defined in the Area. Any attributes not applicable for a particular type will be skipped. After
the item is dragged out from the Area its attributes controlled by the Area are cleared (set to
default values). In both cases applicable messages are added to the message log.
The behaviour of the application when the user tries to change an attribute controlled by the
Area for an item located in the scope of the Area is determined by the Allow to modify
attributes of contained shapes default setting:
4:74 12.0
Diagrams User Guide
Working with Diagrams
4.13.1 Overview
By using the Catalogue Search function, it is possible to search through the catalogue and
to assign catalogue references to the selected item(s). This is achieved by the following
steps:
1. First select the item(s) in the drawing that should receive the new catalogue reference.
2. Second, make a selection in the Catalogue Search window. The Select command is
available on the right click menus of the explorer and the result list as well as on a
dedicated button in the bottom right of the window.
Manual component selection behaves differently depending on the current setting of the
Use specification default variable as shown below:
4:75 12.0
Diagrams User Guide
Working with Diagrams
The Catalogue Search window is divided in two main parts. To the left is a pane that
contains two tabs, Catalogue Explorer and Selection Tables, to the right there is a search
result list.
The Catalogue Search window will automatically navigate to the currently used catalogue
item. This means that when a shape which has a SPREF pointing to a GPART or a
TABITEM is selected in the drawing, the catalogue search will switch to the relevant tab and
navigate to the currently selected catalogue item in the Catalogue Explorer, as well as in the
result list. However, on slow computers this can cause a slight delay when shapes are
selected. If this is the case, this behaviour can be turned off by setting the General options
> Catalogue search settings > Configuration > Auto navigate to catalogue element
setting in Diagrams Options to False.
4:76 12.0
Diagrams User Guide
Working with Diagrams
In case default filters for shapes have been specified in Diagrams Options or in the Default
Catalogue Search Filter (refer to Step 5: Default Catalogue Search Filter in Chapter
Getting Started), the "== Use default filter from item ==" option will have to be selected for
these to take effect. When a shape associated with a default filter is selected, and the "==
Use default filter from item ==" is applied, as soon as the Find button is clicked, the
associated filter will automatically be applied.
4:77 12.0
Diagrams User Guide
Working with Diagrams
To define a new filter, click the New filter button and specify a name.
Below the Select Filter section, there is a Category line. If the Category checkbox is
checked, the filter will include a category selection criteria. This means that when the filter is
used, it will only search within the predefined category. As a default, the currently selected
category in the GPART hierarchy explorer pane will be shown in the category textbox. In
case the user wants to select another category, the Browse button () to the right can be
used. If the Category checkbox is not checked, the filter will be defined as a generic filter,
which can be applied to any category when used.
When filters are used, it works as follows:
If a filter including a category definition is used, the system will first navigate
automatically to the defined category in the explorer and then apply the rest of the filter
and make the search.
If a filter which does not include a category is used, the system will apply the filter to the
category that is currently selected by the user in the explorer.
4:78 12.0
Diagrams User Guide
Working with Diagrams
Below the category line, a table of criteria statements can be defined for the filter. To add a
new statement, simply click on the Attribute field to display a dropdown list of attributes.
This list contains all attributes that have been defined using the Customize function and
may include attributes from referenced elements.
Next click the Operator field and select an operator. Note that some operators are only
applicable to certain data types, for instance the Like operator can only be applied to text
string attributes.
Finally enter a criteria value in the Value field. When using the Like operator, wildcards can
be specified using the asterisk (*) character.
To add another criteria statement, simply click on the next empty line which was
automatically added when the first criteria statement was defined.
In case more than one statement is used for a filter, there will be an implicit AND operator
applied between statements.
Finally click OK to create the filter and close the dialogue.
4:79 12.0
Diagrams User Guide
Working with Diagrams
4:80 12.0
Diagrams User Guide
Working with Diagrams
By making a selection in the Table and Type dropdown boxes and clicking the Find button,
the table on the right hand side will be filled with a relevant selection of catalogue items
represented by TABITE database elements.
If the Auto select table and type from item checkbox is checked, the table and type
dropdowns will automatically be set according to applicable default settings under General
Options > Catalogue Search Settings in Diagrams Options or specified in step 5 of Import
Shape Wizard.
A selection table item can contain default values that will be applied to the shape when the
catalogue reference is set, provided that the Apply default values to item checkbox is
checked. This can be followed up in the Message Log where messages regarding assigned
default attributes is provided.
4:81 12.0
Diagrams User Guide
Working with Diagrams
To select a Catalogue Reference from the result list, you can either select the line in the list
and click the Select button, or use the Select command in the right click menu on the item
in the list.
The columns shown in the result list can be changed by clicking the Customise link. This
will show the Catalogue Search Result Presentation Settings dialogue.
Note: The result list for GPARTs will automatically be filtered on the LSELEC attribute. This
has to be true in order for the GPARTs to be shown in the result list.
4:82 12.0
Diagrams User Guide
Working with Diagrams
In this dialogue, the presentation label can be changed and it can be set up whether the
attribute should be visible or not. By clicking the Referenced Attributes button, attributes
from related elements can be shown. This dialogue works just like the same dialogue used
for Attribute Presentation (refer to Step 4: Attribute Presentation in Chapter Getting Started).
The result list can be presented in three different layouts, in order to provide as much space
for data as possible. By right clicking in the list and selecting Horizontal Layout, Vertical
Layout or Result list only the layout can be changed so that either as many rows and/or
columns as possible can be shown.
In the right click menu, commands are also available for showing or hiding the Grouping
pane, Filters row and Summary line. For more information on how to use the grouping and
filtering functions, please refer to the Getting Started with PDMS documentation.
4:83 12.0
Diagrams User Guide
Working with Diagrams
Note: That this only applies when defined shapes are copied.
Please also see the section on Primary / Secondary Shapes below, as this has relevance to
the behaviour of the Copy/Paste operation.
There is also a possibility to copy and paste several attributes at the same time between
existing shapes. This can be done by using the Copy Attributes and Paste Attributes
commands in the Edit menu. These will copy and paste all attributes that have been defined
as copy with shape in Attribute Presentation. These can be used in the following way:
1. Select a single shape from which the attributes should be copied.
2. Use the Copy Attributes command.
3. Select one or more shapes of the same type as the one that you just copied from.
4. Use the Paste Attributes command.
The result of the paste operation can be followed up in the message log, which will show a
list of the attributes that have been pasted for each shape.
Note: It is the Copy with shape setting for the destination shape which will determine
which attributes will be pasted. The Copy with shape setting for the source shape is
not considered.
Note: The Copy/Paste Attributes function only apply for DB defined attributes.
4.15.1 Overview
Diagrams supports a Primary/Secondary shapes concept. This allows a single item in the
database to be represented by several shapes in diagrams. The shapes can exist in the
same page, on another page in the same diagram or on different diagrams. A good example
of this are equipment items to which several systems are connected, such as the main
4:84 12.0
Diagrams User Guide
Working with Diagrams
engine. Even if the main engine will be represented on all the related systems' diagrams, it
can still be a single item in the database.
In some cases the main responsibility for an equipment item lies with a certain design team
or system design group while it needs to be accessible to other teams for connecting other
systems to it. To support this way of working, shapes can be considered Primary or
Secondary, and different rules and restrictions can be applied to these categories.
The system allows 0-n primary shapes and 0-n secondary shapes for a certain element in
the database. This means that the shapes corresponding to a certain DB element, might be
all primary, all secondary or a mix of primary and secondary.
For instance, if an equipment shape is deleted while keeping the corresponding DB item,
and later a new shape is created referring to the same DB item, the new shape will be
secondary even if no primary shape exists. This kind of situation is not handled
automatically by the system. It is however possible for the user to manually change the
IsPrimary flag.
The Primary/Secondary shape concept can be applied to the following kinds of items:
Equipment
Subequipment
Electrical connection elements
Cables
Multi-cables
Secondary shapes can be created in two main ways:
By changing the name into an already existing name.
By copying and pasting shapes in the drawing.
Note: The usage of Primary/Secondary shapes for certain combinations of main items
having subitems and/or connected cables or pipes involves a complex behaviour and
can give results that were not expected by the user. When using the Primary/
Secondary shapes for such combinations, it is important that the user understands
all implications of his/her actions.
4:85 12.0
Diagrams User Guide
Working with Diagrams
In case the user will click OK, the shape will refer the existing item in the database having
the name entered by the user and it will be made into a secondary shape.
The user will then also be asked if the original item created when the shape was dropped
should be deleted from the database, depending on the setting for Primary Shape Delete.
In case the original database item had some subordinate Electrical Connection Elements, a
dialogue will be shown to the user asking if these should be copied to the existing item
having the new name entered by the user. Nozzles are moved rather than copied as they
can not have a secondary representation.
In case the user clicks OK, the subordinate elements will be copied before the original item
is deleted from the database.
If the item has pipe branches connected to it, these will be disconnected before the shape
will be referred to the other DB item. This is necessary in order to avoid inconsistencies
between the drawing and database.
The system also enforces some restrictions on secondary shape handling for hierarchically
subordinate items such as subequipment and electrical connection elements. It is for
instance not allowed to have secondary electrical connection elements referring to a DB
item owned by a different equipment item than the one that the electrical connection
element is connected to on the current drawing. This is described in more detail under
Behaviour of Primary/Secondary Shapes.
4:86 12.0
Diagrams User Guide
Working with Diagrams
4:87 12.0
Diagrams User Guide
Working with Diagrams
There is also certain behaviour related to subitems and connected items. This behaviour is
described in the table below. In case of secondary shape creation through name change,
the DB item that the shape was referring to before it was assigned to another one is referred
to as the Source item. The DB item that the shape will be linked to after the creation is
referred to as the Destination item.
4:88 12.0
Diagrams User Guide
Working with Diagrams
4:89 12.0
Diagrams User Guide
Working with Diagrams
4:90 12.0
Diagrams User Guide
Working with Diagrams
Example 1:
The diagram below has got two equipments with sub-equipments. When they are copied
and pasted, the sub equipments will be copied together with the equipment. New database
items will be created for them.
Example 2:
Now the diagram has one equipment with a secondary shape and two sub-equipments.
4:91 12.0
Diagrams User Guide
Working with Diagrams
When this group of shapes is marked and copied and pasted, the system will ask if new
database items should be created for each shape, or if they should become secondary
shapes. This question is asked for each shape.
If new database items are chosen, the system will create two new equipments, making the
secondary shape become an individual equipment item.
4:92 12.0
Diagrams User Guide
Working with Diagrams
When creating the database items for the sub equipment, the ownership of the sub
equipment is determined by proximity. In this example, sub equipment Equipment-002-Sub-
001 is owned by Equipment-002 because it is positioned closest to that equipment shape.
For the same reason Equipment-003-Sub-001 is owned by Equipment-003 because it is
closer to that equipment than to Equipment-002.
If both sub equipments are closer to one of the equipment shapes than the other, they will
both be owned by this equipment:
4:93 12.0
Diagrams User Guide
Working with Diagrams
4.17.1 Overview
Diagrams supports a 3D Position (POS) attribute for relevant schematic database elements.
This position is independent of the 3D position of any related 3D elements. This can be
handled in different ways using the Schematic 3D Integrator. It is for instance possible to
copy the initial 3D position given for the schematic element to the corresponding 3D element
during the build process. Please refer to the Schematic 3D Integrator User Guide for more
details.
4:94 12.0
Diagrams User Guide
Working with Diagrams
4.18.1 Overview
Diagrams supports exchanging a placed and connected symbol with another symbol. All
attributes and connections will be retained. This can be done either manually by the user or
automatically by fetching a shape reference from the catalogue.
The reason that this function is called Replace Symbol rather than Replace Shape which
would be the standard MS Visio terminology, is that it will only replace the visual appearance
of the shape, and will not apply to all attributes, default values etc.
In the treeview to the left, all open stencils are shown. In the right hand pane all shapes for
the selected stencil can be seen. Select one of these and click the Replace button to make
4:95 12.0
Diagrams User Guide
Working with Diagrams
the change. In case the dialogue should remain open, use the Apply button instead. The
Reset button will restore the original symbol(s).
If the selected shape is not of the same type or has too few connections, an error message
will be shown and the symbol will not be replaced.
The way that the automatic symbol replacement works is controlled by some default
settings in Diagrams Options (Defaults in Chapter Getting Started):
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,
4:96 12.0
Diagrams User Guide
Working with Diagrams
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.
One item can be a member of multiple systems. To add a reference to a System, click the
button, which will bring up a dialogue where the system hierarchy can be browsed and
a system selected.
To remove a system reference, select it in the list and click the button.
In the list you can also see the system reference of the parent Pipeline / HVACline for
applicable items as a greyed out system name at the top of the list. This is not shown for
4:97 12.0
Diagrams User Guide
Working with Diagrams
4.20 Naming
4.20.1 Overview
Diagrams includes a possibility for automatic naming and re-naming of database elements.
This is primarily accomplished through the standard PDMS Autonaming function. In
addition to this, there are also functions to rename elements based on their position in the
diagram layout.
4.20.2 Autonaming
Naming Rules
To set up naming rules to be automatically applied when DB elements are created, use the
Tools > Other Options > Naming function. Please refer to the Data Management and Data
Base / Administrator User Guide for more information about this. The autonaming only
works when no name has been given at the time the element is created. If for instance the
Prompt on drop (Prompting the User to Enter a Name) facility is used to prompt the user for
a name, the autonaming will not be activated (unless the user does not enter any name).
Autoname CE
The naming can also be manually triggered by using the Autoname CE function available
under Object > Naming > Autoname CE menu item, or from the Naming toolbar.
Note: That this only works in case the element is not already named.
Auto Rename CE
This function will autoname the current element according to the current Naming Option,
after first removing the current name. The function is available under Object > Naming >
Auto Rename CE in the main menu or on the Naming toolbar.
4:98 12.0
Diagrams User Guide
Working with Diagrams
Name Option
Choose whether the names should be regenerated, re-ordered ascending or re-ordered
descending.
Regenerating the names will first remove the names of the selected elements and then the
autoname function will be applied to the selected elements. Re-order names will keep the
names of the selected elements and re-order them alphanumerically.
Point of Comparison
Choose which point of the shape that should be used for deciding the order. Typically this
setting is used in conjunction with function Sort Options Horizontally and Vertically.
4:99 12.0
Diagrams User Guide
Working with Diagrams
Sort Option:
4.21 Highlighting
The application includes a number of ways to highlight shapes in the drawing. Some
examples of these are the right-click menu in the Schematic and System Explorers, the
Find in Drawing toolbar, during automatic dimensioning/spec search etc.
In the case that the application will not automatically reset the highlight, it can be reset by
using the Reset Highlight function. This is available in the main application Object menu
as well as in the Object toolbar. In addition to this, the F7 key on the keyboard can be used.
The highlight colour and linewidth can be configured by changing some default settings in
Diagrams Options (refer to section Defaults):
4:100 12.0
Diagrams User Guide
Working with Diagrams
Auto line width Line width The line width in approx points to be
applied when Enable auto line width is
True.
Apply auto line width True / False Automatically adjust the line width when
on zoom operation the zoom level is changed. This can be
set to False if the performance of the
zoom operation degrades on large
drawings.
Keep highlight after True / False If True, changed component will be kept
dimensioning highlighted after resize / refit operations.
operation.
The Diagrams Import and Export functions are basically the same as the standard MS
Visio Open and Save As functions, and also supports importing/exporting other formats,
such as DXF etc. Please refer to the MS Visio documentation for further information on how
these functions operate. For Export and Save As there might for instance be some
differences in what kinds of information can be exported to different formats, as well as if the
function will export the whole diagram or only the current page.
Please note that the Import Drawing function only opens a Visio drawing stored in the file
system and does not import related data to the database.
4.23.1 Import
The Tools > Utilities > Spreadsheet Import command provides a possibility to import data
to the schematic database from .CSV and .XLS format files. Please refer to the Data
Management and Data Base / Database Management Reference Manual for a description
of how to use it.
4.23.2 Export
Ref till ny funktionalitet Chris
4:101 12.0
Diagrams User Guide
Working with Diagrams
The Item List includes a facility for exporting data to a spreadsheet file. By right clicking on
the table and selecting Export to SpreadSheet the contents of the currently selected tab
will be exported to an .XLS file. The file can be saved in a location selected by the user
through a standard File > Save As dialogue.
Note: DB data can also be exported in the same way from the Search Result grid. When
doing that, the scope of data will not be limited to the current diagram.
Note: The Undo/Redo command supplied via Visio is not connected to the Undo/Redo
functionality presented by the database. If any database actions have been carried
out as a result of the previous Visio command, then the Undo buffer will be emptied
to assure consistency between the diagrams and database.
Also, pure Diagrams functions such as Refresh, Resize, Refit etc. are not possible to
Undo/Redo.
4:102 12.0
Diagrams User Guide
Working with Diagrams
For changing the current units settings, please refer to documentation for Administration of
AVEVA Marine Environment.
Examples:
Figure 4:37. Tee annotation using PPBO(1) annotation to provide units aware values
4:103 12.0
Diagrams User Guide
Working with Diagrams
4:104 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
The chapter covers the special functions and procedures for the Piping discipline and is of
special interest to users creating Piping and Instrumentation diagrams.
5.1 Overview
The Diagrams application supports the creation of piping diagrams. This includes features
such as automatic management of the logical pipe model, dimensioning and automatic
specification search for components.
To create P&IDs, the P&ID mode should be used. This can be selected in the Tools > Mode
menu.
5:1 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
When the Create Pipeline dialogue is opened, a number of attributes will have values pre-
set as follows. These are just default values and can be changed by the user.
Group will be set from the default group settings available in the Status Bar.
Primary System will be set from current system setting available in the Status Bar.
Pipe Specification will be set from the default value of the Primary system.
Insulation Specification will be set from the default value of the Primary system.
Tracing Specification will be set from the default value of the Primary system.
Fluid will be set from the default value of the Primary system.
The Type dropdown box will allow the user to create pipelines using derived UDET types.
The pipeline name can be automatically constructed by using the Autonaming function. In
order to provide feedback on the autonaming while the dialogue is open, a pipeline element
is actually created as the dialogue is opened. In case the user clicks Cancel, this pipeline
element will be removed again.
The pipeline will be created in the selected group (SCGROU) in the main hierarchy of the
schematic database.
It is also possible to move pipelines between schematic groups either by changing the
Group in the Pipeline Properties dialogue, or by using the Cut and Paste commands in
the Schematic Explorer.
5:2 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
Note: That it is also possible to create pipelines by dropping a Pipeline shape onto the
drawing. This works more or less like a Branch shape with the difference that it also
creates a new pipeline (the Create Pipeline dialogue is automatically shown when
the pipeline shape is dropped onto the drawing). Pipeline shapes can be created by
using the Import Shape Wizard. See chapter Getting Started for further information.
The purpose of the Segment Element is to provide a way to divide branches between
several pages or drawings using Off-page Connectors (please refer to Off-page Connectors
in Chapter Working with Diagrams). All in-line fittings in a branch belonging to a certain
drawing page will be grouped under the same segment in the hierarchy.
The tube element will be related with the tube shape in the drawing which was created when
the branch shape was dropped. In case UDETs are used, there is a possibility in the Import
Shape Wizard (refer to Import Shape Wizard in Chapter Getting Started) to set up which
UDET type of tube should be created when the shape is dropped (Denote to).
It is possible to move branches between pipelines by using the Cut and Paste commands in
the Schematic Explorer. However, please note that this will not re-apply any default values,
like pipe spec etc., from the receiving pipeline to the branch or its members.
In Diagrams Options > Element Options > Fitting Options > Default Options, the setting
Auto create branch on connect Tee will automatically add a new branch shape when a
Tee is dropped into a line.
5:3 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
Also, in Diagrams Options > Element Options > Fitting Options > Default Options, the
setting Auto create Tee on connect branch will automatically add a new Tee shape when
branches are connected.
5.5.1 Overview
Valves, fittings and inline instruments can be members of a branch and are all considered
inline parts. These can be created by dragging and dropping shapes from the stencil onto
the drawing area. Inline parts can be added to a branch in different ways.
Note: If the values of Arrive and Leave are changed, this will affect the applications
perception of what is the main flow, and therefore cause inconsistencies if not
properly applied.
Note: If the connector has more than one angle and the connector style is set to Reroute
Freely, then each time when the user is trying to drop something on that connector
the line is immediately rerouted, avoiding the dropped shape. This is an MS Visio
behaviour that unfortunately cannot be changed by AVEVA. To prevent connector
reroute during that operation the user has to set the reroute style to Reroute on
Crossover or Never Reroute using the Layout & Routing toolbar.
3. Dropped onto a free end of a tube shape: By aligning one of the connection points of
the part and a free end of a tube when the shape is dropped, they will be connected
and the shape will be defined (Define / Undefine) and added to the branch.
When an inline component is connected to a branch, the Arrive and Leave will automatically
be set to follow the flow of the branch. However, the visual appearance of the shape will not
5:4 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
be changed. There are two ways to make sure that the shape gets the right direction in the
branch:
1. Drop the shape onto an empty area of the drawing, and use the rotation handle to
properly align it with the branch it should be connected to. Then connect it to the
branch end or drag it over a tube to insert it.
2. Drop the shape into the branch (connect or split on drop), and if it gets the incorrect
orientation, use the Reverse Direction command.
When connecting a branch/tube to an item (valve, inline fitting, equipment, nozzle etc.),
which is a grouped shape, the connection points must be on the group and not on the
members of the group. Otherwise the connection operation will fail and the message Not a
valid pipe piece and/or pipe connection is shown.
It is not possible to directly connect tube/branch shapes to each other, a Visio 2D shape is
required in between. For example, to connect one branch to another, a fitting such as a Tee,
Olet or Coupling must be inserted, and the branches connected to this.
General
Automatic Tee insertion provides the possibility to automatically insert a Tee every time two
branches are connected by the user. At the branches connection point a predefined Tee
shape is inserted. If there is any specification or dimensioning conflicts the appropriate
dimensioning and size selection dialogs are presented to the user.
5:5 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
In the options dialog it is also possible to select the shape of the Tee to be automatically
inserted on connection of two branches, as well as from which stencil this shape should be
taken.
The option for Auto create Tee on connect branch is by default set to False.
It is left to the user to make sure that the Tee's shape name and stencil exist and are valid. If
a Tee with a chosen shape name is not found or a stencil with a chosen name is not found
errors will be generated.
5:6 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
Below is shown an automatically inserted tee when one branch is dragged to another one.
The result is as if the tee was placed over the static branch and then the dragged branch
connected to it.
5:7 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
Important: If the mouse pointer is closer to another connection point or to the centre point
of the shape as the shape is dragged, it will not be possible to connect.
7. Drag the shape so that the connection point aligns with the connection point of the
existing shape.
5:8 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
form left to right. The shape should also have one outwards connection point which will be
used to attach to the connector.
5:9 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
Figure 5:5. Definition of default flow direction symbol for pipe connectors
5:10 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
After the command is issued all necessary changes will be done to branch hierarchy in
database and its representation on current drawing is changed to fit reversed flow. The
changes done to database are following:
5:11 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
If other drawings containing parts of reversed branch are not updated (user answered No
to above question or it was impossible to edit the drawings e.g. because they were claimed
by another user) there is inconsistency between the drawings and database data. Such
inconsistencies are detected and fixed on opening drawing and by Consistency Check.
5:12 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
Sub-equipment items are not dependent on their parent equipment item being represented
on the same diagram. It is allowed to have the main equipment item on one diagram and the
subequipment item on another diagram, even if they are hierarchically linked in the
database. Likewise, when and if they appear on the same diagram, there are no layout
restrictions in terms of them having to be connected or close to each other in any way.
Note: When dragging a nozzle to connect to an equipment item, it is important that the
mouse pointer is close to the connection point on the nozzle that you want to connect
to it. Otherwise Visio will not find the correct connection.
The nozzle specification can be set by right-clicking on the nozzle shape and selecting the
Nozzle Specification command. This will bring up the Nozzle Specification dialogue.
5:13 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
In the Nozzle Specification dialogue, the Specification, Generic Type and Nominal bore
can be selected, and this will result in a specification reference. When the OK button is
clicked, the specification reference will be updated in the CATREF attribute of the nozzle.
Branches can now be created and connected to the nozzle.
5:14 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
This group can then be dragged and dropped onto a drawing, thereby adding an
arrangement of branches and inline fittings in a single operation. In case the arrangement
contains more than one branch, the user will have to select a part in each branch and issue
the Define branch command (Define / Undefine in Chapter Working with Diagrams).
Note: When a group of shapes is added to the drawing in the way described above, it is
recommended to ungroup it (Right click > Shape > Ungroup) before proceeding to
connect or modify. If this is not done, it can result in unexpected behaviour. For
instance that a tube within the group will not split into two when a new fitting is
dropped onto it.
5.11.1 Overview
The Diagrams application supports a flexible approach to the handling of dimensioning and
spec search. The following levels of automation are supported:
No dimensioning.
Dimensioning without catalogue or spec search.
Dimensioning with manual catalogue selection.
Dimensioning with automatic spec search.
These methods can also be combined in various ways and allows for an incremental/
iterative workflow. It is for instance possible to start a diagram using dimensioning but no
catalogue or spec search. At a later time when a catalogue and specification has been
established, the spec search can be enabled and the selection of components be done
based on the previously entered dimensions.
If the automatic spec search is enabled, the manual catalogue search can not be done for
in-line parts, please refer to Manual Component Selection in Chapter Working with
Diagrams for more information about the Catalogue Search window.
The dimensioning is using the concepts of Fit and Size operations:
Refit means that the current component will obtain a new size from the upstream
component. When this will occur automatically, it is called Autofit.
Resize means that the user will manually select a new size to be applied to the
component. This only applies to branching and size-changing components such as
tees and reducers.
The dimensioning can work with varying degrees of propagation of dimension changes.
Propagation will always occur in a downstream direction (from head to tail).
There are a number of default settings in Diagrams Options under General Options > Pipe
Dimensioning that control the way that the dimension and spec search is operating (please
refer to Defaults in Chapter Getting Started):
5:15 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
Refit - Autofit on delete True The component following the one that is
being deleted will automatically obtain the
dimension from the upstream component.
False The component following the one that is
being deleted will not obtain any dimension
from the upstream component.
Refit - Propagate autofit True Autofit should be propagated to
downstream components.
False Autofit should not be propagated to
downstream components.
Refit - Propagate at segment True Autofit propagation will continue over
segment limits.
False Autofit propagation will not continue over
segment limits.
Refit - Propagate at branch True Autofit propagation will continue over
branch limits.
False Autofit propagation will not continue over
branch limits.
Resize - Propagate at segment True Resize propagation will continue over
segment limits.
False Resize propagation will not continue over
segment limits.
Resize - Propagate at branch True Resize propagation will continue over
branch limits.
False Resize propagation will not continue over
branch limits.
Spec Search - Use Specification True The specification search will be used.
False The specification will not be used.
Dimensioning will be stored locally in each
inline part using the BOREARRAY attribute.
Spec Search - Allow out-of-spec True SPRE of tubes and inline components can
selection be set to GPART or SCOM rather than to
SPCOMPONENT.
False SPRE attribute of tubes and inline
components can be set only to
SPCOMPONENT.
5:16 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
5.11.2 No Dimensioning
To create a piping diagram without any dimensioning, all the settings described in the table
above should be set to False.
The Resize and Refit operations and related propagation settings operates in the same way
for dimensioning with or without spec search.
5:17 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
The pipe specification works as a default value that is propagated to subordinate elements
such as branches and inline parts as these are created within the pipeline. It is possible to
subsequently change the specification reference for an individual fitting through the Custom
Properties window or Item List.
If the pipe spec is later changed in the pipeline properties dialogue, it will not affect existing
inline parts within the pipeline, it will only be applied to new inline parts as they are added.
When a new branch is created, the boresize will be picked up from the default bore size that
is set up in the current pipeline.
When inline parts such as valves, reducers etc. are dropped into a branch, the bore will be
picked up from the upstream component and a specification search will be performed,
provided that the Autoselect on Define default setting is set to True in Diagrams Options.
Figure 5:9. After valve is dropped. The specification reference can be seen in the shape text, as this
has been set up to show [SPRE.NAME].
In case a size-changing or branching component will be dropped, the system will prompt the
user for a Leave bore? or Branching bore?. In all other cases the system will automatically
pick up the bore size from the element it will be connected to.
5:18 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
The Bore-question dialogue will present a dropdown list of valid boresizes picked up from
the specification. In case a user will type in a bore size that does not match any of these, the
application will round it up to the next defined bore size.
The result of the specification search will be that the specification reference (SPREF) will
point to the matching SPCO element. In case no matching SPCO will be found, the SPREF
will not be set.
The operation of the spec search is highly dependant on how the spec is organized in terms
of the hierarchy of questions and answers. In case the spec search will not find the expected
SPCO, please review the structure of the spec and modify if necessary.
The progress of the spec search is also presented in the Message Log window (refer to
Message Log in Chapter Working with Diagrams). Successful spec search operations are
logged as informational messages, while unsuccessful ones are logged as warnings.
All elements affected by an automatic spec search can also be left highlighted, depending
on the value of the Keep highlight after dimensioning default setting.
5:19 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
Note: When the automatic spec search is enabled, it is not possible to manually set
catalogue references for the inline parts using the Catalogue Search function
(please refer to Catalogue Search in Chapter Working with Diagrams).
5.11.6 Respec
Changing the specification of existing pipework can be done by first selecting all relevant
inline parts and then change the PSPEC attribute in the Custom Properties window. The
new spec will be applied to all the selected inline parts. After this, the spec selection process
will automatically be triggered and changes to Sprefs can be followed up by viewing the
Message Log.
Note: In order to get a good overview of what happens during the respec operation, it is
recommended to only respec a reasonable number of parts in the same operation.
This makes it easier to follow up and check any changes.
Note: To select, in the current drawing, all inline parts in a branch or a pipeline, it is possible
to right click on the branch or pipeline in the explorer and use the Select in Drawing
command.
In the case where a diagram has been created without using any specification, and you
subsequently want to apply a spec, the below procedure can be followed:
1. Go to the Diagrams Options dialogue and change the Use specification default
setting under General options > Pipe Dimensioning > Spec search to True.
2. Also make sure that any desired propagation settings such as Refit Propagate
Autofit, Refit Propagate at Segment and Refit Propagate at Branch are set to
True.
3. Close the Diagrams Options dialogue.
4. Click on the first tube/fitting in the branch you want to apply spec search to and select
pipeline properties.
5. In the Pipeline Properties dialogue, go to the Specification tab and select a Pipe
spec.
6. Click OK to close the dialogue.
7. Select the first tube or fitting in the branch, right click and choose Refit. The
specification search will now be carried out and propagated according to the
propagation settings.
5.11.7 Resize
In case the user would like to change the leave bore or branching bore on an existing
shape, the Resize command can be used. The Resize command is available on the main
Object menu as well as on the shape right-click menu. Whether the result of the Resize
operation should be propagated or not is controlled by the various propagation default
settings.
5:20 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
In case specification search is used, the Bore size dialogue will contain a dropdown list
where valid boresizes can be selected. In case the user will key in a bore size, this will
automatically be rounded off to the nearest valid bore size.
In case specification search is not used, the dropdown list will not contain any predefined
values, and the rounding will not occur.
Note: Resize can only be done at the start of a branch, at branching components such as
tees and at size-changing components such as reducers. All other components will
obtain their size from upstream components in order to keep the dimensional
consistency of the data model.
There are cases when the resize will not provide any result from the spec search, such as
when an equal Tee is resized to be un-equal. The Diagrams application then provides a
fallback in form of a new spec search which will hopefully find a matching SPCO of the un-
equal type. In case this happens, it will be visible to the user in the way that the Bore
question dialogue will appear twice.
5:21 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
5.11.8 Refit
In case a bore size inconsistency has occurred, the Refit function can be used. This can for
example happen when a reducer is inserted and the Propagate autofit setting is set to
False. In the example above, the reducer has an input bore size of 100 and output of 80
while the downstream valve has a bore size of 100. Such inconsistencies can be found by
using the Consistency Check function.
By using the refit function available on the shape right click menu, the specification
reference for the valve will be re-selected using the upstream bore size.
After the Refit command has been performed, the valve now has a correct bore size and
specification reference.
5:22 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
Depending on the propagation settings, the action will propagate downstream to a varying
degree.
Before Reverse Direction is performed, Arrive is 1 and Leave is 2. The Reverse Direction
command is available on the shape right-click menu.
5:23 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
After Reverse Direction has been performed, the symbol has been reversed and Arrive
and Leave have been exchanged.
Note: Reverse Direction only works on valves and fittings, which are Visio 2D shapes. In
case the user wants to reverse the direction of a tube segment, which is a Visio
connector, the standard Visio Reverse Ends command can be used. This command
can be found in the Shape > Operation menu in the main menu bar. An important
difference between these commands is that Reverse Ends changes the flow
direction, while Reverse Direction does not.
5.13 SpecSearch
By using the SpecSearch command a re-setting of SPREF of piping elements can be
performed. The functionality can be used e.g. for changing the specification for a whole
segment (or branch or pipeline depending on the propagation settings) as the component
selection is made from scratch and any existing search results or SPREF are not
considered.
5:24 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
The parts following the split point will now be re-organised into a new pipeline.
Note: If the Pipe Splitter will not split the line as it is being dropped, try to zoom in and make
sure that the hair cross is properly aligned with the line to be split.
If the Show property dialogue on split default setting is True, the application will
automatically show the pipeline properties dialogue for the newly created pipeline. This will
give the user the opportunity to change attributes as for instance the description of the new
pipeline.
Note: That the Join Pipeline command requires that the branches are not connected at
the join point.
5:25 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
5.19 Instrumentation
This chapter describes instrumentation features that can be used to create control systems
for piping diagrams.
5.19.1 Overview
The Diagrams application allows the user to create low and high level control systems.
There are a few special elements in the database that can be easily used to create a
5:26 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
instrumentation data model. Those elements can be grouped into schematic loops and can
be easily found and modified.
5.19.2 Elements
All elements that are members of a schematic loop can be easily found and selected on the
drawing. You can use one of the options from the context menu, Select in Drawing,
Highlight or Zoom to. A typical loop is presented below:
5:27 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
The Offline instrument (CCH-0/TC) is controlling the temperature inside the reactor. If the
temperature is too high/low, it gives a pneumatic signal via the tube to the actuator. The
actuator is steering cooling stream via a valve.
To create a new schematic loop the following dialogue is to be used:
SCILIN represents a Schematic Instrument Line in the data model. It is very similar to
SCPLIN and should be used by those who prefer to have a high level of detail in their
instrumentation model. SCILIN is able to refer to SCLOOP via the SCLORE attribute, similar
to other instrumentation elements. SCILIN has the same member hierarchy as SCPLIN
(SCBRAN, SCSEG etc.) and its primary hierarchy structure is the same as for SCPLIN.
5:28 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
The options here are the same as for pipeline. There is one additional option that allows to
set schematic loop references for Instrument Lines.
5:29 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
5:30 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
It is also possible to have connection points on the off-line instrument, allowing control lines
to be attached to it as can be seen in the example below:
It is also possible to connect two offline instruments directly, i.e. connect some alarms. To
achieve this the connection points have to be added as shown below:
The offline instrument has to be dragged with the outward connection point to offline
instrument with the inward connection point.
5:31 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
SCACTU is representing a Schematic Actuator in the schematic database. Its attribute set
and behaviour is very much like SCOINS and its primary owner is the same as for the
SCOINS element. The differences between SCACTU and SCOINS are in:
the item they represent
the element they can refer to
the way the user can manipulate them in the AVEVA Diagrams application.
SCACTU is able to refer (attach) to another inline component, such as SCVALV, SCFITT
and SCINST. The SCOINS shape accomplishes this by using the Control Handle. On the
contrary, the SCACTU has a an outwards connection point used to build up the reference in
the diagram (SCNOZZ works similarly).
Actuators can be connected to:
equipments
sub-equipments
offline instruments
other actuators
valves
fittings
5:32 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
5:33 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
Example:
SCIREF Attribute executed on SCOINS, points to SCVALVE (returns all items that
are connected via SCIREF).
Note: There is one more pseudo attribute called SCEIRE that returns the sum of SCIREF
and SCIREL.
For Actuators and Offline Instruments there is a possibility to query on only references to
elements of a particular type (process or instrumentation). To get such information the
following pseudo attributes should be used:
SCIRLT Pseudo attribute returning all connection types that are linked with SCIREL.
SCIERT Pseudo attribute returning all connection types that are linked with SCEIRE.
5:34 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
The table in the following example illustrates possible data extracted by SCIREF and
SCIRTY.
5:35 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
Instrument Relationship Shape does not represent a database element, but do represent a
SCIREF between SCOINS and SCACTU. In the figure below, the dashed line represents a
SCIREF from the SCOINS element at CCH-0 to the SCACTU representing the actuator at
AT-12. The actuator has a SCIREF set to A150/Vv-002.
When Instrument Relationship Shape connects two valid items, it changes colour to
defined. The colour can be determined in Diagrams Options:
5:36 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
As mentioned earlier, Instrument Relationship Shape does not represent any database
element but it can display information from a database element that is associated with its
start. It has a little support for SCIRTY because it is representing a connection. This
connection type can be set using the Custom Properties / Shape Data window. If the Text
property is filled in, the Instrument Relationship Shape displays connection type value on
drawing using SCIRTY attribute without index. The system will automatically find the correct
one.
In the figure below the offline instrument has SCIREF set to equipment and actuator. A
connection between the equipment and offline instrument is achieved by the control handle
which is using an infra red interface. A connection between the offline instrument and
actuator is achieved by instrument relationship line which is using an electrical interface.
5:37 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
5:38 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
If desired, individual fittings can have a direct SCLORE making them direct members of
another loop. This may be the case when bridging between different systems and/or signal
styles.
It is possible to create control lines from tubes, valves etc. Those elements are the same
elements that are created under pipe lines. To distinguish between those two line types in
the Diagrams application when importing shape, AVEVA Diagrams gives the user new types
to select:
1. Instrument line - works similar to Pipeline, creates SCILINE element in database after
drop.
2. Instrumentation branch - works similar to Branch, creates branch, segment and tube
under SCILIN after drop.
3. Instrumentation tube - works similar to Tube, creates tube under segment.
5:39 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
All inline components (valves and fittings) have the same Visio shapes for two types of lines:
pipelines and instrument lines. To distinguish them in the drawing it is possible to determine
different colours for items defined under SCPLIN and items defined under SCILIN lines.
5:40 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
5:41 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
Note: The Propagation mechanism does not support multiple SCLOOPs. If the previous
value was multiple SCLOOP the propagation will not continue after the change.
Additionally, propagation will stop on elements when:
5:42 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
There is an option called Ask user for loop reference when connecting instrument loop.
When the instrument item is connected to another item that does not have SCLORE set, the
system will automatically ask for SCLOOP.
5:43 12.0
Diagrams User Guide
Piping & Instrumentation Diagrams (P&IDs)
5:44 12.0
Diagrams User Guide
HVAC Diagrams
6 HVAC Diagrams
In this chapter the special functions and procedures for the HVAC discipline are covered
and it is of special interest to users creating HVAC diagrams.
6.1 Overview
The application supports the creation of HVAC diagrams. This has a lot in common with the
creation of piping diagrams, but with the following major differences:
The dimensioning considers the shape factor (Rectangular, Round, Oval).
There is no automatic spec search.
To create HVAC diagrams, the HVAC mode should be used. This can be selected in the
Tools > Mode menu.
Before reading the HVAC diagrams documentation, it is recommended that you read the
Pipe diagrams section. The documentation for HVAC diagrams primarily covers the
differences compared to the piping diagrams functionality.
6:1 12.0
Diagrams User Guide
HVAC Diagrams
This dialogue is similar to the Create Pipeline dialogue, the most significant difference is in
the Default Dimension tab. In this tab the Shape setting is available as well as Width and
Height for using with the rectangular and oval shapes. For the circular shape, only the Width
is available, which then represents the diameter.
6:2 12.0
Diagrams User Guide
HVAC Diagrams
6.5 Dimensioning
The HVAC dimensioning considers the shape factor as well as the dimension. The shape
factor is stored in the Conarray attribute, and the dimension in Heightarray and Widtharray.
In case a circular shape is used, the diameter is stored in the Heightarray.
When a branch shape is dropped on a drawing, the dimension will be picked up from the
default dimensioning settings for the HVACline.
As HVAC fittings are added, they will pick up the dimension from the upstream component,
provided that the Autoselect on Define default setting is True.
6:3 12.0
Diagrams User Guide
HVAC Diagrams
As can be seen in the picture above, the fittings will by default get the same dimension for
arrive and leave. Please note that the CON1 & CON2 annotations do not reflect arrive and
leave, but rather connection1 and connection2.
The behaviour of the dimensioning during the creation of HVAC diagrams can be controlled
through a number of default settings that can be found under General options > HVAC
Dimensioning:
6:4 12.0
Diagrams User Guide
HVAC Diagrams
6.6 Resize
The Resize command is available on the right click menu of the shape. It will bring up a
dialogue where the leave size, and if applicable also the branching size can be set. Whether
the result of the Resize operation should be propagated or not is controlled by the various
propagation default settings.
6:5 12.0
Diagrams User Guide
HVAC Diagrams
6.7 Refit
In case a size inconsistency has occurred, the Refit function can be used. This can for
instance happen when a dimension is changed and refit propagation is disabled (HVAC
Dimensioning > Refit options set to False). Such inconsistencies can be found by using
the Consistency Check function.
The Refit function is available on the shape right click menu and will apply the upstream
size to the current part.
6:6 12.0
Diagrams User Guide
Cable Diagrams
7 Cable Diagrams
This chapter covers the special functions and procedures for the Cable discipline and is of
special interest for users creating single line and core connections diagrams.
7.1 Overview
The application supports the creation of single line cabling diagrams as well as core
connection diagrams.
Note: That you might have to refresh the shapes to update annotation etc. on the drawing,
after the Rename operation is complete.
Electrical equipment items can be created in the same way as other equipment items. See
the Using Equipment and Subequipment in Chapter Piping & Instrumentation Diagrams
(P&IDs). For cabling diagrams, electrical connection elements can be used. These behave
very much like piping nozzles, see Using Nozzles in Chapter Piping & Instrumentation
Diagrams (P&IDs).
7:1 12.0
Diagrams User Guide
Cable Diagrams
7:2 12.0
Diagrams User Guide
Cable Diagrams
Attribute Value
SCDELIM '-'
SCALPHA false
SCDIGITS 2
Element Name
SCCAB1 /XYZ-01
SCCAB2 /XYZ-02
Example 2:
Attribute Value
SCDELIM Unset
SCALPHA true
Element Name
SCCAB1 /XYZ_1A
SCCAB2 /XYZ_1B
Note: The names of cables owned by Multi-cable will be generated automatically only
when the name of the Multi-cable itself is set.
7:3 12.0
Diagrams User Guide
Cable Diagrams
Note: To select all cables in a drawing or cables according to a certain criteria, the
Selection Toolbar can be used (refer to Find in Drawing Toolbar in Chapter Working
with Diagrams.
The Define Core Connections dialogue will contain one section for each cable. In the
middle is the cable with its cores and to the left and right are the connected equipment
items.
7:4 12.0
Diagrams User Guide
Cable Diagrams
This will bring up a Catalogue Search dialogue, which works in the same way as the
general Catalogue Search function (Catalogue Search in Chapter Working with Diagrams).
7:5 12.0
Diagrams User Guide
Cable Diagrams
When a cable catalogue item has been selected, the Cable Core Connection Definition
dialogue will know how many cores the cable has got and will then show the corresponding
number of rows.
This will bring up the standard Browse/Search dialogue (Standard DB Browse Dialogue in
Chapter Working with Diagrams) where an equipment item can be found and selected.
7:6 12.0
Diagrams User Guide
Cable Diagrams
The text box in the Equipment column also features a fill handle. By clicking and dragging
on the grey box in the lower right corner, the selected equipment can be applied to other
rows in the same way that the fill handle works in applications like MS Excel.
It is also possible to change the connected equipment item for a cable that has been
connected to an equipment shape in the diagram. Changing the equipment item in this
dialogue will only affect the core connections. The cable as such will still retain its
connection to the equipment item, as defined in the diagram, and will not be affected.
Theoretically it is possible to define all cores being connected to a different equipment item
than the one that the cable is connected to, in the single line diagram.
7:7 12.0
Diagrams User Guide
Cable Diagrams
This will bring up the Create electrical connection dialogue, where the new electrical
connection can be created and its attributes set. The Catalogue reference is of special
importance as it will be used to determine how many terminals the elconn has.
The Electrical connection column also features a fill handle like the one described above for
the Equipment column.
7:8 12.0
Diagrams User Guide
Cable Diagrams
Here it is also possible to configure tooltips to be shown in the dialogue. This can for
instance be used to show the description of an equipment item when the mouse hovers over
the equipment name. The format of the tooltip definition follows the Attribute Presentation
Notation format, please refer to Attribute Presentation Notation in Chapter Appendices for
further information.
The Diagrams application is delivered with a standard core connections diagram layout
which can be considered a sample. As there is a wide variety of preferred layouts and many
7:9 12.0
Diagrams User Guide
Cable Diagrams
companies have their own layout standards, the program source code for the Core
Connections diagram generation is provided on the support site (www.aveva.com/support).
It is therefore possible for customers to modify the layout by modifying the program code, or
to create totally different layouts by creating new code, perhaps with some inspiration from
the standard sample.
The program code is contained within the following c# source files:
CableInfo.cs
CoreInfo.cs
Commands.cs
CoreConnectionsDiagram.cs
CoreConnectionsDiagramAddin.cs
These can be found on the installation DVD in folder Manuals/Docs/Samples.zip.
Microsoft Visual Studio is required to modify and rebuild the Add-in.
7:10 12.0
Diagrams User Guide
Reporting
8 Reporting
The Diagrams application offers different types of reports of schematic data for various
purposes. These are as follows:
Visio reports: This is the standard MS Visio report function and can be used to create
reports based on diagram document data. Please refer to the MS Visio documentation
for more information. This command is available in the Tools-Reporting > Visio
Reports menu.
Reports: This is the standard AVEVA reporting tool which can create reports from
database data and is also available in the other PDMS applications. In the Tools-
Reporting > Reports sub-menu there are commands for running, creating, modifying
and deleting reports. Please refer to the General / Reporting Reference Manual for
more information on this reporting tool.
Quick Reports: This is the standard AVEVA quick reporting tool and is available in the
Tools > Reporting-Quick Reports menu. Please refer to the Catalogues and
Specifications User Guide / Quick Reports Form for more information.
Spreadsheet export: This is available on the right click menu in the Item List (please
refer to Item List in Chapter Working with Diagrams) and can be used to create
equipment lists, fitting lists, cable lists etc. from the current drawing. This is further
described in Export in Chapter Working with Diagrams.
8:1 12.0
Diagrams User Guide
Reporting
8:2 12.0
Diagrams User Guide
Releasing Information for 3D
This chapter includes information about managing the relation with 3D data and is of interest
to most users when the link to 3D through the Schematic 3D Integrator is used.
9.1 Overview
To support the workflow between diagram designers and 3D model designers, Diagrams
includes some functions to manage the release of information to 3D. These are as follows:
Setting the Release Status.
Highlighting and Visualizing Release and Linked-to-3D status.
Warnings and Restrictions for Released and Linked-to-3D items.
Diagrams supports a Release status that can be set or re-set through the application and
serves as a flag to the 3D designers that the diagram data is now complete and approved
and can be used as a base for 3D modelling. When related 3D data is created through the
Schematic 3D Integrator, a link between 2D schematic items and corresponding 3D items
will be established in the database. These items are then considered to be linked, and this is
represented by a linked-to-3D status attribute. If items have been linked they can be
considered as being picked up and re-used by the 3D designers.
The release status can be set on database items in a flexible way, among these is to set the
release status for all items in a diagram. However, the diagram document as such does not
have a release status and will not be managed in this way.
The release status is represented by the RESTAT attribute in the database. A value of 1
means that the item is released, and a value of 0 means that it is not released.
The diagram documents are made available to 3D design users as SVG files, created for
each foreground page on the drawing. This can then be used for viewing the diagram
without the need for having MS Visio installed. The SVG file name for a particular page can
be found by querying the NVIEWF(N) pseudo attribute on the SCDIAG element, where N is
a number of a page.
Depending on the Create SVG on Save Work setting available in Diagrams
Options>General Options>System configuration>SVG, the files can be created
automatically on Save Work for every drawing, for pages containing data released to 3D
only or if the setting is set to Never the SVGs will have to be created manually using the
Release Diagram to 3D function. If this function is used, then all items on pages the SVGs
are created for are released to 3D. For more information please see Save Work and SVG
Creation in Chapter Working with Diagrams.
9:1 12.0
Diagrams User Guide
Releasing Information for 3D
9:2 12.0
Diagrams User Guide
Releasing Information for 3D
When the dialogue is opened, the current release status is shown. If the item is already
released, you will see a green checkmark in the box in front of the item. For hierarchically
superior items, there is also a green checkmark if all subordinate items are released. If only
some of the subordinate items are released, there will instead be a green box shown.
After the type, name and description of the item, the date and user that released it is also
listed.
To set the release status, click the boxes. If a box on a high level is checked, all subordinate
items will also be checked, the same applies if you uncheck a box.
As well as setting the release status, it is also possible to reset it here, simply by unchecking
the boxes. This means that items that were earlier released now no longer are released.
This enables the user to make changes to already released items and these changes can
be detected by the Schematic 3D integrator application. Once the changes are complete,
the release status can be set once again.
The dialogue also includes a Comment field which can be used to enter a release comment
to be applied to the items.
Depending on how the Set Release Status command was activated, the dialogue will show
a different hierarchy:
9:3 12.0
Diagrams User Guide
Releasing Information for 3D
The picture above shows the Group Context window which will be displayed when a
schematic group has been selected in the explorer. The dialogue now shows the complete
hierarchy below the group node.
9:4 12.0
Diagrams User Guide
Releasing Information for 3D
The picture above shows the Objects Context window which will be displayed when one or
more objects have been selected in the explorer or in the drawing. The dialogue now only
shows parts of the hierarchy covering the selected items. If for instance a piping or HVAC
branch has been selected, the explorer only shows that branch, even if the pipeline might
have other branches.
9:5 12.0
Diagrams User Guide
Releasing Information for 3D
The picture above shows the Diagram Context window which will be displayed when the
user has right clicked an SCDIAG element in the explorer or on the drawing background.
The dialogue now shows all items in the current drawing. In case the drawing contains parts
of a pipeline (branches or segments) while other parts of the pipeline are represented in
other drawings, the explorer only shows the parts of the pipeline that are on the current
drawing.
9:6 12.0
Diagrams User Guide
Releasing Information for 3D
The dialogue above will be shown when an item which is released but not linked is modified.
If the user clicks OK, the modification will be applied to the item and the release status will
be reset. If the user wants to release the item to 3D again, he/she will have to use the Set
Release Status function again. If the Cancel button is clicked, any changes will be undone.
9:7 12.0
Diagrams User Guide
Releasing Information for 3D
If the user tries to delete one or more items that are released but not linked, the dialogue
above will be shown. If the user clicks OK, the item(s) will be deleted, otherwise the user
should click Cancel.
Also if the user opens the Pipeline Properties / HVACline Properties dialogues, a warning
will be issued.
9:8 12.0
Diagrams User Guide
Utilities
10 Utilities
This chapter describes miscellaneous utilities that can be useful to most users.
To the left, the contents of the database can be navigated using the Database Tree tab and
searched using the Search tab. This part of the dialogue behaves more or less like the
general Browse Dialogue (please refer to the Standard DB Browse Dialogue in Chapter
Working with Diagrams), with the difference that it contains checkboxes for multiple
10:1 12.0
Diagrams User Guide
Utilities
selection in the tree view. In the search view, multiple diagrams can be selected by using
normal Shift+Click and Ctrl+Click.
Items can be added to the selection in the right side of the dialogue by using the Add button
and removed using the Remove button.
The selected diagrams can then be consistency checked and printed by using the buttons at
the bottom of the dialogue.
Overview
The Batch update function is used to update many drawings in one go without opening
them separately. The option is available in the Batch Job dialogue below.
Before proceeding, select the diagrams that are to be updated. After selecting the diagrams
click the Update Diagrams button.
10:2 12.0
Diagrams User Guide
Utilities
The following example will explain the difference between a BaseID and a UniqueID:
A BaseID is assigned to a master when it is created. The valve has been dropped on to the
page from the Sample_Valve_Symbols stencil. As a result of this operation the new master
will be created in the Document Stencil. Both masters (on the document and
Sample_Valve_Symbols stencils) will have the same BaseID and UniqueID. If one of the
masters is changed the UniqueID will also change but the BaseID will remain the same. For
more information refer to the Microsoft Visio documentation.
10:3 12.0
Diagrams User Guide
Utilities
If modifying masters items on external stencils and applying changes to shapes, which were
created by dropping these masters, those masters need to be selected. To do that click the
Select master shapes to use for update button in Figure 10:2.: Update Diagrams Options
Form. The following dialog will be shown.
The dialogue above contains three windows: Stencils, Masters and Masters to update.
These windows will be empty at start up. Click the Add Stencil button to add a stencil that
contains modified masters. These added stencils will be shown in the Stencils window. In
the Masters window the masters that belong to a selected stencil are displayed. Only the
masters in the Masters to update window will be used during the update operations. To add
masters to the Master to update window, use drag and drop or the right-click context menu.
If the Add all check box is checked all masters from all stencils will be added. To remove
masters from the Master to update window select right-click on a master or use the Delete
key on the keyboard.
10:4 12.0
Diagrams User Guide
Utilities
The number of selected masters will be visible in brackets in the Update Diagrams Option
dialogue as shown below.
Note: If an autolabel is deleted from a shape after the update the label might not be added.
The reason for this is because the system remembers that this label was previously
10:5 12.0
Diagrams User Guide
Utilities
deleted. To add an autolabel use the option Ignore stencil settings or select the
correct master.
When this option is unchecked the shapes will be updated according to the diagrams default
settings. Otherwise data from the selected master will be used. If the master was not
selected, the system checks if a shape that should be updated retrieved its settings from the
master or the default. If the settings were taken from the master and the master was not
selected then the shape will not be updated. If the settings were taken from the diagrams
default settings then the system will update the shape. During update all Shape Data
(Custom Properties) that exist in the shape instance but does not exist in the current
settings will be removed. The only exception from this rule is a situation where other cells
depends on it. When this is the case, the system will not delete it but will display a warning
that other cells are using this data. See the following example:
A shape has two shape data before update:
Text
Instrument Type
This will be displayed as in the following figure.
The next step is to modify the settings to hold only one set of shape data:
Text
10:6 12.0
Diagrams User Guide
Utilities
2. The instrument type remains. This is because other cells are using its value. In this
case there will be a warning issued in the report.
Warning message:
This update will not set any default values to new shape data.
Refresh Shapes
If this option is checked it will make a call to refresh each shape.
Note: This setting will not work for the autolabels layer. The layer for autolabel is taken from
the master that is used to create autolabel.
10:7 12.0
Diagrams User Guide
Utilities
When all the steps are finished more details can be viewed by clicking the link label:
Information can be selected and copied to the clipboard. To save the report to a file, click the
Save Report button on the Update Diagrams Status form.
To load a saved report, use the Load Log button on the Update Diagrams Options form.
10:8 12.0
Diagrams User Guide
Utilities
The result summary for each diagram is reported in the Errors, Warnings and Informational
columns, as well as represented by the icon before the diagram name. The progress for
each diagram can be seen in the Progress Bar as well as in the status text below it.
By using the Stop button, the Check function can be cancelled.
In case the user wants to further investigate any of the issues found in a diagram, it is
possible to select the diagram and use the Open Diagram button. The diagram will then be
opened in the background, and after the dialogue is closed, the Consistency Check
function can be used to create a detailed report of the issues with that diagram.
10:9 12.0
Diagrams User Guide
Utilities
10:10 12.0
Diagrams User Guide
Utilities
After clicking the Yes button all old session files connected with DB elements (of selected
types) existing in the current MDB are removed. Only the files that are related with the most
recent version of each element will be kept. Files that are not connected with any SCDIAG,
SCTEMP or SCSTEN from the current MDB are not considered to avoid accidental deleting
of important files.
Note: 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.
Note: Using the Clean Old Session Files function will only remove Visio and SVG files
related to old sessions, it will not remove the actal dabacon DB settings. To remove
the sessions from the DB, use the Merge Changes function in Admin.
10:11 12.0
Diagrams User Guide
Utilities
To start the add-in, from the View menu select AVEVA Instrumentation Data Update.
For more information please refer to the AVEVA Instrumentation Data Update User Guide.
Schematic and engineering users should use this guide to understand how to update their
schematic models with instrumentation data mastered in AVEVA Instrumentation.
10:12 12.0
Diagrams User Guide
Utilities
During the export process the tool reads Visio geometry and styles information and creates
corresponding DWG objects that the best fit Visio components. Whole component
corresponding geometry objects are exported as blocks with component attributes as block
attributes. Then blocks inserts are creating DWG file geometry. The existing background
page of the Visio drawing is exported as one block named Background.
All additional texts corresponding to the Visio component are exported separately as MTexts
and grouped with blocks. It makes editing texts easier and available without block
exploding.
10:13 12.0
Diagrams User Guide
Utilities
Geometry:
Supported: Line
Arc
EllipticalArc
Polyline
Ellipse
Unsupported: NURBS, Spline, Infinities
Note: If some unsupported shape geometry will be found, a proper
message will be displayed in the Message Log.
Foreign object:
Lines Option:
Supported: Weight
Colour
Pattern (patterns depend on user
Diagrams.lin file definition).
Ends
Unsupported: Round corners, Transparency, Caps
Fill options:
Texts:
10:14 12.0
Diagrams User Guide
Utilities
Data:
Layers:
Note: There are some differences between DWG and the original Visio format. If a Visio
shape geometry is an open contour or the filled area is defined by more that one
geometry, it is not possible to fill it using hatch in DWG format. An example of this is
the AVEVA logo from the default diagrams background which is exported with
incorrect fill in some of the letters.
10:15 12.0
Diagrams User Guide
Utilities
Main Form
After running Dwg export, the Dwg export docked window will show on the Diagrams main
form. With every first run of this add-in, there will be export settings from
DiagramsCadExport.xml file located in the application directory. The Export window
has four operating buttons (see Figure 10:14.: Dwg export window) and two tabs. The tabs
are described further in Settings Tab and Lines Map Tab below.
Operating buttons:
Dismiss Closes the Dwg export window
Load Loads settings from
DiagramsCadExport.xml
file
Save Saves settings to
DiagramsCadExport.xml
file
Export Runs export
10:16 12.0
Diagrams User Guide
Utilities
10:17 12.0
Diagrams User Guide
Utilities
Selected - collects all selected shapes from the active page and all from the
background page, if the background page is not the active page. The order of
selection determines the order of export.
Units - option for choosing metric or imperial units to be used in the DWG file.
Available units:
Millimetres - measurement - Metric.
Inches (default) - measurement - Imperial.
10:18 12.0
Diagrams User Guide
Utilities
10:19 12.0
Diagrams User Guide
Utilities
10:20 12.0
Diagrams User Guide
Utilities
A,pattern
A simple pattern is a sequence of dashes, dots or spaces separated by commas:
Dash - is represented by a positive number.
Space - is represented by negative number.
Dot - is represented by zero.
Example 1:
A simple linetype definition containing dashes:
*myLine1,- - - - - - - -
A,1,-1
Example 2:
A simple linetype definition containing dashes and dots:
*myLine2,- . - . -
A,1,-0.5,0,-0.5
To define the linetype that includes text characters, some parameters must be defined:
"text" - text to display (must be defined)
textstylename - used text style (must be defined)
scale - the scale or height of the text
rotation - rotation angle of the text
xoffset - X offset from the end of the previous space
10:21 12.0
Diagrams User Guide
Utilities
Example 3:
Line type definition with text character:
*myLine3,- B - B - B -
A,1,-0.5,["B",STATNDARD,S=0.4],-0,-0.5,-0
Example 4:
Line type definition with rotated text character:
*myLine4, - B - B - B -
A,1,-0.5,["B",STANDARD,S=0.4,R=18],-0,-0.5,-0
Example 5:
Line type definition with moved text character:
*myLine5, - B - B - B -
A,1,-0.5,["B",STANDARD,S=0.4,X=0.2,Y=0.3],-0,-0.5,-0
10:22 12.0
Diagrams User Guide
Utilities
Example 6:
Line type definition with text character above continuous line:
*myLine6, -B-B-B-B-B-
A,1,-0,["B",STANDARD,S=0.4,Y=0.3]
Example 7:
*FLOWDIR, -->---->--
A,1,-0,[">",STANDARD,S=0.1,R=0,Y=-0.05]
10:23 12.0
Diagrams User Guide
Utilities
10:24 12.0
Diagrams User Guide
Schematic Model Viewer
11.1 Overview
The Schematic Model Viewer allows users to view the contents of the schematic model
database independently of diagram layouts. It provides a continuous navigable view of
equipment items and the interconnecting piping networks, independently of which system
they belong to or which P&ID they have been drafted on. In the current release, it only
shows piping connections. Cable and HVAC will be added later.
The Schematic Model Viewer is implemented as a CAF Add-In, meaning that it can be
hosted by different applications. The viewer will also require access to a SCHE DB as part
of the current MDB.
11:1 12.0
Diagrams User Guide
Schematic Model Viewer
To start the viewer, the user will have to select an equipment item. This item will be placed at
the centre of the generated view and the system will automatically find all connections in the
database and display each connection as a graphical sub tree. Each subtler is traversed
through all branches until other equipment items or branch ends are encountered.
Branching points (such as Tees, Owlets or 3-way valves) are represented by a generic
branching point symbol. The initially generated view will not extend beyond the equipment
items encountered at the end of the branches, but it is possible for the user to manually
expand and continue exploring along the schematic network. Equipment items are
displayed using different icons, selected by a set of customer definable rules.
The viewer also comes with its own toolbar, which contains the following buttons:
New Schematic Model View
Save as Visio drawing
Print
Centre item
Expand
Collapse
Show inline items
Settings
When using the New Schematic Model View command in the toolbar, a Select Equipment
dialogue will be shown where the equipment item can be selected.
11:2 12.0
Diagrams User Guide
Schematic Model Viewer
11.3 Navigation
Command Result
Ctrl+Shift+Left mouse button click Zoom in
Ctrl+Shift+Right mouse button click Zoom out
Ctrl+Shift+Right mouse button drag Pan
Expand By selecting an item and using the Expand command (available in the
toolbar and in the right click menu), all connections to that item will be
traversed and expanded. This will generate a new view.
Collapse Items that have previously been expanded can also be collapsed,
restoring the previous state.
Centre Item By selecting a particular equipment item (except the one in the centre)
and using the Centre Item command, a new view will be generated with
item in the centre. This will in essence be the same as making a New
Schematic Model View command for that item.
11:3 12.0
Diagrams User Guide
Schematic Model Viewer
When items are selected in the viewer, the CE will also change accordingly. This means that
if the schematic explorer is visible, the currently selected item in the drawing will also be
selected in the explorer. In case this is not desired, it can be turned off by changing the
Follow CE setting in the Settings dialogue.
Note: Certain operations such as Expand, Centre Item etc., will re-generate the layout and
therefore manual adjustments done by the user will be lost.
11:4 12.0
Diagrams User Guide
Schematic Model Viewer
11.7 Settings
By selecting the Settings command in the toolbar, the Settings dialogue will be shown. It
contains the following settings and options:
By clicking the Apply button, the settings can be applied to the view without closing the
dialogue.
11.8 Icons
The icons used to represent the equipment items, generic branch points as well as inline
fittings is determined by a set of user configurable rules. These rules are stored in an XML
file, called ScheModViewConfig.XML which resides in the main installation directory.
Below can be seen an example of this file. By changing the file, it is possible to apply
different rules for the selection of icons. The icon files are by default stored in the
11:5 12.0
Diagrams User Guide
Schematic Model Viewer
11:6 12.0
Diagrams User Guide
Appendices
A Appendices
[scplin.bore] Will fetch the default bore attribute from the pipeline element
that owns the current hierarchically subordinate element, for
example a valve
[owner.owner.owner.bore] Will provide the same result as above for a valve. The owner
of a valve is the SCSEG element, the owner.owner is the
SCBRAN element, and the owner.owner.owner is the
SCPLIN element.
[name]-[spref.name] Will display the name of the current element, a literal (in this
case a "-"), and the name of the related catalogue element.
A:1 12.0
Diagrams User Guide
Appendices
A.3 Customisation
A.3.1 Overview
The Diagrams application provides significant built-in customisation capabilities through
XML menus, default settings, UDETs and UDAs, autonaming, attribute presentation notation
etc. For more extensive customisation it is also possible for customers to develop new
program functions and routines.
Diagrams is based on the AVEVA Design Platform, and thereby includes all of the
customisation and development possibilities provided by that platform. Examples of this are
the database.Net API (AVEVA.Pdms.Database) as well as other.Net APIs. CAF Add-ins can
be created and PML can be used to the same extent as in the Design (General) module.
In addition to this, the actual Microsoft Visio Drawing Control used by Diagrams is also
accessible, giving the user full access to the extensive toolbox that MS Visio provides. A
good example of how this works is the CoreConnectionsDiagramAddin, which is a sample
A:2 12.0
Diagrams User Guide
Appendices
Addin shipped with the product to create core connection diagrams. The addin is delivered
with source code for the user to use as template when creating their own addins to support
their particular needs.
Example
using System;
using Visio=Microsoft.Office.Interop.Visio;
using Aveva.Marine.Diagrams;
namespace UserAddin
{
/// <summary>
/// Summary description for AccessVisio.
/// </summary>
internal class AccessVisio
{
internal AccessVisio()
{
//
// TODO: Add constructor logic here
//
}
internal static bool IsDrawingActive()
{
System.Reflection.Assembly _assembly =
System.Reflection.Assembly.Load( "mardiag" );
System.Type _type = _assembly.GetType(
"Aveva.Marine.Diagrams.mardiagApp",
true,
false );
System.Reflection.MethodInfo _info = _type.GetMethod(
"GetCurrentVisio",
System.Reflection.BindingFlags.Static |
System.Reflection.BindingFlags.Public );
Visio.Application visApp = (Visio.Application)_info.Invoke
( null, null );
if(visApp == null)
return false;
return true;
}
internal static void AddDescription(string ElemType, string Description)
{
System.Reflection.Assembly _assembly =
System.Reflection.Assembly.Load( "mardiag" );
System.Type _type = _assembly.GetType(
"Aveva.Marine.Diagrams.mardiagApp",
true,
false );
A:3 12.0
Diagrams User Guide
Appendices
if(visApp == null)
return;
//Find all shapes of type ElemType and add Description
foreach(Visio.Shape shape in visApp.ActivePage.Shapes)
{
try
{
if(shape.get_CellsU("User.ElementType").get_ResultStr
(Visio.VisUnitCodes.visNoCast) == ElemType)
{
try
{
shape.get_CellsU("Prop.VMD_SCEQUI_DESC").FormulaU =
string.Format("\"{0}\"", Description);
}
catch(Exception){};
}
}
catch(Exception){};
}
}
}
}
Another approach is to use the
AVEVA.ApplicationFramework.Presentation.WindowManager and iterate through the
windows looking for an active Drawing Control.
Example
if( WindowManager.Instance.MainForm.ActiveMdiChild != null )
{
_activeCtrl = WindowManager.Instance.MainForm.ActiveMdiChild.ActiveCont
rol;
if(_activeCtrl != null && !(_activeCtrl is AxDrawingControl))
{
foreach(System.Windows.Forms.Control ctrl in
WindowManager.Instance.MainForm.ActiveMdiChild.ActiveControl.Contro
ls)
{
if(ctrl is AxDrawingControl)
{
_activeCtrl = ctrl;
break;
}
}
}
}
When the Visio.Application instance is obtained from the Drawing Control it is possible to
invoke any of the Visio API methods available to customize the drawing.
A:4 12.0