Documente Academic
Documente Profesional
Documente Cultură
User Guide
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.
First published September 2007
AVEVA Solutions Ltd, and its subsidiaries
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.
Contents
Page
Schematic 3D Integrator
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Who Should Use this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Assumptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
Start the Integrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
Select Main Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
Open and Close a Diagram View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2
Zoom and Pan in a Diagram View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:4
Build a 3D Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:4
Compare a 2D and 3D Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:6
Link and Unlink Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:8
12.0
Subtype Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Main Object Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Scope for Schematic Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Column Setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Settings, Interaction Mode and Reset Cell Feedback . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Refresh
..............................................................
Export to Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Print Preview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Save Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Save Layout As . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Display a Main Table Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4:1
4:2
4:2
4:3
4:4
4:5
4:6
4:6
4:6
4:6
4:6
4:7
4:8
4:8
4:8
4:9
4:9
4:9
4:9
4:9
ii
12.0
4:19
4:19
4:19
4:19
4:19
4:20
4:21
4:21
4:22
4:22
4:23
4:23
4:23
4:23
4:24
4:24
4:24
4:25
4:25
4:25
4:25
4:25
4:27
4:28
4:29
4:30
4:30
4:31
4:32
4:32
iii
5:1
5:2
5:2
5:2
12.0
Schematic to 3D Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Link Database Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Release to 3D Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Duplicate Names for Tagged Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Matching Objects using Key Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Comparing Sub-Equipment and Nozzles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Comparing other Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5:3
5:4
5:4
5:4
5:4
5:5
5:5
5:5
5:6
5:7
5:8
5:8
6:1
6:2
6:3
6:3
6:4
iv
12.0
12.0
vi
12.0
Introduction
This guide introduces AVEVAs Schematic 3D Integrator product. The Integrator is provided
as an Add-In to AVEVA Plant DESIGN and AVEVA Marine Outfitting. This chapter lists the
different types of user who would need to read this guide and sets out what knowledge they
will need before they start. It then explains how the Integrator is used in conjunction with
other AVEVA products.
1.1
1.1.1
Assumptions
Users have a valid Integrator license and the software has been installed.
Users of the Integrator have a basic knowledge of AVEVA DESIGN or Marine Outfitting.
Administrators have a reasonable knowledge of AVEVA Plant or Marine database structures
if they need to configure rules. A knowledge of PML is required if they need to set up batch
processes or customise the Integrator.
1.2
1:1
12.0
Integrator Controls explains how the user interface enables the Integrator tasks to be
invoked.
Integrator Functions in Detail explains the concepts behind the Integrator and describes the
main tasks in detail.
How to Configure Build Rules explains how to use the Integrator Configuration Tool.
How to use Integrator from the Command Line explains how to use Integrator functionality
from the command line.
How to Customise the Integrator describes the mechanisms available to customise the
Integrator for specific project needs.
1.3
Figure 1:1.
1.3.1
1:2
12.0
1.3.2
1.3.3
1.4
Product Compatibility
The Integrator can be used with the following products:
It can use schematic data generated from any of the following authoring systems:
AVEVA Diagrams
Schematic data imported via AVEVA P&ID Manager or Schematic Model Manager.
Note: Screen shots may show either AVEVA Plant DESIGN or AVEVA Marine Outfitting.
Although there may be slight differences in form titles and display of coordinates, the
functionality described is common to both.
1:3
12.0
1:4
12.0
References
This chapter lists other documents that provide supporting or complementary information to
this guide.
AVEVA Product Minimum System Requirements describes product installation and
prerequisites.
Administrative users may need to refer to the following manuals:
AVEVA Schematic Viewer User Guide
AVEVA Diagrams User Guide
AVEVA P&ID Manager User Guide
AVEVA Schematic Model Manager User Guide
AVEVA Software Customisation User Guide
AVEVA Software Customisation Reference Manual
AVEVA.NET Customisation User Guide
AVEVA.NET Customisation Reference Manual
2:1
12.0
2:2
12.0
Getting Started
Getting started with the Integrator leads the inexperienced user through the steps to start
the Integrator and carry out the main tasks. It is not intended to train the user. Further
training can be supplied by AVEVA should the user require.
An AVEVA Plant or AVEVA Marine installation with some schematic data defined will be
required.
3.1
3.2
Figure 3:1.
3:1
12.0
3.3
Figure 3:2.
View on Diagram
If the object is shown on only one diagram, that diagram will be opened. If it is shown on
multiple diagrams, you will be presented with a list to select from.
If you already know which diagram you want, you can open it directly from a list. From the
Integrator main bar menu select View Diagram.
3:2
12.0
Figure 3:3.
View Diagram
The View Diagram dialogue allows you to browse for diagrams using the tree panel or
search for diagrams using the search controls.
Click on the Search button with blank text in the Search For field to get a list of all diagrams
available.
Select Diagram or Pages to see one entry per diagram or one entry per page.
Select By Diagram Name to perform a wildcard search using the name of the diagram.
Select By Content to perform a search using the name of an object such as schematic
equipment to find the diagrams it appears on.
The Diagram Viewer supports search using the following wildcards:
*
match a digit
[..]
3:3
12.0
The Diagram page number is not included in the matching and matching is not case
sensitive.
Select the required diagram or page. If the Preview option was checked, and either a page
was selected or a single page diagram was selected, then the diagram will be displayed in
the Preview panel. Use the pan and zoom functions to inspect the diagram. Click OK to
display the diagram in the Diagram Viewer.
3.4
Figure 3:4.
With the zoom-in or zoom-out cursor displayed, click with the left mouse button in the
diagram view. The view will be zoomed in or out centred on the position clicked. With the
pan cursor displayed, click in the view and drag the image in any direction. You can also pan
the image using the slider bars.
You can also drag out a zoom window by holding down the CTRL key and dragging out a
box with the left mouse button.
Figure 3:5.
3.5
Zoom Window
Build a 3D Object
To create a 3D object from its corresponding schematic object.
Select a schematic equipment in the table or diagram view, then click the right hand mouse
button and in the context sensitive menu select Build.
3:4
12.0
Hint: If the Build option is not activated, this is because the schematic equipment has not
been released for 3D in the schematic database. The releaseto3Dstatus attribute can be
set in AVEVA Diagrams or P&ID Manager. If set via syntax use RESTAT 1.
Figure 3:6.
Build Equipment
Figure 3:7.
Graphical View
Equipment built will be listed on the Equipment Details form. From this form you can
change the equipment specification and position, and set connection details.
3:5
12.0
Figure 3:8.
3.6
Figure 3:9.
Compare Equipment
A comparison report will be displayed and the diagram and graphical views will be coloured
to reflect the results of the compare.
3:6
12.0
The Compare Report shows detailed results and marks any discrepancies. The report can
be saved from the File menu or Save Button.
Figure 3:11.
Comparison Report
3:7
12.0
3.7
3:8
12.0
Integrator Controls
This chapter explains how to use each of the Integrator user interface controls. It explains
how to use the Main and Subtype Tables, the Schematic Viewer, and the Main Bar Menu
entries. In each case, the chapter shows how to invoke Integrator tasks from these user
interface components.
4.1
4.1.1
Subtype Table
To display the Subtype table select Main Table Menu > Subtype Table. The subtype table
displays objects owned by the selected object(s) in the main table, e.g. schematic nozzles in
a schematic equipment, or components in a pipeline.
Figure 4:1.
Subtype Table
4:1
12.0
4.1.2
Figure 4:2.
4.1.3
4:2
12.0
Figure 4:3.
4.1.4
Column Setup
Select Main Table Menu > Column Setup to display the table column setup form.
The Table Column Setup form lists the columns already defined for the main table. Select
the Add Column button to define a new column.
Figure 4:4.
4:3
12.0
Figure 4:5.
To add attributes of referenced objects, use a dot notation. For example, to see the
specification of a branch connected to a nozzle, use CREF.PSPE. You can chain together
several reference attributes, e.g. OWNER.DIAREF[2].NAME.
To add a single element of an array attribute, use square brackets. For example, multiple
pipes can be linked to a single schematic pipeline, so to see just the first of these, use
DESLNK[1]. To see the whole array, use the attribute without any array index, e.g.
DESLNK.
The table can apply simple calculations to numerical attributes using the operators * / + - for
the operations multiply, divide, add and subtract, e.g. NUMBER * 4. You can use
parentheses ( ) to nest the expression, e.g. (LENGTH + 3.5) * BORE. Array elements and
references cannot be used in mathematical expressions.
To delete one or more columns in the Table Column Setup form, select the columns to be
deleted and click on the Delete Selected Columns button.
How to List Schematic Objects Released but not Linked
The release to 3D status for a schematic object can be displayed in the Main Table using the
attribute RESTAT. The compare status can be displayed using the attribute CMPSTS. To
filter the Main Table on schematic objects that have been released but have not been linked,
filter on RESTAT equal to 1 and CMPSTS equal to 'Not linked'. For more details of
schematic to 3D links refer to Schematic to 3D Links.
4.1.5
4:4
12.0
Figure 4:6.
You can edit attribute data in the Main Table by selecting an appropriate Interaction Mode. In
Single Cell Edit, clicking on a cell places that cell in edit mode.
In Bulk Cell Edit, double clicking on a cell places that cell in edit mode. A single click on a
cell selects the cell itself, and standard Windows selection methods (left mouse click plus
Ctrl and Shift keys) select multiple groups of cells. A left mouse drag operation can also be
used to select multiple cells. In Bulk Cell Edit, Fill Down, Fill Up and Copy/Paste
operations apply to all cells currently selected.
Figure 4:7.
Read only cells are shown with grey background (or the selected colour if Feedback
Colours have been changed). Cells may be read only for a variety of reasons, including
data from a read only database, an object claimed by another user, or non-editable
attributes such as Owner or Type. In Bulk Cell Edit mode, Name is read only. Following an
edit, the results (success or failure) are displayed using cell colours and tooltips. These can
be cleared by selecting Reset Cell Feedback.
4.1.6
Refresh
Selecting Main Table Menu > Refresh refreshes all cell values from the database.
4:5
12.0
4.1.7
Export to Excel
The current table layout and content can be saved to an Excel file. Select Main Table Menu
> Export To Excel and enter a filename in the file browser dialogue.
4.1.8
Print Preview
You can view a print preview of the current table layout and content. Select Main Table
Menu > Print Preview.
4.1.9
Save Layout
Select Main Table Menu > Save Layout to save the current main table layout. If the current
layout has not yet been saved as a named layout, you will be prompted to enter a name in
the Save Layout As dialogue.
4.1.10
Save Layout As
Select Main Table Menu > Save Layout As to save the current main table layout as a
named layout for the current main type. You can save multiple named layouts for each main
object type. For example, you may choose to display different attribute and column filters for
pumps and vessels, and save them accordingly.
Enter a name for the layout in the Save Layout As form.
If you modify the table layout and do not save it, you will be prompted to save the layout
when you change main object type or when you exit the Integrator.
Integrator will automatically use your saved table layouts in the next session.
Other users will not see your saved layouts. An administrator can provide customised
layouts for all users in a project. This is described in How to Distribute Customised Table
Layouts in How to Customise the Integrator.
4.1.11
4:6
12.0
Figure 4:8.
4.2
4.2.1
Subtype Tables
Schematic Equipment
Schematic Nozzles
Schematic Subequipment
Schematic Electrical Connections
Offline Instruments
None
Pipelines
Pipeline Components
Inline Instruments
HVAC Lines
Schematic Cable
None
4:7
12.0
Main Table
Subtype Tables
Equipment
Nozzles
Subequipment
Electrical Connections
Pipes
Piping Components
Instruments
HVAC
HVAC Components
Instruments
Cable
4.2.2
None
Hide
To hide the Subtype Table select Subtype Table Menu > Hide.
Figure 4:9.
4.2.3
Column Setup
Select Subtype Table Menu > Column Setup. The procedure for changing the subtype
Column Setup is the same as changing the Main Table Column Setup. Refer to Column
Setup.
4.2.4
Settings
Select Subtype Table Menu > Settings to display the Settings submenu. Select any of the
settings to enable or disable that facility.
4:8
12.0
4.2.5
Export to Excel
The current table layout and content can be saved to an Excel file. Select Subtype Table
Menu > Export to Excel.
4.2.6
Print Preview
You can view a print preview of the current table layout and content. Select Subtype Table
Menu > Print Preview.
4.2.7
Save Layout
Select Subtype Table Menu > Save Layout to save the current subtype table layout. If the
current layout has not been saved as a named layout, you will be prompted to enter a name
in the Save Layout As dialogue.
4.2.8
Save Layout As
Select Subtype Table Menu > Save Layout As to save the current subtype table layout as
a named layout for the current main type. You can save multiple named layouts for each
subtype object type.
4.2.9
4.3
4.3.1
4:9
12.0
4.3.2
Build in 3D
Select Main Table Context Menu > Build then select OK when prompted to confirm.
The Build option will be available on schematic objects that are not linked to a 3D object.
When multiple objects are selected, the Build option will be available only if all the selected
objects are not linked to 3D objects.
For details of the Build operation see Integrator Functions in Detail.
Figure 4:11.
4:10
12.0
4.3.3
Link Objects
Select Main Table Context Menu > Link. Select an appropriate object from the list that
opens in a new window.
The Link option will be available on objects that are not already linked (the exceptions being
Schematic Pipelines and HVAClines that can be linked to one or many Pipes or HVACs
respectively, and so can always be linked). When multiple objects are selected, the Link
option will be available only if all the selected objects are not already linked (again, with the
exception of Schematic Pipelines).
For more details of the Link operation see Integrator Functions in Detail.
4.3.4
Unlink
Select Main Table Context Menu > Unlink to unlink all objects currently linked to the
selected object.
The Unlink option will be available on objects that are already linked. When multiple objects
are selected, the Unlink option will be available only if all the selected objects are already
linked.
For more details of the Unlink operation see Integrator Functions in Detail.
4:11
12.0
4.3.5
Compare
Select Main Table Context Menu > Compare.
The Compare option will be available on schematic objects, and also on 3D objects that are
linked to schematic objects. For more details of the Compare operation see Integrator
Functions in Detail.
4.3.6
4:12
12.0
4.3.7
4.3.8
4:13
12.0
4.3.9
View an Object in 3D
Select Main Table Context Menu > View > View in 3D.
If the selected object is a 3D object, it will be displayed in a 3D graphical view. If the selected
object is a schematic object linked to a 3D object, the linked 3D object will be displayed in a
3D graphical view.
The View in 3D option is available on any 3D object and on any schematic object that is
linked to a 3D object. When multiple 3D objects are selected it is available and applied all,
and when multiple schematic objects are selected it is available and applied to those that
are linked to a 3D object.
Note: If you cannot see the object just added to the 3D view, use the Window menu to pop
the Integrator 3D view to the front.
4.3.10
Connection Details
The Connection Details option will be available on a schematic equipment that is linked to
a 3D equipment, and on a 3D equipment that is linked to a schematic equipment.
Select Main Table Context Menu > Connection Details.
4:14
12.0
The Equipment Connections form lists the nozzles and electrical connection on the
schematic equipment, and the 3D equipment. The Link columns show which connections
are linked between the schematic and 3D model. The form lists piping and HVAC nozzles
and electrical connections. It also lists connections that are direct to the equipment objects
using the ECRFA and ELCXRF reference array attributes.
To change the specification reference of a nozzle, select the nozzle in the 3D Equipment
list, then click on the Modify Specification button. This will show either the Pipework
Nozzle Specification form or the HVAC Nozzle form, as appropriate. You can also create
new nozzles or electrical connections and delete existing ones using the buttons on this
form. After making any changes, use the Refresh Lists button to update the form.
To change which 3D connection is linked to a particular schematic connection, select the
schematic connection in the Schematic Equipment list, select the 3D connection in the 3D
Equipment list, then select the Set Link button. The selected connections will be linked.
If the schematic connection is already linked to another 3D connection, the following will
occur:
The link will be removed from that connection and set on the selected connection.
That connection will be unnamed and the name will be set on the selected connection.
If that connection was auto-built in the last Build action during this session, it will be
deleted.
4:15
12.0
4.3.11
Pick Connections
The Pick Connections option will be available on a schematic pipeline that is linked to a 3D
pipe, and has one or more schematic branches connected directly to a schematic
equipment (i.e. not via a schematic nozzle). It is also available on a 3D pipe that is linked to
a schematic pipeline that meets this criterion and similarly for HVAClines and 3D HVACs.
For the 3D connection between branch and equipment, a nozzle must be selected, but the
Integrator cannot determine which nozzle, since there is no schematic nozzle to link with.
The Pick Connections option enables the user to select or create a nozzle accordingly.
Select Main Table Context Menu > Pick Connections.
4:16
12.0
The Pick Connection form lists the 3D branches that have unresolved connections. When
a branch is selected in the Unresolved Branches list, Integrator does the following:
The Connection columns show which branches are connected to which nozzles.
To change the specification reference of a nozzle, select the nozzle in the Connections list,
then click on the Modify Specification button. This will show either the Pipework Nozzle
Specification form or the HVAC Nozzle form, as appropriate. You can also create new
nozzles and delete existing ones using the buttons on this form. After making any changes,
use the Refresh Lists button to update the form.
To change which unresolved branch is connected to which nozzle, select the branch in the
Unresolved Branches list, select the nozzle in the Connections list, then select the Set
Connection button. The selected branch will be connected to the selected nozzle.
4.4
4.4.1
4:17
12.0
4.5
4.5.1
View on Diagram
Select Design Explorer Context Menu > View on Diagram.
If the selected object appears on a single diagram, that diagram will be displayed. If the
selected object appears on multiple diagrams, select which diagram to view from the list that
is shown.
The View on Diagram option is available on any schematic object that appears on a
diagram and on any 3D object that is linked to a schematic object that appears on a
diagram. It is available only if a single object is selected.
4.5.2
4.5.3
4:18
12.0
4.6
4.6.1
4.6.2
4.6.3
4.6.4
4.6.5
Zoom Out
4:19
12.0
Always Zoom to the Table Selection - toggles the mode for auto-zoom
Remove Bookmark
4.6.6
4:20
12.0
The Build, Link, Unlink, Compare, Connection Details, and Pick Connections options
work in the same manner as the equivalent options for the Main Table Context Menu.
The View on Other Diagram option will be active if the selected object is available on more
than one diagram.
4.6.7
4.6.8
Viewer Settings
The Viewer Settings form controls various aspects of the Diagram Viewer.
4:21
12.0
The top section allows you to change the selection and mouseOver colours for the Diagram
Viewer. You may need to change these from the defaults if the diagram is already coloured
such that highlighting and selection are not clear. To change a colour, click on the colour box
and choose another colour from the palette.
The middle sections allow you to control where the diagram tabs appear, the number of
recent diagrams that will be remembered, and the number of tabs that can be displayed
simultaneously.
The Set CE from diagram option controls whether the current element will track the object
you click on in the diagram viewer.
These settings are per user and project and will be saved automatically between sessions.
4.7
4.7.1
4.7.2
Display
Select Integrator Bar Menu > Display > Main Table, Subtype Table or Diagram Viewer
to show or hide these components. Select Project Configuration Explorer to show this
component which is used to define configuration rules, described in detail in How to
Configure Build Rules.
4:22
12.0
4.7.3
4.7.4
4.7.5
4.7.6
4:23
12.0
4.7.7
4.7.8
Comparison Category
Select Bar Menu > Comparison Category to choose one of the available Comparison
Categories (see Comparison Category Settings). Selecting Default means that all
differences will be reported. When a Comparison Category is selected, its name is included
in the title of the Main Table and the Comparison Report.
4.7.9
View
The View options work in the same manner as the equivalent options for the Main Table
Context Options.
4:24
12.0
4.7.10
4.7.11
4.7.12
Diagram Viewer
The Diagram Viewer options provide an equivalent set of functions to the Diagram Viewer
Toolbar.
4.7.13
Comparison Options
Select Bar Menu > Settings > Comparison Options to display this form. It allows you to
set whether the Compare report will include warnings where elements are unpositioned.
This settings is per user and project and will be saved automatically between sessions.
4.7.14
4:25
12.0
The Comparison Category settings allow you to specify which categories of differences will
be reported against which types of objects. You cannot switch off the reporting of nonmatched main type objects such as pipelines and equipment. The Key Attributes column
applies when matching by key attributes according to the configuration rules, and the Key
Attributes text panel lists attributes included in such rules. The Spec Attributes column
applies to all specification attributes including PSPE, SPRE and CATR.
To create a new Comparison Category, ensure New is selected in the drop down list, check
the options required, then click on Save or click on OK. You will be prompted to enter a
name for the Comparison Category. If an existing Comparison Category is selected, you will
be prompted to overwrite it.
Note: This will not set the Comparison Category to be used - that is done from the Main
Bar Menu > Comparison Categories sub-menu selection.
4.8
4:26
12.0
4.8.1
Open All Referenced Opens all diagrams relating to the report content. Each diagram
Schematics
will open in a separate tab in the Diagram Viewer.
Properties
Redo Compare
Open
4:27
12.0
4.8.2
Save As
Opens a file browser dialogue which allows the user to save the
report as an XML dataset or as an HTML file using a stylesheet.
Stylesheets (files with extension .xsl) should be placed in the
%<proj>dflts%\modelmanagement folder.
Close
Copy All to 3D
Link all unambiguously matched objects (note this function will not
link matched objects if they have an In Wrong Location or a
Sequence Difference error)
Find CE in Report
Focus the report on the current element (if it appears in the report)
4:28
12.0
4.8.3
Refresh Schematic & 3D Views Re-apply the compare rules colours to the Diagram
View and 3D View.
Set Limits
Highlight on Diagram
Zoom to Diagram Selection
Navigate to Schematic Element
Highlight in 3D View
Zoom to 3D Selection
Navigate to 3D Element
Show Equipment Translucent
Go To
4:29
linking
(see
12.0
4.8.4
Refresh
Report Toolbar
The buttons in the Report toolbar have the following functions and are equivalent to the
View menu options.
Back
Forward
Save As
Refresh Schematic & 3D Views
Set Limits
Open All Referenced Diagrams
Significant Elements Only
Differences and Errors Only
4.8.5
The buttons in the Data panel toolbar have the following functions to control the attributes
displayed.
Differences and Errors Only
Attributes Common to 2D & 3D
Categorised
Categorised (Extended)
4:30
12.0
Alphabetic
Copy to 3D
Copy All to 3D
Refresh
4.8.6
Navigate
Sets the object in the right click menu as the current element.
Unlink
Build
Builds a missing object in 3D. Only available when the object has
not been linked or matched.
Link
Link an object to its match. Only available when the object has
been matched but not linked.
Connections
Select this object for linking - its name will be displayed in the
report status bar
Link <named
objects>
Link matched
elements <names>
Copy to 3D
Refresh
4:31
12.0
4.8.7
4.8.8
4:32
12.0
5.1
Concepts
Integrator provides three main functions that can be applied to data:
5.1.1
Build
Link
Compare
Build
Integrator can create 3D data directly from the schematic data, enabling equipment,
pipeline, HVAC and cable objects to be built automatically in 3D, populated with data from
the schematic model. This means for example that an equipment list and line list can be
propagated to the 3D model along with all their key process data, tags and interconnections.
Thus when schematic data is available, Integrator can provide an initial population of
corresponding objects in the 3D model. As updates occur in the schematic data, these can
be applied to the 3D data in a controlled process. Each project can control precisely which
data is transferred from schematic to 3D, what types of object are created, and which
attributes are set, using easily configured rules.
When Integrator builds an object in the 3D model, that object is automatically linked with its
corresponding schematic object.
5:1
12.0
5.1.2
5.1.3
Compare
Integrator uses configuration rules to compare schematic and 3D objects, to verify if they
are aligned or to report any discrepancies. The comparison covers connectivity, component
sequence, and attributes data.
Connections within the 3D model should be consistent with connections within the
schematic model. This includes connection onto equipment - nozzles and electrical
connections, and connections within pipework or HVAC - head and tail references,
connection references and connection reference arrays.
Component sequence should be logically consistent between the schematic and 3D model.
Integrator will report when components such as instruments, valves, tees and reducers, are
missing or are in a different order.
Integrator will also report any missing or mismatched attribute data, using the configuration
rules to identify which attributes it should check and how they should be compared. For
example, a name may be composed from schematic attributes such as prefix, suffix and
function, and bore and specification reference must match.
Comparison Categories provide a level of control over which categories of difference are
reported against which types of objects. For example, you may choose to focus on
unmatched objects and differences in specification attributes, and to ignore other attribute
differences.
Integrator can use the results of a comparison to automatically link schematic and 3D
objects that it has found to match. It can also automatically update attributes from schematic
to 3D where it finds a difference in the data for matching or linked objects.
5.1.4
5:2
12.0
Figure 5:1.
5.1.5
Schematic Database
Schematic to 3D Links
Integrator maintains its links as separate CYMLNK objects against which it can hold
important information. Each CYMLNK object has attributes deslnk referencing the 3D
model object, and schlnk referencing the schematic object. The CYMLNK object also holds
a cmpstatus attribute to record its compare state. The 3D model and the schematic objects
both have a cmplnk attribute referencing the CYMLNK object.
The CYMLNK objects are nested to reflect the hierarchy of corresponding objects, e.g.
schematic equipment owning schematic nozzles. They are grouped in CYMGRP objects
and exist in a single parent CYMWRL object.
Figure 5:2.
Link Schema
Pseudo Attributes
To simplify navigation between corresponding schematic and 3D objects, Integrator
provides the pseudo attributes schlnk and deslnk directly between these two objects. The
pseudo attribute cmpsts returns the compare status description on the CYMLNK object or
5:3
12.0
on any linked schematic or design object, or on its linked ancestor. It is included by default in
the Integrator Main Table.
Figure 5:3.
Cardinality
For most objects, zero or one schematic objects can be linked to zero or one 3D objects.
The exceptions are schematic pipelines which can link to zero, one or many pipes, and
schematic HVAC lines which can link to zero, one or many HVACs.
5.1.6
5.1.7
Release to 3D Status
Schematic objects have a Releaseto3dstatus attribute which should be set in the diagram
authoring system. For example, AVEVA Diagrams provides a dialogue to set this attribute. If
the AVEVA Diagrams user then tries to modify a released object, they are prompted to
confirm they do want to change it. If they do change it, the release status is unset P&ID
Manager provides options to manage the release status of imported schematic data.
The syntax for the Releaseto3dstatus attribute in the Main Table column setup is RESTAT.
When set it has the value 1. It can be set from the command line with RESTAT 1.
Integrator does not allow schematic objects to be built or linked unless they have been
released to 3D.
5.1.8
5.1.9
5:4
12.0
configuration rules. Objects that have all their values for their key attributes matching the
values generated by the rules will be shown as matching in the compare report.
When key attribute matching is used for a particular type, e.g. pipes, objects of that type will
not be included in the report if they do not match on all of their key attributes.
5.1.10
5.1.11
5.2
5.2.1
Building Equipment
When the Integrator builds equipment in 3D the following actions are carried out.
The names of an appropriate SITE and ZONE are determined from the rules. The SITE
and ZONE are created if they do not already exist. If there is no rule to define the SITE
or ZONE, Integrator will use the current element, its owner, or the first SITE and ZONE
after the current element.
EQUIpment is created in the appropriate ZONE and named in accordance with the
rules. The name in 3D can be a duplicate of the name on the diagram. Alternatively, a
rule may be used to construct a name from attributes such as DISTAG (display tag).
5:5
12.0
NOZZles are created for each schematic nozzle (see below how Integrator deals with
nozzles already defined in an equipment template).
If a specification reference has been set on the schematic equipment it will be copied to
the EQUIpment and the equipment template will be instantiated so that it has a
population of primitives. The user has an opportunity to modify the equipment
specification later in the build process.
If the schematic equipment does not have a specification reference but it does have a
description, Integrator will collect all the SPCOms and TABITEms from the equipment
specifications and selection tables, and look for a match against the descriptions of
their owners. If there is a single match this will be set as the specification reference on
the 3D equipment.
Nozzle and electrical connection references are set in accordance with the schematic
connectivity if the connecting objects exist in 3D.
If a position has been set on the schematic equipment it will be copied to the
EQUIpment. The user has an opportunity to modify the equipment position later in the
build process.
Attribute values can be set on the EQUIpment, based on attribute values on the
schematic equipment, in accordance with the rules.
Although Integrator always creates a nozzle to link to a schematic nozzle, there may
already be a nozzle defined in an equipment template that is appropriate for that
schematic nozzle. Integrator will check for nozzles with matching bores within a
template. If a match is found, the schematic nozzle will be linked to that particular
nozzle within the template, and the auto-built nozzle will be deleted. Any attribute data,
including the nozzle name, that were set on the auto-built nozzle in accordance with
the rules, will be copied over to the selected nozzle in the template.
The user has the opportunity to modify nozzle details. including changing or swapping
the links between nozzles and schematic nozzles. If a link is moved from an auto-built
nozzle in the same session that the nozzle was built, the auto-built nozzle will be
deleted. The user can also modify the specification of the NOZZles.
Some changes to schematic equipment can be propagated to 3D from the Compare Report
form. Refer to How Integrator Compares Schematic and 3D Data.
5.2.2
Building Pipework
When the Integrator builds pipework in 3D the following actions are carried out.
The names of an appropriate SITE and ZONE are determined from the rules. The SITE
and ZONE are created if they do not already exist.
A PIPE is created in the appropriate ZONE and named in accordance with the rules.
Typically the name will be generated from a number of schematic pipeline attribute
values and can include a sequential number.
Piping components are created equivalent to schematic piping instruments, valves and
fittings. Rules determine the component type. Components (including valves and
instruments) can be named if rules are defined for this.
Component specification references are copied from the schematic components where
available.
5:6
12.0
If a specification reference has not been set on the schematic component, Integrator
will try to choose the 3D component from a pipe specification using available data.
Integrator will determine the appropriate specification, generic type and bore(s). Other
selectors such as STYPE can be set by the rules. If Integrator has insufficient data to
make a single choice, it will prompt the user with the selection it is trying to make and
display the Choose form for the user to make the choice.
Note: If the Subtype Table is displayed, Integrator will select the component in the subtype
table and zoom the diagram to the same component, to help you choose the
appropriate component.
Attribute values can be set on the 3D pipes and components, based on attribute values
on the schematic pipelines and components, in accordance with the rules.
The user has the opportunity to resolve connections where the schematic connection is
directly to schematic equipment. In 3D the connection must be to a nozzle or electrical
connection. When resolving connections the user can select an existing nozzle or
electrical connection or create a new connection.
5.2.3
Building HVAC
Integrator builds HVAC in 3D using a process that is equivalent to that for creating pipework,
but based on schematic HVAC lines, and with its own family of rules.
Integrator uses a look-up table of information relating to the standard AVEVA HVAC
component specification. This data is read from the file HVACStypeTable.xml which is
included in the pdms or marine executables folder. Integrator will look for this file first in the
%<proj>dflts%\modelmanagement folder and then in the pdmsexe folder. This file can be
modified to suit company or project requirements.
Integrator can build and compare HVAC data provided that the schematic data is consistent
with the standard AVEVA HVAC application catalogue. This means that any HVAC fittings
defined on a diagram must conform to the equivalent 3D HVAC fittings that can be created
from the standard AVEVA 3D HVAC specification.
5:7
12.0
generic type
SCSTYP
specific type
CONARRAY
WIDARRAY
HEIARRAY
In order for Integrator to be able to build and compare a 3D HVAC component, the
combination of this information from the SCHVFI must correspond to a component in the
standard catalogue. In particular, if there is a branch connection point, it should be P3, with
ARRIVE and LEAVE as P1 and P2 (or P2 and P1) respectively.
An example of a component that would not meet this criteria would be a rectangular, threeway fitting with a different duct height on P3. In the standard catalogue, duct height (the
depth of the fitting) is equal across the three connection points.
For each GTYP there are one or more available SCSTYPs. To set an appropriate SCSTYP
in AVEVA Diagrams in HVAC mode, navigate to the SCHVFI by selecting it in the diagram or
schematic explorer, click on HVAC > Set SCSTYP, select an SCSTYP from the list and click
Apply.
Integrator can build user defined HVAC fittings provided that the SPREF is set on the
SCHVFI. A configuration rule should be defined in Integrator for SCHVFI elements, to copy
the SPREF if it is set on the source element.
5.2.4
Building Cable
When Integrator builds Cable in 3D the following actions are carried out.
The names of an appropriate SITE and ZONE are determined from the rules.
A CABLE is created in the appropriate ZONE and named in accordance with the rules.
Start and End references are set in accordance with schematic connectivity if the
connecting objects exist in 3D. Connections can be direct to equipment using the
ELCXRF attribute or to ELCONNs.
Integrator does not create CORE objects below 3D cables, even if the schematic cable
owns schematic cores. If needed, schematic core data can be referenced from 3D via the
owning cable's SCHLNK attribute.
Integrator builds the individual cables for a Schematic Multi-Cable (SCMCAB). There is no
3D equivalent of SCMCAB.
5.2.5
5:8
12.0
5.3
5.3.1
Red for components present in one view but missing from the other view
Figure 5:4.
Integrator has created a separate 3D view for the compare results. This view has its own
drawlist so that results of the colour coding do not affect any other views that the user may
have defined.
Note: If you cannot see the Integrator 3D View, use the Window menu to pop it to the front.
5.3.2
5:9
12.0
Figure 5:5.
Selecting the owning segment displays its detailed compare results in the Data panel.
The source and destination connections are listed (note that the schematic pipe
segment has a connection direct to a schematic equipment, but the pipe branch
connects to a nozzle).
Figure 5:6.
5:10
12.0
Figure 5:7.
Note: The missing valve marked as Not Matched, and has no values in 3D.
5.3.3
Figure 5:8.
Selecting Build in the valve's context menu shows a form listing the components already
present in the 3D branch. The user must now select the position in the sequence for the
valve to be created by dragging the highlighted NEW VALVE line up or down, using the left
mouse button, and then select the OK button.
5:11
12.0
Figure 5:9.
5.3.4
To update the value, first select the row with a left mouse click in the Data panel then right
click in the row and select Copy to 3D.
5:12
12.0
Figure 5:11.
Alternatively, select the correct value from the dropdown menu provided.
If the update has been completed, the field will turn cyan.
5.3.5
5:13
12.0
5.3.6
5.3.7
If an object exists on the diagram but is missing in 3D, it will be shown in red on the
diagram, and vice versa.
In the case of a piping component missing, the line segment it is missing from will be
shown in yellow.
An ambiguous object, e.g. a valve matched in two places, will be shown in red.
An object with the wrong owner, e.g. a nozzle on the wrong equipment, will be shown in
orange.
5:14
12.0
5.3.8
5:15
12.0
Integrator will work through the report content prompting to link matched objects.
You can choose to link or skip individual objects, or click Yes to All to automatically link all
matches. On completion, the report will indicate newly linked objects in cyan and any failed
or skipped links in red.
5:16
12.0
5.3.9
Integrator will work through the report content updating any attribute differences on linked or
matched objects. On completion, the report will indicate newly updated objects in cyan and
any failed or skipped updates in red.
5:17
12.0
5.4
5:18
12.0
6.1
%SAMDFLTS%\ModelManagement\ProjectConfiguration.xml
6.2
6.2.1
Figure 6:1.
6:1
12.0
6.2.2
Figure 6:2.
An Empty Configuration file will provide some simple default settings but will contain
no rules for building and comparing objects.
To open an existing configuration file select the ProjectConfiguration.xml file in the Open
File dialogue. By default this dialogue will open in the appropriate folder, defined as the
ModelManagement folder under the folder indicated by the project defaults environment
variable, e.g. for the TTP project:
%ttpdflts%\ModelManagement\ProjectConfiguration.xml
Integrator always uses this folder and file combination to read its configuration settings. You
can save the settings in another file, but if you want those settings to be used, you must
copy that file back to the default name and location.
Note: If you have moved away from the default folder, use the project defaults environment
variable to get quickly to the appropriate folder. For example, in the Open File
dialogue, for the TTP project, enter %ttpdflts%\ModelManagement in the
Filename field.
6:2
12.0
Figure 6:3.
6.2.3
Figure 6:4.
6.2.4
6:3
12.0
6.2.5
6.3
6.3.1
Figure 6:5.
6.4
Figure 6:6.
6:4
12.0
6.4.1
Figure 6:7.
6.4.2
6.5
6.5.1
Project Defaults
Project Defaults have a name and a single setting. If any are omitted the standard default
values described below will be used.
6:5
12.0
Figure 6:8.
Project Defaults
Real Tolerance
This is the value that will be used to compare real number attributes. Two attribute values
within this tolerance will be deemed to be equal. If no Real Tolerance value is specified the
built-in default is 0.00001.
Distance Tolerance
This is the value that will be used to compare distance attributes. Two attribute values within
this tolerance are deemed to be equal. If no Distance Tolerance value is specified the builtin default is 0.01.
Distance and Bore Units
These determine which units will be used for distance and bore values embedded within
rules. The options are mm or inch.
Can Create Site
This determines whether a SITE may be automatically created during Build operations if no
suitable SITE already exists (as specified by the project build rules). The built-in default
setting is false.
Can Create Zone
This determines whether a ZONE may be automatically created during Build operations if
no suitable ZONE already exists (as specified by the project build rules). The built-in default
setting is false.
Compare Flanges, Couplings and Unions
By default, flanges, couplings and unions are treated as insignificant for compare. If the
diagrams show these items then they can be set true so that they will be treated as
significant for compare.
6:6
12.0
6.5.2
Dictionaries
Dictionaries may be used with the rules to define value strings against given keys. For
example the key might be the setting of an attribute, and the associated value might be
needed to perform correct build or comparison operations. In the example below a
Dictionary has been created for Disciplines.
Figure 6:9.
Discipline Dictionary
Format('/{0}-{1:D2}-EQUIP', Lookup('Discipline',
FUNC of source), AREA of target)
6.5.3
Spec Queries
Spec Queries list the selectors from pipe specifications that can be used in Selector Rules
elsewhere in the configuration file. The example here shows a single query for STYP as
provided in the out-of-the-box configuration file. Any selector used in the file must be
included in the Spec Queries section, so that it can be recognised as allowable syntax by
Intellisense. If Integrator reports syntax errors in the configuration file, it may be that there
are Selector rules defined using selectors that have not been entered in the Spec Queries
section.
Use the right click menu in the right hand panel to insert individual queries, or to insert spec
queries from catalogue. This latter option will generate a list of all the selectors used in pipe
specifications in the project, and is intended as an occasional activity for project
administrators. Selectors are project specific although some such as STYP are very
common. Note that you do not need to insert PBOR selectors (PBOR0, PBOR1, PBOR2,
etc.) as Integrator uses PBOR selectors automatically when needed.
6:7
12.0
6.5.4
Compare Colours
This Compare Colours settings determine how different conditions will be displayed in the
diagram and 3D views following a Compare action. One of the colours is also used as the
Integrator highlight colour in the 3D view.
6:8
12.0
Figure 6:11.
Compare Colours
Each Compare State can have a Compare Colour. To change the colour for that state,
click on the colour box to the right of the state and select a colour from the browser.
The Compare States have the following meanings:
Undefined
The object has not been compared and so its compare state does
not have a value
Information
OK
Check Required
Warning
6:9
12.0
6.5.5
Minor Error
Sequential
Difference
Member Attribute
Difference
Attribute Difference
Critical Error
Connection Error
Item Missing
Not Matched
In Wrong Location
Ambiguous Matches
Error
Not Compared
Highlight
Rules
Most of the configuration activity will be concerned with the Build and Compare rules. Rules
are organised in RuleGroups and use expression syntax as described below.
Rule Types
Build and Compare rules have two basic types.
Create rules are used to create new 3D objects during Build, and to check the existence
and type of a matching object during Compare.
Assign rules are used to assign a value to an attribute during Build, and to check the setting
of an attribute on the 3D object during Compare. An Assign rule should always be preceded
by a Create rule in the same block.
6:10
12.0
Rule Groups
Create and Assign rules are normally grouped within a Rule Group, containing a logical
condition that determines when the rules of the Rule Group should be applied. Rule
Groups may be nested, in which case the inner rules are only applied if all of the conditions
of the owning Rule Groups are met.
Rule Groups can optionally have a name and condition. The Rule Group may contain
Create or Assign rules and nested Rule Groups. The rules within the Rule Group are only
applied if the given condition is met. The rules within nested Rule Groups are only applied if
all conditions of the owning Rule Groups are met.
The Rule Group name is an alphanumeric string to identify the Rule Group. It is optional
and no check is made that names are unique.
The Rule Group condition is a Boolean expression that is evaluated during Build and
Compare operations. At any point during the Build or Compare operation there is one
schematic object under consideration. This object is referred to as the source. The
corresponding design object (if there is one) is referred to as the target. During Compare
operations the target will be an actual corresponding 3D object. During Build operations the
target represents a "candidate" for a 3D object still to be created.
In both case the source and target elements can be referred to in the Rule Group
condition. These can be used to refer to attributes or UDAs on the source or target using
the "OF" syntax. For example, NAME of source refers to the NAME attribute of the
source schematic object. User defined attributes can be used in the same way, for example,
:MYATT of source.
An extended notation allows access to attributes on related elements - owner, previous,
next, for example, AREA of OWNER of OWNER of target.
Attribute values can be combined and compared using the full power of the expression
syntax described in detail below.
Create Rules
Create rules have a type expression that defines the 3D object type that is to be created
(during Build operations), or that is needed to match (during Compare operations). During
Build operations the object will be created at the appropriate level in the database hierarchy.
The type expression must evaluate to a legal 3D database object type. This can be an
explicit word, e.g. EQUI, or a more complex expression calculated from schematic attribute
settings. As in the Rule Group condition, the current source schematic object is referred to
as source and its attributes are identified using the "OF" syntax, for example, GTYP of
source. More powerful expressions can be created using the syntax described below.
In the situation where more than one 3D object type can be acceptable for comparison
purposes, the Create type expression uses the special Variant function. This defines a list
of all acceptable matching types, for example, Variant (TEE, OLET, FLAN). Each
argument of the Variant function is an expression as defined above. When building, the first
type listed in the Variant function will be used.
When the 3D object being created is to be selected from a specification, the questions and
answers that inform the selection process are listed in Selector rules owned by the Create
rule. Each Selector rule has a Question, e.g. STYP, and a value based on a schematic
attribute, e.g. SCSTYP of source.
6:11
12.0
Intellisense Feedback
The Configuration Explorer provides Intellisense feedback to assist with finding the
appropriate entry as you edit a rule. Full syntax available can be displayed at the start of an
entry by pressing the Alt and right arrow keys together. If a letter is entered, the available
words starting with that letter will be displayed.
The user selects a word by double clicking on that line in the drop down list.
6.5.6
Expression Syntax
This section explains the expression syntax available in the Configuration Explorer when
defining rules.
Operators
Arithmetic expressions can be built using the usual conventions:
Operators eq, ne, lt, le, gt, ge, test for equality, inequality, less than, less than or
equals, greater than, greater than or equals, and apply to a pair of numerical
expressions or a pair of alphanumeric expressions or a pair of Boolean expressions.
(The result will be unpredictable if expressions of different type are compared.)
Operators and and or test for Boolean "and" and Boolean "or" between two Boolean
expressions.
Operator not is used to negate the Boolean expression that follows it.
6:12
12.0
Attributes
Attributes can generally be included in rules using the of syntax, e.g. NAME of source, but
the dot notation can also be used, e.g. source.NAME. The dot notation is useful for array
attributes, e.g. source.BOREAR[3] < 100.
Functions
The following functions are available (minimum abbreviation shown in bold):
double Sine (double angle)
// angle in degrees
// angle in degrees
// angle in degrees
// result in degrees
// result in degrees
// square root
// base 10 logarithm
// natural logarithm
// base 10 antilogarithm
// natural antilogarithm
// absolute value
// rounded up
// nearest integer
// minimum value
// maximum value
// number of characters
string Substring (string text, integer start [, // substring from the start position of given
integer length])
length (or to end of text)
string Left (string text, integer length)
6:13
12.0
string Lookup (string dictName, string key) // return the value associated with the key in
the given Dictionary
(see Dictionaries section)
boolean Like (string pattern, string text)
Integer Listposition
6:14
12.0
This example generates a name from the values of three attributes on the source object.
The first two values are straightforward substitutions. The third value is substituted as a
decimal value with a minimum of 3 digits, padded with leading zeros if necessary.
6.5.7
The condition here restricts this Rule Group to be applied only where the source type is
SCEQUI. Here is the condition:
There are several Assign Actions. This one assigns a value to the attribute POS on the
target object, taking that value from the POS attribute of the source object. The Build
Action is set and the Compare Action is ignore. These options and their alternatives are
described in more detail below.
6:15
12.0
The Assign Action has several properties. Name, Variants Count, Attribute Name and
Attribute Value have been described above and the others are described here.
Assignee is the object that has the attribute whose value is being set or compared.
Allowable entries are:
owner - the owing ZONE in 3D, described below in the example for NAME
root - the owning SITE in 3D, described below in the example for NAME
Build Action is the action carried out during a Build operation. Allowable entries are:
Compare Action is the action carried out during a Compare operation. Allowable
entries are:
match - the value of the attribute must match the value generated by the rule
matchorexceed - the value of the attribute must be equal to or greater than the
value generated by the rule
6:16
12.0
matchornotexceed - the value of the attribute must be equal to or less than the
value generated by the rule
critical error - the mismatch will be reported as a critical error, indicated by a red
blob icon in the compare report
error - the mismatch will be reported as an error, indicated by a red dot icon in the
compare report
Mismatch Report is an optional text that will be output as a line in the compare report
following the line on which the mismatch itself is reported.
Another Assign Action sets the attribute NAME. This example has an expression that
makes use of the format function to append the value of the display tag attribute to a slash
character. Names in the design database can be duplicates of names in the schematic
database, and so to use the same name for equipment in 3D as on the diagram, set the
Attribute Value to NAME of source.
6:17
12.0
In the same block there are two further Assign Actions for NAME. The first of these has
Assignee set to owner and contains an expression to define the name of the ZONE.
The second has Assignee set to root and contains an expression to define the name of the
SITE.
6.5.8
6:18
12.0
This Rule Group has a number of nested Rule Groups. The first has a Condition that
applies when the source object has a valid SPRE, denoted by being not equal to Nulref.
One of the accompanying Assign Actions copies the attribute SPRE from the source
object.
6:19
12.0
The second nested Rule Group has a Condition that applies it when the source object
does not have a valid SPRE, denoted by being equal to Nulref.
6:20
12.0
The Create Action has a Selector which will be used during a Build operation to select the
object from the pipe specification. It will also be compared with a severity level of warning.
Each Selector has a Question and Answer. This Selector takes the STYPE from the
source objects SCSTYP attribute.
The next Rule Group has a condition that tests for a Check Valve using the SCSTYP
attribute of the SCVALV.
6:21
12.0
This is accompanied by a Report Action that will output an error message in the Compare
report if the flow direction is reversed.
6:22
12.0
7.1
!!integratorInit()
7.2
!!integrator.build(!Name is STRING)
!!integrator.build(!Names is ARRAY)
!!integrator.compare(!Name is STRING)
!!integrator.compare(!Names is ARRAY)
!!integrator.link(!Name1 is STRING, !Name2 is STRING)
!!integrator.unlink(!Name is STRING)
!!integrator.unlink(!Names is ARRAY)
By default the Compare Report is generated to the screen. In order to send the report direct
to file the following two lines are needed to suppress the output to screen and set the
pathname:
!!integrator.setreportvisible(false)
!!integrator.setreportpath('c:\reports\rep.xml')
If the pathname of the report file has been specified as shown above, then the report can be
viewed in the Compare form using the following command (note that this command cannot
be used in non-graphics mode).
!!integrator.openreport()
7:1
12.0
Access to the current setting for the option "Report unpositioned elements" is provided by
the following two methods:
!!integrator.getReportCheckPosition()
!!integrator.setReportCheckPosition(!Flag is BOOLEAN)
The following methods have been provided to set flags to auto-link matched objects and
auto-update attributes:
!!integrator.setCompareAutoLinkMatches(!Flag is BOOLEAN)
!!integrator.setCompareAutoUpdateAttributes(!Flag is BOOLEAN)
If these are set true then the next use of the compare method will perform these functions.
The following method has been provided to select a Comparison Category:
!!integrator.setComparisonCategory(!ComparisonCategory is
STRING)
7.3
7:2
12.0
!comlist.append(!element.ref.string())
enddo
7:3
12.0
7:4
12.0
8.1
BeginBuildCallback
This method is called once prior to any other actions during the Build process.
PreCreateCallback
This method is called prior to the creation of each object in 3D during the Build process
PostCreateCallback
This method is called after the creation of each object in 3D during the Build process
EndBuildCallback
This method is called once after any other actions during the Build process.
BeginCompareCallback
This method is called once prior to any other actions during the Build process.
EndCompareCallback
This method is called once after any other actions during the Build process.
The arguments for each method are specified in the supplied PML.
Each place where customised code can be added is delimited as follows.
--================================================
-- Start of customisation
8:1
12.0
-- End of customisation
--================================================
Other methods on the IntegratorProjectHandler object should not be modified.
8.2
%SAMDFLTS%\ModelManagement\
Saved table layouts are checked only at the start of a user's session. An updated set of
layouts copied to the project folder will not be seen by users until their next session.
If a user creates a layout with the same name as a project layout, then the user's layout will
be used.
8.3
8:2
12.0
Index
Numerics
2D Table . . . . . . . . . . . . . . . . . . . . . . . . 4:18
3D Data . . . . . . . . . . . . . . . . . . . . . . 5:5, 5:9
3D Links . . . . . . . . . . . . . . . . . . . . . . . . . 5:3
3D Objects . . . . . . . . . . . . . . . . . . . . . . 5:18
3D Status . . . . . . . . . . . . . . . . . . . . . . . . 5:4
3D Table . . . . . . . . . . . . . . . . . . . . . . . . 4:18
3D View . . . . . . . . . . . . . . . . . . . . . . . . . . 5:9
Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:8
Cardinality . . . . . . . . . . . . . . . . . . . . . . . 5:4
Ceil . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:13
Colour Coded . . . . . . . . . . . . . . . . . . . . . 5:9
Colour Codes . . . . . . . . . . . . . . . . . . . . 5:14
Column Setup . . . . . . . . . . . . . . . . . 4:3, 4:8
Command Line . . . . . . . . . . . . . . . . . . . . 7:1
Compare 3:6, 4:12, 4:17, 4:23, 4:31, 5:1, 5:2,
5:9, 6:8
Compare Colour . . . . . . . . . . . . . . . . . . . 6:9
Compare Colours . . . . . . . . . . . . . . . . . . 6:8
Compare Report 4:24, 4:26, 5:9, 5:11, 5:12,
5:13
Compare State . . . . . . . . . . . . . . . . . . . . 6:9
Compatibility . . . . . . . . . . . . . . . . . . . . . . 1:3
Concepts . . . . . . . . . . . . . . . . . . . . . . . . 5:1
Configuration . . . . . . . . . . . . . . . . . . 6:4, 6:5
Configuration File . . . . . . . . . . . . . . . . . . 6:1
Connection . . . . . . . . . . . . . . . . . . . . . . 4:14
Cos . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:13
Create . . . . . . . . . . . . . . . . . . . . . . . . . 6:11
Create Site . . . . . . . . . . . . . . . . . . . . . . . 6:6
Create Zone . . . . . . . . . . . . . . . . . . . . . . 6:6
Current Element . . . . . . . . . . . . . . . . . . 4:13
Customise . . . . . . . . . . . . . . . . . . . . . . . 8:1
CYMWRL . . . . . . . . . . . . . . . . . . . . . . . . 5:4
A
Abs . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:13
Acos . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:13
After . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:14
Alog . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:13
Alog10 . . . . . . . . . . . . . . . . . . . . . . . . . . 6:13
ARRIVE . . . . . . . . . . . . . . . . . . . . . . . . . 6:22
Asbool . . . . . . . . . . . . . . . . . . . . . . . . . . 6:13
Asreal . . . . . . . . . . . . . . . . . . . . . . . . . . 6:13
Assign Action . . . . . . . . . . . . . . . 6:16, 6:17
Assign Actions . . . . . . . . . . . . . . 6:18, 6:19
Asst . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:13
Atan . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:13
Atant . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:13
Attribute Value . . . . . . . . . . . . . . . . . . . 5:12
B
Bar Menu . . . . . . . . . . . . . . . . . . . . . . . 4:22
Before . . . . . . . . . . . . . . . . . . . . . . . . . . 6:14
Between . . . . . . . . . . . . . . . . . . . . . . . . 6:14
Build . . . . . . . . . . . . . . . 3:4, 4:17, 4:23, 5:1
Build in 3D . . . . . . . . . . . . . . . . . . . . . . . 4:10
Build Rules . . . . . . . . . . . . . . . . . . . . . . . 6:1
D
Design Explorer . . . . . . . . . . . . . . 4:18, 5:13
Diagram . . . 4:9, 4:12, 4:18, 4:23, 5:9, 5:18
Diagram View . . . . . . . . . . . . . . . . . . 3:2, 3:4
Diagram Viewer . . . . . . . . . . . . . . 4:19, 4:25
Index page 1
12.0
Dictionaries . . . . . . . . . . . . . . . . . . . . . . . 6:7
Display . . . . . . . . . . . . . . . . . . . . . . . . . 4:22
Display
Project
Configuration
Explorer#F1_SCHEMATIC_INTEGRATOR_P
ROJECT_CONFIGURATION_EXPLOR
ER . . . . . . . . . . . . . . . . . . . . . . . 6:1
Distance Tolerance . . . . . . . . . . . . . . . . . 6:6
Distance Units . . . . . . . . . . . . . . . . . . . . . 6:6
Drag and Drop . . . . . . . . . . . . . . . . . . . 5:13
E
Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:4
Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . 6:1
Export to Excel . . . . . . . . . . . . . . . . 4:6, 4:9
Expression Syntax . . . . . . . . . . . . . . . . 6:12
M
Macro . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:2
Main Bar . . . . . . . . . . . . . . . . . . . . . . . . 4:23
Main Object . . . . . . . . . . . . . . . . . . . . . 4:23
Main Object Type . . . . . . . . . . . . . . . . . . 4:2
Main Table . . . . . . . . 4:1, 4:6, 4:7, 4:9, 4:25
Main Type . . . . . . . . . . . . . . . . . . . . . . . 3:1
Max . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:13
Min . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:13
Multiple Pipes . . . . . . . . . . . . . . . . . . . . . 5:7
N
New . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:2
O
F
File . . . . . . . . . . . . . . . . . . . . . 4:27, 6:2, 6:3
Fix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:13
Format . . . . . . . . . . . . . . . . . . . . . . . . . . 6:14
Function . . . . . . . . . . . . . . . . . . . . . . . . 6:14
Functionality . . . . . . . . . . . . . . . . . . . . . . 8:1
Functions . . . . . . . . . . . . . . . . . . . . . . . 6:13
G
Getting Started . . . . . . . . . . . . . . . . . . . . 3:1
H
Hide . . . . . . . . . . . . . . . . . . . . . . . . 4:8, 4:22
HVAC . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:7
I
Inlist . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:14
Inst . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:13
Intellisense . . . . . . . . . . . . . . . . . . . . . . 6:12
Occurs . . . . . . . . . . . . . . . . . . . . . . . . . 6:13
Offline Instruments . . . . . . . . . . . . . . . . . 5:8
Open . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:2
Operators . . . . . . . . . . . . . . . . . . . . . . . 6:12
P
Pan . . . . . . . . . . . . . . . . . . . . . . . . . 3:4, 4:19
Pick Connection . . . . . . . . . . . . . . . . . . 4:17
Pick Connections . . . . . . . . . . . . . . . . . 4:16
PML . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:1
Print Preview . . . . . . . . . . . . . . . . . . 4:6, 4:9
Project Defaults . . . . . . . . . . . . . . . . . . . 6:5
Pseudo Attributes . . . . . . . . . . . . . . . . . . 5:3
R
Real Tolerance . . . . . . . . . . . . . . . . . . . . 6:6
Replace . . . . . . . . . . . . . . . . . . . . . . . . 6:14
Right . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:13
Round . . . . . . . . . . . . . . . . . . . . . . . . . . 6:13
Rule Group . . . . . . . . . . . . . . . . . . 6:20, 6:21
Rules . . . . . . . . . . . . . . . . . . . . . . . . . . 6:10
LEAVE . . . . . . . . . . . . . . . . . . . . . . . . . 6:22
Left . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:13
Len . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:13
Link . . . 3:8, 4:11, 4:17, 4:23, 5:1, 5:2, 5:18
Listposition . . . . . . . . . . . . . . . . . . . . . . 6:14
Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:13
Log10 . . . . . . . . . . . . . . . . . . . . . . . . . . 6:13
Lookup . . . . . . . . . . . . . . . . . . . . . . . . . 6:14
Lower . . . . . . . . . . . . . . . . . . . . . . . . . . 6:14
Save . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:3
Save As . . . . . . . . . . . . . . . . . . . . . . . . . 6:3
Save Changes . . . . . . . . . . . . . . . . . . . . 6:3
Save Layout . . . . . . . . . . . . . . . . . . . 4:6, 4:9
Save Layout As . . . . . . . . . . . . . . . . 4:6, 4:9
SCEQUI . . . . . . . . . . . . . . . . . . . . . . . . 6:15
Schematic . . . . . . . . . . . . . . . . . . . . . . . 5:2
Schematic Pipeline . . . . . . . . . . . . . . . . . 5:7
SCSTYP . . . . . . . . . . . . . . . . . . . . . . . . 6:21
SCVALV . . . . . . . . . . . . . . . . . . . . 6:18, 6:21
Index page 2
12.0
T
Table Layouts . . . . . . . . . . . . . . . . . . . . . 8:2
Tan . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:13
Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . 4:19
Trim . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:14
U
Unlink . . . . . . . . . .3:8, 4:11, 4:23, 5:2, 5:18
Update . . . . . . . . . . . . . . . . . . . . . . . . . 4:32
Upper . . . . . . . . . . . . . . . . . . . . . . . . . . 6:14
V
View . . . . . . . . . . . . . 4:14, 4:18, 4:24, 4:29
Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . 4:20
Z
Zoom . . . . . . . . . . . . . . . . . . . . . . . 3:4, 4:19
Index page 3
12.0