TM-1855 AVEVAEverything3D™ (2.1) Schematic 3D Integrator Rev 1.0 PDF
TM-1855 AVEVAEverything3D™ (2.1) Schematic 3D Integrator Rev 1.0 PDF
TM-1855 AVEVAEverything3D™ (2.1) Schematic 3D Integrator Rev 1.0 PDF
Revision Log
Updates
Change highlighting will be employed for all revisions. Where new or changed information is presented
section headings will be highlighted in Yellow.
Suggestion / Problems
If you have a suggestion about this manual or the system to which it refers please report it to AVEVA
Training & Product Support at [email protected]
This manual provides documentation relating to products to which you may not have access or which may
not be licensed to you. For further information on which products are licensed to you please refer to your
licence conditions.
Disclaimer
1.1 AVEVA does not warrant that the use of the AVEVA software will be uninterrupted, error-free or free
from viruses.
1.2 AVEVA shall not be liable for: loss of profits; loss of business; depletion of goodwill and/or similar
losses; loss of anticipated savings; loss of goods; loss of contract; loss of use; loss or corruption of
data or information; any special, indirect, consequential or pure economic loss, costs, damages,
charges or expenses which may be suffered by the user, including any loss suffered by the user
resulting from the inaccuracy or invalidity of any data created by the AVEVA software, irrespective of
whether such losses are suffered directly or indirectly, or arise in contract, tort (including negligence)
or otherwise.
1.3 AVEVA's total liability in contract, tort (including negligence), or otherwise, arising in connection with
the performance of the AVEVA software shall be limited to 100% of the licence fees paid in the year
in which the user's claim is brought.
1.4 Clauses 1.1 to 1.3 shall apply to the fullest extent permissible at law.
1.5 In the event of any conflict between the above clauses and the analogous clauses in the software
licence under which the AVEVA software was purchased, the clauses in the software licence shall
take precedence.
Copyright Notice
All intellectual property rights, including but not limited to, copyright in this Training Guide and the associated
documentation belongs to or is licensed to AVEVA Solutions Limited or its affiliates.
All rights are reserved to AVEVA Solutions Limited and its affiliates companies. The information contained in
this Training Guide and associated documentation is commercially sensitive, and shall not be adapted,
copied, reproduced, stored in a retrieval system, or transmitted in any form or medium by any means
(including photocopying or electronic means) without the prior written permission of AVEVA Solutions
Limited. Where such permission is granted, AVEVA Solutions Limited expressly requires that the Disclaimer
included in this Training Guide and this Copyright notice is prominently displayed at the beginning of every
copy that is made.
Licenses issued by the Copyright Licensing Agency or any other reproduction rights organisation do not
apply. If any unauthorised acts are carried out in relation to this copyright work, a civil claim for damages
may be made and or criminal prosecution may result.
AVEVA Solutions Limited and its affiliate companies shall not be liable for any breach or infringement of a
third party's intellectual property rights arising from the use of this Training Guide and associated
documentation.
Trademark Notice
AVEVA™, AVEVA Everything3D™, AVEVA E3D™, [AVEVA Tags], Tribon and all AVEVA product and
service names are trademarks of AVEVA Group plc or its subsidiaries
Use of these trademarks, product and service names belonging to AVEVA Group plc or its subsidiaries is
strictly forbidden, without the prior written permission of AVEVA Group plc or AVEVA Solutions Limited. Any
unauthorised use may result in a legal claim being made against you.
Fluent is a trade mark of Microsoft Corporation. The Fluent user interface is licensed from Microsoft
Corporation by AVEVA and use of the Fluent trademark is strictly forbidden.
All other trademarks belong to their respective owners and cannot be used without the permission of the
owner.
1 Introduction ............................................................................................................................ 7
1.1 Aim ..................................................................................................................................................... 7
1.2 Objectives .......................................................................................................................................... 7
1.3 Prerequisites ..................................................................................................................................... 7
1.4 Course Structure ............................................................................................................................... 7
1.5 Using this Guide ............................................................................................................................... 7
2 AVEVA Schematic 3D Integrator Overview .......................................................................... 9
2.1 Overview ............................................................................................................................................ 9
2.2 Product Requirement ..................................................................................................................... 10
2.3 Managing Access and Links .......................................................................................................... 10
2.4 Launching the Integrator ............................................................................................................... 10
2.5 Integrator Contextual menu ........................................................................................................... 12
2.6 Integrator Main Table...................................................................................................................... 12
2.7 Diagram Viewer ............................................................................................................................... 13
2.8 Integrator 3D view ........................................................................................................................... 14
2.9 Compare Colour key ....................................................................................................................... 14
Exercise 1.................................................................................................................................... 16
3 Integrator Controls ............................................................................................................... 17
3.1 Main Table Controls........................................................................................................................ 17
3.1.1 Main Object Type....................................................................................................................... 17
3.1.2 Scope for Schematic Types ....................................................................................................... 18
3.1.3 Column setup............................................................................................................................. 19
3.1.4 Main Table Settings ................................................................................................................... 20
3.1.5 Other Main table Controls .......................................................................................................... 22
3.1.6 Displaying Saved Layouts ......................................................................................................... 23
3.2 Subtype Table Controls.................................................................................................................. 23
3.2.1 Subtype tables for applicable Object Types .............................................................................. 24
3.3 Diagram Viewer Controls ............................................................................................................... 25
3.4 Viewing Diagrams ........................................................................................................................... 26
3.4.1 Diagram viewer settings ............................................................................................................ 28
Exercise 2.................................................................................................................................... 30
4 Compare ............................................................................................................................... 31
4.1 Integrator Configuration................................................................................................................. 31
4.2 Comparing 3D Data against Schematic Data ............................................................................... 31
4.2.1 ‘Compare’ – Via Main Table ...................................................................................................... 31
4.2.2 ‘Compare’ – Via Diagram Viewer .............................................................................................. 32
4.2.3 ‘Compare’ – Via Integrator Contextual Menu ............................................................................ 33
4.3 Comparison Results ....................................................................................................................... 34
4.4 Integrator Messages ....................................................................................................................... 35
4.5 Integrator Report ............................................................................................................................. 35
4.5.1 Integrator Report Controls ......................................................................................................... 36
4.5.2 Comparing and Updating attribute values ................................................................................. 40
4.5.3 Highlight matched items on both 3D and diagram views .......................................................... 46
4.5.4 Comparing Pipes ....................................................................................................................... 48
4.5.5 Comparing Diagram items ......................................................................................................... 49
Exercise 3.................................................................................................................................... 52
5 Link ....................................................................................................................................... 53
5.1 Link and Unlink ............................................................................................................................... 53
5.2 Linking Schematic and 3D items ................................................................................................... 53
5.2.1 ‘Link’ – Via Main Table .............................................................................................................. 54
5.2.2 ‘Link’ – Via Diagram ................................................................................................................... 54
AVEVA Schematic 3D Integrator is an add-in application within the AVEVA Everything3DTM Model
module. The Schematic 3D Integrator provides an integrated environment for schematic and 3D model data,
enabling quick and easy comparisons for consistency, creation of 3D model objects from schematic data as
well as assigning direct links between corresponding model objects available in both 2D and 3D databases.
1.1 Aim
Over the duration of this course the participants will learn to use the features and functions of the Schematic
3D Integrator. These will include familiarisation of the ‘Compare’, ‘Build’ and ‘Link’ processes of database
objects.
1.2 Objectives
1.3 Prerequisites
Participants should have a basic understanding of AVEVA Plant, Marine or AVEVA Everything3D and
should have already completed the AVEVA Plant, Marine or AVEVA Everything3D Foundations course.
Knowledge of AVEVA Diagrams and / or AVEVA P&ID as well as some basic PML knowledge will be
advantageous.
Training will consist of oral and visual presentations, demonstrations and set exercises. Each workstation
will have an installed training project, populated with relevant model objects, as this will be essential for
trainees to practice the procedures with the features, and complete the set exercises.
Certain text styles are used to indicate special situations throughout this document.
Additional information notes and references to other documentation will be indicated in the styles below.
Additional information
System prompts will be bold, italic and in inverted commas i.e. 'Choose function'.
2.1 Overview
AVEVA Schematic 3D Integrator is an application which provides an integrated environment for schematic
and 3D model data, hence enabling quick and easy comparisons for consistency, as well as the creation of
3D model objects from schematic data. It also enables quick, easy browsing and reporting on compared
data, and can be utilised according to a required data checking work flow.
The Integrator User Interface consists of a Diagram viewer, a 3D graphical view, and a Main table/grid
which can list specific schematic and Design data contained within the AVEVA Dabacon databases.
Schematic model objects are database items whose ‘ACTTYPE’ attributes are defined as ‘Schematic
Element Types’ e.g. SCPLINE, SCEQUI etc. These items are stored in the Schematic database, and can be
appended with relevant User defined attributes (UDAs) alongside their default system attributes, as part of
the schematic data.
Within the Integrator, Schematic or 3D model objects displayed on the grid / Main table or on the diagram
can have the following key functions performed on them:
Compare – Comparison actions between corresponding items of different types, with results reported for
component sequence, connectivity and attribute data.
Build – The automated creation of 3D model components with attribute data, from a schematic source as its
base data.
Link/Unlink – The creation and management of binding references between corresponding items of
different types. These items are stored in their respective differing databases, with the link information stored
in a separate database designed to cater for it.
The binding references comes in the form of Pseudo-attributes ‘SCHLNK’, ‘DESLNK’ and ‘ENGLNK’
which allows for a direct reference between linked corresponding database objects
The Schematic 3D Integrator can be accessed from within the following product installations:
AVEVA Plant (12 Series); AVEVA PDMS 12.0 or later
AVEVA Everything3D – Model 1.1, 2.1 or later
Schematic source data which are read from an available DABACON schematic database and authored by:
AVEVA Diagrams
AVEVA P&ID imported via AVEVA Schematic Model Manager, either by SAVE WORK in
AVEVA P&ID (saving directly into the schematic database) or by importing P&ID’s ISO15926
XML files into AVEVA Schematic Model Manager.
Schematic data imported via AVEVA Schematic Model Manager, from third party P&ID tools
that can export the P&ID drawings to ISO15926 XML files.
For this training course, the latest installation of AVEVA Everything3D (2.1) will be utilized with an
appropriate project (bundled TRAINING (TRA) project) which has been preloaded with relevant
schematic and 3D data
Each work station running the AVEVA Everything3D 2.1 installation must have the Schematic 3D Integrator
licence ‘checked out’, as this allows for access to the Integrator. AVEVA Everything3D 2.1 already runs in
the mode: ‘Integrate Engineering and Schematics’ in order to gain access to the Integrator and Schematic
database. This means the administrator or users will not need to take any actions to get access.
Prior to conducting Builds and Links, project administrators are recommended to create a separate Design
Reference database to hold links, and then use the new ‘Manage Links’ feature, accessible from the
‘Schematic 3D Integrator > Settings’ menu. This can be used to create and manage Link Worlds in the
appropriate database, including consolidating links from separate databases.
As an application within the AVEVA Everything3D product, the Schematic 3D Integrator can be launched
from within the Check group in the Home menu bar located in the ‘Model’ module.
Start an Integrator session by logging into the AVEVA Everything 3D ‘Model’ module of a project, navigate
to the ‘Home’ menu and click the Integrator button located within the ‘Check’ group.
The button will appear depressed when clicked which indicates an initialization of the application. This is
also characterised by the display of the integrator main table, as well as the availability of the Integrator
contextual menu bar.
The forms and tables which make up the Integrator application are dockable as per the .NET functionality.
Tables can also be repositioned beneath tabs.
The Integrator contextual menu will be displayed when the Integrator is clicked.
The integrator button will appear depressed after it has been clicked, and the contextual menu will be
displayed during a running E3D session. The contextual menu contains all basic functions required to utilise
and manage the data within the Integrator interfaces. To Exit the Integrator, simply click on the integrator
button again, and have it un-depressed. The Contextual menu will be terminated as well.
This grid controlled table can be populated with available and applicable Schematic or Design items. These
items are listed in rows of a grid view which is specific to an applicable object type, for both schematic and
design based items.
In other words, the Main table will list items available in the schematic or design database according to
element types. Hence there are separate grid views for Schematic Equipment, pipelines, offline instruments
etc. and also grid views Design Equipment, Pipes, HVAC etc. These are also known as the ‘Main Object
Types’
Each grid can have a modifiable selection of columns which carry attribute data specific to the object type of
the listed item.
The Diagram viewer is a dockable form which allows the user to preview and review P&IDs / Diagrams as
well as interact directly with individual schematic elements contained within a diagram.
The diagrams displayed is actually a snapshot of the original source diagram, and are presented in an SVG
format, the Diagram viewer incorporates an SVG format viewer which ships with the Integrator application,
hence eliminating the need to download and install a third party SVG Viewer.
When a diagram is being displayed, a ‘Diagram contextual menu’ is also available. This contains controls
and functions specific for the manipulation of the objects contained within a diagram, and the entire diagram
itself.
Integrator creates a separate 3D view or ‘Integrator 3D View’ for the graphical representation of Compared
objects. This view has its own draw list so as colour coded models (from comparisons) do not impact on any
other 3D graphical views that the user may have defined within AVEVA Everything3DTM.
Integrator colour marks the models on the diagram and 3D views to give a visual indication of the Compare
results on individual objects. Corresponding objects in both views will carry matching colour codes as the
Compare results apply to both.
Although each representative colour can be configured within a colour set from the ‘Project Configuration
Explorer’. A selected colour set (which could be a default ‘Out-of-the box’ colour scheme) could be
displayed on its own user interface, by clicking the button shown below:
Exercise 1
1. Log into the AVEVA Everything3D Model module with the details given below and initiate the
Schematic 3D Integrator. Log in to the Training project, with the details shown below
PROJECT: TRAINING
USER: SYSTEM
PASSWORD: XXXXXX (type 6 instances of the character ‘X’ as a capital letter)
MDB: A-PIPING
MODULE: Model
2. Get familiar with the user interface, dockable forms, and layouts of the forms
This chapter outlines and demonstrates the basic controls essential for manipulating and working with the
Integrator.
The Integrator Main Table is dynamically displayed when the integrator application is started, but it can also
be manually displayed or turned off from the ‘Main Table’ menu button, within the Integrator home menu
bar.
The main table features a menu with listed options. These can be accessed by right clicking on a Main Table
column header or a column filter entry section Bar.
The Main Object Type control, determines the type of elements which a grid view is based upon.
Select any Main Object Type from the Main table context menu.
This populates the list with available items based on the selected Main Object Type. For example, selecting
the ‘Equipment’ object type will populate the list with all 3D items available in the current MDB.
With the grid view displaying objects which are common to an element / object type (Schematic or 3D), the
Scope for Schematic Types allows for a limitation on the range of schematic objects displayed.
The grid could be controlled to only list all common objects which are available on any currently displayed
diagram Page, or common objects available in all pages of an open Diagram, or all common schematic
objects in the MDB.
Each grid view on the Main Table can have a modifiable selection of columns which carry attribute data
specific to the object type of the listed items.
From the Main Table context menu, select the Column Setup entry to display the Table Column Setup form.
The above action brings up the ‘Column Setup´ form, with which columns can be added or removed from a
current grid view on the Main table.
The ‘Column Setup’ form also features visibility checkboxes which is a toggle for making a grid column
visible or invisible.
Click the ’Add Standard Attributes’ text button, to populate the grid with columns for ALL applicable
attributes of the object type contained in the grid view, or individually select attributes from the pick list.
Columns can also be created by entering expressions which references single or combined attribute data.
The behaviour of data entries in the grid cells can be manipulated using the controls described.
Select Settings from the Main Table context menu to display the Settings submenu.
The Settings submenu contains controls for column sorting, and also enabling / disabling the visibility of
‘Unset’ / ‘Nulref’ values in the grid.
Selecting the ‘Read Only’ entry of the ‘Interaction mode’ submenu ensures that the data entries in grid
cells cannot be edited, changed or modified.
The Single Cell Edit entry places a selected applicable cell in edit mode one at a time.
Whilst the Bulk Cell Edit, entry allows multiple applicable cells to be updated in one action, through the use
of the ‘Fill Down’, ‘Fill Up’ and ‘Copy/Paste’ operations.
The ‘Single Cell’ and ‘Bulk Cell’ edit modes only applies to grid tables with Design Elements listed
The Bulk Cell Edit mode will allow for multiple cells to be selected, by both depressing and holding the
‘Ctrl’ button of the keyboard and selecting cells, or by clicking on a cell and dragging across required
cells whilst the mouse button is depressed
Observe the grid behaviour by toggling the button commands for ‘Group’ and ‘Column Sorting’,
‘Displaying column summaries’, and ‘supressing ‘Unset’ / ‘Nulref’’ values. These are located within
the ‘Settings’ menu
The entries for ‘Feedback Colours’ brings up a colour pallet form with which required cell colours can be
selected. Colours for ‘Read Only cells’, ‘Edit success’, and ‘Edit Fail’ results can be defined.
From the Main table context menu, select Settings > Feedback Colours to display the ‘Feedback colours’
entries submenu.
Observe the grid behaviour by toggling the button commands for ‘Group’ and ‘Column Sorting’,
‘Displaying column summaries’, and ‘supressing ‘Unset’ / ‘Nulref’’ values. These are located within
the ‘Settings’ menu
The Main Table context menu also features the following commands as entries:
Reset cell Feedback – This returns the default colour of a cell, removing any feedback colour which
appeared after an action had been carried out.
Refresh – Refreshes the grid cell entries with current data from the database.
Export to Excel – Exports the currently viewed table layout, grid and cell contents, out as an excel file. This
is performed through a file browser form, and saved under a selected name.
Print Preview – This manages and displays a preview of a currently viewed Main table, its grid and cell
contents, before it is printed out.
Save Layout As – Each grid layout of the Main Table can be restructured named and saved. This is
essential where certain grid modifications like the addition / removal of standard or customised grid
columns, and cell width modification has been made for items of specific Object types, and will need to be
reused in recurring Integrator sessions.
Integrator is delivered with a standard ‘Default Layout’ for all grid types. Each created Layout will be listed
at the bottom of the Main table context menu, along with an entry for the selection of the Default Layout.
The integrator Main table features a ‘Subtype Table’ which is displayed next to a Main table. It contains an
extra grid which caters for Sub elements of the elements / objects contained in the main grid.
This subtype table can be accessed by clicking the ‘Subtype Table’ entry on the context menu.
The Controls for the Subtype Table can be accessed in the same manner as those of the Main table. They
are listed and behave similarly.
The Table can be removed by selecting the ‘Hide’ entry in the Subtype Table context menu.
The Main Tables for most of the available Object types in Integrator will have a Subtype Table feature
available to them.
This is because elements / objects of these Object types can carry sub /member elements, which are
essential to the tasks of the Integrator. See below for a listing of Subtype tables for applicable Object types.
Launch the diagram viewer from the Integrator contextual menu by clicking the ‘Open’ button located within
the ‘Diagram’ group of the menu. This displays the ‘View Diagram’ form, in which a diagram can be
selected and displayed on the Diagram viewer.
The Diagram viewer can also be directly accessed from the Main Table, by right clicking on any element
row, and then select View > View on Diagram from the grid context menu.
This action opens up the Diagram viewer, and also the Diagram page which contains that element.
The Diagram viewer will be displayed from the Main table, if the element selected exists in the
Schematic database, and is represented on a Diagram / P&ID, or if the element selected exists in the
Design database, but has been linked to a corresponding item in the Schematic Database which is
also represented on a Diagram / P&ID
If the item is represented on only one diagram, that diagram will be opened. If it is represented across
multiple diagrams (e.g. a pipeline), the user will be prompted with a list of the diagrams for a selection
The Diagram viewer controls are located in its own contextual menu bar, which is activated whenever the
diagram viewer is launched.
The controls on the Diagram Viewer menu bar, allows for the manipulation of the diagram and the
objects contained within. They are intuitive to use
Click the View Diagram Open icon on the Integrator contextual menu bar to launch the View Diagram
form.
The View Diagram form reads the Schematic databases in the current MDB, finding all available diagrams
(SCDiagram object). It also features browsing and searching capabilities using the explorer panel and
search controls. This is essential for MDBs with a large number of diagrams.
Click the Diagrams radio button to view a list of available diagrams (after searching from the schematic
group) or click the Pages radio button to view all available diagrams, listed by their pages.
Click on the Search button with a blank text field, to display a list of all diagrams available in the Schematic
Databases available in the current MDB.
Click the ‘By Diagram Name’ radio before performing a wildcard search using the name of the diagram or
select ‘By Content’ to perform a search using the name of an object such as schematic equipment to find
the diagrams it appears on.
Enable the ‘Preview’ checkbox, and select a listed diagram page. The preview pane will display a preview of
the diagram.
Use its pan and zoom functions to manipulate and inspect the diagram. Also holding down the
‘Alt’ key on the keyboard displays the ‘Pan’ tool used for panning across a diagram displayed on
either the ‘View diagram’ and ‘Diagram Viewer’ form.
Click OK to open and display the diagram in the Diagram Viewer form.
Displayed diagrams can be closed by several methods. Right click on the tab of an open drawing within the
Diagram view, to display the ‘Close’ menu entry. Clicking on this button closes only that drawing.
Individual diagrams can also be closed by selecting the Close Diagram entry on the ‘right click’ context
menu of the diagram.
All diagrams opened in the Diagram Viewer can be closed in one action by clicking the Close All button
located within the ‘Diagram’ group of the ‘Integrator’ contextual menu.
The behaviour of displayed diagrams can be set within the ‘Settings’ form. Display the Settings form by
clicking on the ‘Settings’ button within the ‘View’ group of the ‘Diagram Viewer’ menu bar.
The controls within this form controls functions like the ‘Selection colour’ of an item, when they are selected
on the drawing. It also controls the highlight colour of an object on the diagram, when the mouse cursor
hovers over that item. This ‘MouseOver Colour’ is temporarily displayed.
Items which can be selected are those which are of the current Main Object Type.
Toggle the ‘Tabs Layout’ radio buttons, to change the position of the diagram tabs on the Diagram Viewer.
Check the ‘Set CE from diagram’ checkbox to enable any applicable object selected on the Diagram to be
tracked/selected on the Schematic Explorer.
The ‘Settings’ form also allows for the selection of the maximum number of items to be displayed in the
‘Recent diagram list’ and maximum number of diagram tabs to be displayed on the Diagram Viewer.
Exercise 2
2. Search for and display the diagrams A0-01-2012-0001 Page-1 and A0-01-2012-0002 Page-1
4. Select the ‘Auto zoom on external selection’ for Schematic Equipment on A0-01-2012-0002
Page-1
5. Track all equipment in A0-01-2012-0002 Page-1on the main table and schematic explorer
7. From the main table, change the Scope for schematic type to ‘Diagram’ and then ‘MDB’
8. Insert a new column to the Main table, with the expression ‘RESTAT’
9. Configure and save a Main table layout with the name ‘Training 1’
10. From the main table, select the Schematic equipment ‘/D1201’, and ‘view on diagram’
Integrator configurations contain the necessary rules and methods required for specific/targeted
Comparisons and Builds. Multiple configurations can be defined for different comparison scenarios/cases,
setup with a range of criteria as required.
From within the ‘Compare’ group of the ‘Integrator’ menu bar, expand the configurations picklist to view the
default configuration cases entries.
A configuration is required to be selected before performing a ‘Compare’. Each configuration contains and
handles the Comparison Colours, Comparison Categories, Comparison options and rules.
A configuration can be setup for the checking/comparison of only Equipment, Pipes, Pipes without
components, or a combination of objects.
The use of a configuration can allow for targeted comparison against specific items only.
The definition of an Integrator configuration containing a selection of the relevant criteria is an administrative
task which is reserved for the project administrator or administering user (member of the CUADMIN team).
The Configurations are contained within and saved as an xml file format, and must run from the Project
defaults folder.
Schematic data stands in as the source data with which the accuracy and data values of 3D objects can be
checked. Connection information and the sequence/order of items are also compared.
Select an item / object required for comparison on the grid of the Main Table, and pick the ‘Compare’ entry
from the context menu.
This action can be carried out from a Schematic or Design based Main Table, and will compare the selected
object against an available match.
Note that the title bar of the Main table indicates the current layout, and Comparison Category used.
Display a diagram in the Diagram Viewer, and select an item / object on the displayed diagram. Select the
‘Compare’ entry from the context menu. The item will be compared with a matching 3D object.
The selected item / object on the Diagram / P&ID which is to be compared must be of the current
Object Type, before it can be selected
The item / object on the Diagram / P&ID which is to be selected must be of the current Object Type,
before it can be selected.
Select an item / object on a displayed diagram or on the Main Table, then click the Compare Selection
button from within the ‘Compare’ group.
This action compares the attribute values of the selected item with that of a matching 3D object.
If an item / Object is not selected on the diagram / P&ID, or on the correct Main Table, the ‘Compare’
entry on the Integrator Main menu will be greyed out
An item / object on a 3D / Design based Main Table which has no Schematic match, will have its
‘Compare’ entry greyed out
All items / objects on a displayed diagram can be compared for possible matches with corresponding 3D
objects.
Click the Compare Diagram button from within the ‘Compare’ group from the Integrator main menu to
initiate a full diagram comparison on all displayed diagrams.
The result of a Compare action is output in a report form or file. It also presented as a colour coded
representation of the compared object on the diagram and 3D graphical views.
The models are colour marked according to the utilised comparison colour set selected. These are
presented on the compared objects as shown above.
The default integrator colour set has the following colours shown below setup (as shown in the colour key
below). The colour will mark up both the 3D and 2D models.
Red for components present in one view but missing from the other view
Yellow for warnings or information
Orange for components with some mismatch in attribute values
Green for components that match
During the process of comparisons and builds, Integrator will present a message dialogue, which displays
the progress, and status of running processes. A collection of warnings and error comments are also
generated and displayed.
This dialogue form is dynamically initiated at start of the process, but can also be accessed from by clicking
the Messages button located at the ‘View’ group of the ‘Integrator’ menu bar.
The Integrator Report form combines and displays summarized and full details of the comparison status of
an item, a set of items, or of all items contained within a diagram.
The Integrator Report form is automatically displayed at the conclusion of a ‘Compare’ action, and is made
up of an explorer style pane, attribute data pane and a grid pane which has both a summary and
Details tab, which shows the items Compared and any differences.
Generated reports can be saved as a Report Dataset xml format file, in any system location required.
Previously saved Integrator reports can be opened from within any currently displayed report.
The Integrator report includes menus and toolbars, which are described as follows.
From the report menu bar, the ‘File’ dropdown menu lists the following entries as shown.
View All Referenced Diagrams Displays all diagrams whose member item(s) is
present on the Integrator report
Properties Displays the Report properties form
Redo Compare Repeats the compare of the same objects
Open Opens a file browser dialogue which allows
previously saved Integrator report to be opened
Save As… Opens a location browser dialogue which allows a
report to be saved as an XML or HTML file
Export Details to Excel Opens a location browser dialogue which allows the
contents of the Details tab of the report grid pane to
be exported as an Excel file
Print Details Opens a Print dialogue which allows for the printing
of the contents of the Details tab of the report grid
pane
Close This closes the report
Refresh Schematic & 3D Views Re-apply the compare rules colours to the Diagram
View and 3D View
Set Limits Sets the 3D View limits to encompass all the 3D
objects in the report
Significant Elements Only This is a filter which allows only significant items to
be displayed report
Differences and Errors Only This is a filter which allows only items with
differences and errors to be displayed in the report
Highlight on Diagram These modal settings control how the Diagram View
The Explorer pane lists compared items and sub items in a hierarchical arrangement. Each hierarchical set
is placed beneath the applicable element type (Equipment in this case).
It consists of a Schematic and 3D tab positioned at the bottom of the form, which lists a hierarchical
placement of compared Schematic and 3D items respectively.
The Grid pane lists a summarized description of the results of a Compare action within the ‘Summary’ tab.
Items compared, successes, errors and warnings observed as well as other relevant information are listed
next to the number of items affected.
The ‘Details’ Tab displays an extension to the summarized information. Here the name of the affected item,
its owner, corresponding 3D item and comments are shown.
Items selected from the Explorer pane will be selected and highlighted in the Details tab, as both Schematic
and 3D items compared can also all be listed here.
The Data pane is positioned at the lower half of the Integrator report and displays the attribute details of the
Schematic and 3D equivalence of a selected compared item.
Differences in attribute values of a selected compared item will be highlighted then displayed in the data
pane.
The Integrator report toolbar items are a quick access to some of the controls available in the ‘View’ menu
list. It also contains navigation controls for display selections and report manipulation.
The ‘Summary’ entry switches on / off the summary filter as selected for any category selected in the
‘Summary’ tab of the report.
Back
Forward
Save As
Set Limits
Summary
As the Data pane lists the attribute values of compared 3D item and its corresponding Schematic item, the
Data panel toolbar contains functions which controls how these attribute values are displayed, as well as
their visibility.
On the Integrator main table, select ‘Schematic Equipment’ as its Main Object type, and select 3
Schematic equipment (using the ‘CTRL + select’ function). Then run a Comparison as shown:
This will run a Compare on the selected items, initiating both the Integrator Messages form and the
Integrator report afterwards. It also displays the 3D view of the Equipment on the graphical view.
Select the entry ‘Compared with errors’ beneath the ‘Number of Schematic Nozzles Compared’ node on
the summary pane as to display the affected items on both the Details tab and the Explorer pane as
shown. This action also activates the ‘Summary’ button on the Report tool bar (on the left side of the
Form). The displayed items are objects which were compared with errors.
Items with attribute mismatches and errors carry the icon symbol , whilst those with error-free
matches carry the ‘check’ icon symbol Entries shown for information carry the icon symbol and
those shown for warnings carry the icon
Select the item ‘SCEQUI /C1101’ as shown, to display the results of its compared attribute information as
shown:
The data pane lists a side by side view of the attribute values of both the schematic and corresponding 3D
item, showing differences and similarities.
In this case, the value of the ‘Description’ attribute has been noted as being different. It is possible to obtain
the ‘Correct’ attribute value for the 3D item from the value of the corresponding Schematic item.
By selecting the attribute entry to highlight, then select the ‘Copy to 3D’ entry from the ‘right click’
context menu.
By selecting the listed attribute row to highlight, then select the ‘Copy to 3D’ button or the ‘Copy All
to 3D’ button from the data toolbar, to copy all allowable schematic attribute values to the
corresponding 3D item which reports a difference.
Or
Attribute entries with update values will now take on the ‘Cyan’ colour, as well as item entry on the Grid
pane as shown.
The 3D and Schematic models of the compared items should now take on the ‘comparison colours’
as described in section 4.3
The ‘Integrator Comments’ section displays further information on the attribute and link status of the
compared items
From the ‘Edit’ report menu drop down list, select the entry ‘Copy All to 3D’ to
copy all allowable schematic attribute values to corresponding 3D items that have
changes.
‘Allowable’ attribute values are those whose sources have been defined in the Project Configuration
explorer, or certain attributes common to both the Source and Target items
The reporting of errors, warnings and information on attribute values is setup and defined in the Project
Configuration, and the definition is carried out on the basis of element types
From the ‘File’ report menu drop down list, select the entry ‘Redo Compare’ to
accept all the updates. This action re-runs the Compare process, with the
Integrator messages form registering each step of the process.
The Integrator Report form will now be refreshed with the updated Data.
De-activate the ‘Summary’ button on the toolbar by clicking on it, and then select the topmost item on
the Explorer hierarchy (Schematic Elements). This will list all items beneath the top element on the
Details pane, as well as their owners and any matching corresponding item.
Also toggle between the ‘Schematic’ and ‘3D’ tabs at the bottom of the Explorer pane to view all the entries
in the Grid pane.
Several tool tips have been developed to display further information on the comparison state and
derived attribute data of compared items
It is possible to activate certain dynamically tracked actions between the Integrator report, the diagram
(whose elements are on the report), as well as the Integrator 3D view.
From the ‘View’ report menu drop down list, activate the following entries as shown
- Highlight on Diagram
- Zoom to Diagram Selection
- Navigate to Schematic Element
- Highlight in 3D View
- Zoom to 3D Selection
- Navigate to 3D Element
Select the ‘Schematic tab’ Explorer pane, and then select and expand the entry ‘SCEQUI /E1301’ of the
hierarchy, revealing and displaying all items beneath in the Grid pane.
This action will highlight and zoom unto the Schematic model on a displayed drawing and its corresponding
(matched) 3D model of the selected item.
Select Schematic nozzle ‘SCNOZZ /C1101-N3’ on the report to highlight on both the displayed diagram and
the matched 3D model as shown
It is possible to highlight compared items on the report, by selecting the 3D or Diagram item, holding and
‘dragging’ it onto the report.
On the diagram ‘A0-01-2012-0001 Page-1’, select the item ‘E1301 Reboiler’, at the same time click the ‘Atl’
key and hold the item, then drag it across and drop it on to the Integrator report. This should highlight the
item on the report.
A similar action is possible if an item is selected from the Model explorer, the Schematic explorer or the
Diagram, then dragged and dropped on to the report. This action can only be carried out if the items to be
selected have been compared already.
‘Correct’ / update reported errors and attribute mismatches, then ‘Redo Compare’ from the ‘File’ menu.
It is possible to correct attribute mismatches by directly updating the attribute value of a matched
corresponding 3D item from within the Design module, or changing schematic attribute value from within the
Schematic authoring tool. In the case of the latter, a ‘Get Work’ action will have to be run in the Design
module and then run a ‘Redo compare’ within the Integrator report.
Also note that clicking on a listed item within either the Details Grid pane or the Explorer pane will have the
3D and/or corresponding schematic item highlighted on the 3D view and/or displayed diagram.
Integrator allows the comparison of all items (of allowable element types) on a displayed diagram. The
Integrator report will list and display all comparison results and comments just as described previously.
Display the diagram ‘A0-01-2012-0001 Page-1’, then ‘right click’ on any location on the diagram and select
the ‘Compare Diagram’ entry from the context menu. This action initiates the ‘Compare’ of all items on the
diagram.
OR
Do note that running the ‘Compare Diagram’ function will proceed to initiate the comparison of all items
(of possible element types) e.g. Pipes, Components, Cable etc.
For large/busy drawings, such batch comparisons would require some time in order to successfully
compare all items located within that drawing, and their corresponding 3D items if applicable
All compared items are listed beneath their element type grouping in the Explorer pane of the Integrator
report, and the diagram inherits the comparison colours on all affected items as shown
Exercise 3
5. Select and run a ‘Compare’ on item D1201 from the main table, observe the Integrator report
6. Create a new comparison category, and unselect ‘Other attributes’ for Equipment. Select this
comparison category for use, and re-do compare and observe
9. Modify 3D items attributes values, and update mismatched data in Integrator report
10. Turn off the comparison of ‘Offline Instruments’ from the ‘Comparison Options’ form
11. Compare all items on the diagram with the ‘Compare Diagram’ function
Integrator can link Schematic items with existing corresponding 3D items. This link creates a persistent
connection between items further enabling verification of consistency between them.
The ‘unlink’ function reverses any links created between the Schematic and 3D items, and also manages
the links between these items and Engineering items which are located in the ENGIneering database.
When a schematic object is to be linked, Integrator will search for 3D objects that match according to the
defined configuration rules being utilized. e.g., when linking schematic equipment, the Integrator will look for
an equivalent 3D equipment object with similar name or other attributes that comply with predefined rules.
If an unlinked matching object is found, it will be offered as the first option in a list of candidates for linking.
This is then, followed by unlinked but closely matching objects and then other unmatched objects.
When linking a schematic pipeline to a 3D pipe, it is possible to select more than one 3D pipe to be linked at
the same time.
The linking or unlinking of corresponding elements can be carried out within Integrator in the following ways:
From the Integrator Main Table, populated with either Schematic or 3D objects, select and right click on any
item, then select the Link entry if active, from the right click context menu.
The link action opens a form which is populated with possible corresponding/matching items, which can be
selected and then linked by clicking the ‘OK’ button.
The Link option will be available on items 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 be
linked multiple times).
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 and HVAC lines)
The Unlink entry will be active for any item which has an existing link. Selecting this entry breaks existing
links, and also brings up a warning prompt if that item is linked to multiple items in different databases.
Linking and unlinking can also be initiated with the ‘Link’ entry on the right
click context menu of a model object located on a diagram.
The items ‘Main object type’ will have to be current on the Main
Table, before it can be selected and highlighted
Select a Schematic or 3D item from the main table, or a Schematic item from a displayed diagram, then
select Schematic-3D-Integrator > Link if active, to link that item, or Schematic-3D-Integrator > Unlink to
break any existing links.
Linking corresponding matching Schematic and 3D items from the Integrator Report can be carried out in a
number of ways:
Select and compare a Schematic or a 3D item (E1301 in this case), to display the comparison results on an
Integrator Report form.
All matched items on an Integrator report can be automatically linked with their corresponding
matched item.
Select Edit > Link all matched elements. Integrator will then work through the report content
prompting to link each identified matched item (Both equipment and nozzles in this case).
It is possible to link or skip individual items, or click Yes to All to automatically link all identified
matches. Linked items will be highlighted in cyan and any failed or skipped links in red. Select
the ‘Redo Compare’ command to accept the update.
Individual items on the ‘Grid pane’ can be selected and linked to their 3D matches, from the
links entry on its context menu.
Select an item, and display its context menu. Select Link matched elements <Schematic-
Item-Name> and <3D-Item-Name> (if matches are found) or select the entry select for
Linking (if no matches exist already)
OR
Selecting an item with this entry places the item in the Drop Site.
The Integrator report has a Drop Site for linking. This is located at an area at the base of the
report form
Selecting an item with the entry select for Linking as shown previously, will place that item on
the Drop Site.
Schematic items can be selected from the report ‘Grid’ pane, or the ‘Explorer pane’ and
dragged and dropped in the Drop Site.
If a 3D item has been selected for linking, and exist at the drop site, then equivalent schematic
items can be directly selected on the P&ID, dragged and dropped on to the drop site to initiate a
link between both items.
This link can also be initiated from the integrator report context menu of the schematic item.
In fact, it is possible to select and drag items from a displayed diagram, the Schematic explorer,
Design explorer, or the Main/Subtype tables and then drop them on the Drop Site.
Select a linked Schematic or 3D item from the Integrator Main table, display its context menu and select
View > Find in 3D Table or View > Find in 2D Table the displayed Main Table will be dynamically switched
to the table which holds the corresponding linked item, and also selects and highlights that item on both the
3D view and the diagram.
This action can also be performed from the context menus of selected linked items within the E3D Model /
Schematic explorers.
Or
The connection details button displays the Equipment connections form which lists all connections
available on selected Schematic equipment. Connections of linked corresponding 3D equipment will also be
displayed.
These ‘connections’ are in the form of nozzles and electrical connections.
The Equipment connection form is reached via the ‘Connection Details’ entry on the context menu of a
selected linked Schematic or 3D equipment.
The ‘Connections Details’ entry on the context menu will be active only if the selected item has been
linked to an equivalent item.
This form consists of a ‘Schematic Equipment’ pane, and a ‘3D Equipment’ pane which lists all available
nozzle and electrical connections on both the Schematic equipment, and its corresponding linked 3D
equipment.
Select a ‘SCNOZZ’ listed on the ‘Schematic Equipment’ pane, and then select a ‘NOZZ’ listed in the
‘Equipment’ pane. If they are a match, then the ‘Connections’ panes will highlight the size as being
Matched or Unmatched as shown.
Equivalent nozzles can be selected and linked with the ‘Set Link’ button
This action breaks any other existing links the nozzles must have carried.
Utilised 3D nozzle specification can be modified or changed from the ‘Modify specification’ button.
The ‘Nozzle Specification’ form contains nozzle data as pre-defined from the catalogue, and can be
selected from the drop down picklists.
New 3D equipment connections can be created with the ‘Create’ button. The pick list next to this button lists
the type of connections which can be created.
In the case described, a new nozzle will be created for the 3D equipment, and a relevant specification
selected from the Nozzle Specification form.
This new nozzle will be visible on the Design explorer, and its position on the equipment model and 3D
space can be set with the proper design element positioning tool.
3D connections can be deleted by selecting the connection item, and clicking on the ‘Delete Connection’
button
All changes and modification must be followed by clicking on the ‘Refresh lists’ button
With the Pick connection functionality 3D nozzles can be selected for 3D equipment which are linked to
Schematic equipment that lack an equivalent Schematic nozzle.
When a Schematic Pipeline which is linked to a 3D Pipe and is modelled to directly connect to a Schematic
equipment without the use of a nozzle is matched, there arises the issue of ‘Unresolved branches’
This happens because the 3D branch cannot determine the corresponding Schematic equipment
connection, hence cannot verify its own 3D connection after a comparison.
From the right click context menu of a Schematic pipeline in the Main table, the Pick connection entry will be
seen to be active only if that schematic pipeline has already been linked with a 3D Pipe.
Selecting the entry Pick Connections... from the context menu to display the ‘Pick connection’ form.
The form lists all available and linked 3D branches which have unresolved connections.
From the Pick Connections form, the Integrator user can determine the equivalent Schematic branch for a
selected 3D branch with an unresolved connection, this will also have a reference to the schematic
equipment which that schematic branch is connected to.
Finally, the 3D equipment which the Schematic equipment is linked to, is determined, and then instances of
relevant nozzles which can now be used as connections will be populated on the form.
Exercise 4
3. Select any schematic item from the Main table and Link from the context menu.
4. Select several items on the Main table and run a ‘Compare’, to display the Integrator Report form
5. Select one of the compared items on the report form, and drag it to the link Drop Site
6. Select the item /P1502A from the Design explorer, and drag it onto the Drop Site in the report form
to link to the selected schematic item
7. Display the diagram ‘A0-01-2012-0001 Page-1’and select the schematic equipment ‘C1101’ from
the Main table
8. Select the entry ‘Connection Details’ from its context menu and observe the nozzles
Modify a nozzle specification, and create a new nozzle ensuring to properly position it on the equipment item
On the conclusion of a comparison, Integrator reports on attribute differences, mismatches, errors and
missing elements. These anomalies will need to be corrected or appropriately managed before a consistent
set of data can be achieved.
There are situations where the differences are indeed expected and acceptable because of differing levels
of details, or as a requirement for the state of the project, or even perhaps all of the projects lifecycle. The
management of these allowances can be achieved with the ‘Accept Differences’ feature.
Typical examples of items which are likely to trigger attributes anomalies include vent and drain detail,
instrument connections, and welded attachments.
Their differences can be accepted and managed in the following ways, and will not be flagged up thereafter
in the comparison report:
1. Accept Differences: A pair of linked objects having differences such as attribute values, sizes,
connections or sequence, can be accepted as different.
2. Accept Missing Element: For unmatched objects, such as a drain connection, the corresponding
elements can be accepted as missing. Integrator will still match the object if it is added subsequently
to the model.
3. Disable Matching: For objects that should not be matched ever, such as a tee for a trunnion,
whether or not Integrator has currently matched them, matching can be disabled.
All of these actions can be reversed and the differences will then revert to being flagged up in the
comparison report. Once a number of differences have been accepted it is necessary to redo the
comparison in order to see the effects.
This in turn can change which objects are matched and thus offer more opportunities to accept differences,
and so the process may take several cycles to achieve the desired results.
The purpose of this feature is clearly to allow a designer to accept differences from the comparison report,
for situations where the 3D and schematic models have a different level of detail, or are functionally
equivalent but do not match precisely.
This feature requires special UDAs and GPSETs in other to function correctly. Access to these will require
administrative privileges, and will be defined and configured by the project Administrator
For the following example, the name value of 3D Valve (V110) has been manually modified to
demonstrate the Accept Difference feature
Accept Differences:
Display the Diagram ‘A0-01-2012-0002 Page-1’, then select and run a comparison on line 100-
B-8. Identify items with ‘mismatched attributes’.
In the example shown, The SCVALV /V110 has a name mismatch with its corresponding 3D
Valve. Assuming the difference in the name of value of the V110 3D valve object is intentional,
this difference could therefore be acceptable for this level of the design process. An ‘Accept
Difference’ action can then be performed.
Select and right click on the SCVALV /V110 to display its context menu. This item must first be
linked to its 3D equivalent, before their attribute differences can be accepted.
Display the context menu and click the enabled ‘Accept Difference’ entry.
Next, run the ‘Redo Compare’ command to refresh the Integrator Report
Objects with Accepted Differences against mismatched attributes are shown with a small
green icon in the report and have their own mark colour on the graphical views both the 3D and
2D models.
If objects are not linked before accepting a difference, the match may not persist in subsequent
session, as this depends on the data values and configuration rules
Accept Missing elements: To accept an unmatched object as ‘Missing’, select the Spectacle
Blind (PCOM) (which is not available in 3D) and click the ‘accept missing element’ entry on the
right click context menu as shown:
Run the ‘Redo compare’ command to refresh the comparison report, and view the marked up
item
The ‘Accepted missing’ item is highlighted with its default ‘Accepted difference’ colour.
The acceptance of the missing item can be subsequently rejected as soon as a matching
corresponding 3D (or 2D) item is available.
This function can allow instances like 3D drain connections models which might not be detailed within
the design phase, to be accepted in one operation
To reverse acceptance of a difference, right click and select Reject accepted differences from
the right click context menu.
Exercise 5
3. Identify items with attributes mismatches, and run the ‘Accept differences’ function
4. Identify items with which are available on one system, but temporarily missing from the other, and
run the ‘Accepted missing element’ function
5. Identify items with which are available on one system, and will not be available on the other, and run
the ‘Disable match’ function
The Build feature runs through the process of appending, key schematic process data, tags, relevant
attribute data and all connections to the 3D item being built.
The graphical view of the 3D model will be obtained from a suitable catalogue of element types, and Design
parameters will be required to be assigned.
When the Integrator builds 3D items, it carries out a set of actions under the control of the Project
Configuration Rules which is covered in the Schematic 3D Integrator Administration guide.
Although it is possible to build up most schematic items into 3D models, this does not replace the
appropriate method of modelling items in the Design module.
Prior to running any ‘Build’ action, the item(s) to be built from, must have been ‘Released To 3D’ in the
schematic database.
For the demonstration of this feature, a schematic equipment ‘SC_SW1001’ is being utilised, as this
item exists within the schematic database but has not 3D equivalent item in the Training (TRA) project
Display the Integrator main table and ensure that the ‘Schematic Equipment’ as the Main Object type.
Select Schematic equipment ‘SC_SW1001’ from the table, and select the ‘Build’ entry from its context
menu. This entry will be active as schematic equipment has no 3D equivalent, and is not linked to any 3D
item.
The Build action could create an initial 3D representation of the schematic item (based on having a valid
SPRE value) and then displays an ‘Equipment Details’ form.
The status of the BUILD process is noted and described in the Integrator messages form
The Equipment Details form contains the controls to properly configure the built 3D item.
The ‘Set Equipment Specification…’ button displays the ‘Modify Equipment Specification’ form, which
exposes a selection of pre-defined items in the Design catalogue.
Required 3D equipment templates can be selected from the displayed form, and their properties can be
viewed beforehand via the ‘Properties’ button
Click on the ‘Apply’ button button and then the close button, to exit form.
Click on the ‘Set Equipment Position’ button on the Equipment Details form, to
define the position of the newly created 3D item in 3D space, relative to the world origin point or any existing
3D item.
The above action displays the ‘Explicit Position’ form, with which the position parameters can be
selected/entered.
The default position values could be brought over from the Position attributes values of the Schematic
item from which the 3D item is being built or the values could be manually entered as shown above
Click on the ‘Set connection Details’ button on the Equipment Details form, to display the ‘Equipment
Connections’ form. This contains connections information, and allows for the management of connections
as described in the previous section.
Refer to Section 5.4 of this for more information on the use of the Equipment Connections form
Available nozzles and electrical connections (ELCONNs) can be linked, and setup with the required
connection specs as required.
Missing 2D or 3D connections can be modelled and placed at a later time, after which the ‘Connections
details’ entry from the ‘right click’ context menus can be used to display the ‘Equipment Connections’
form
Select an unlinked Schematic item (schematic equipment which does not match any 3D equipment) from the
displayed diagram or the Main Table, and run the ‘Build’ action from the Integrator menu bar as shown.
The ‘Build’ entry will not be displayed on the context menu (greyed out) if the selected Schematic item
is matched to a corresponding 3D item.
In this case, unlink and delete the 3D item ‘PIPE 250-B-5’ from
the Model explorer.
Upon clicking the ‘Build’ menu entry, the pipe build mechanism will be initiated. Integrator will attempt to
build the 3D pipe, using the data/information from schematic pipe object.
First the pipe components are built and then the pipe is auto routed.
The Schematic Line and components being built will take on a CYAN highlight colour, which signifies
schematic items which have been built into 3D models
The branches are auto routed, if the ‘Auto Route Branches’ setting is activated within the ‘Project
Options’section of the E3D application.
7.3 Building a Missing Pipe Component from Integrator Report
From the displayed Main table or the displayed diagram select the
‘/100-B-8’, select the ‘Compare’ entry from its context menu to display
the Integrator report form.
On the main table, select the schematic pipeline 100-B-8, and display the ‘Subtype table’ for the schematic
pipelines and display the right click context menu of the Schematic valve to be built, or select the pipeline
100-B-8, and run the ‘Compare’ operation, to display the integrator report, and mark up the 3D/2D models
Select the SCVALV on the Integrator report grid, and click the ‘Build’
entry on its context menu. This will build and auto position the
component on a point along the pipe.
The model editor will be dynamically turned on at the conclusion of the ‘Build’ operation and will be
used to manually reposition the component to its required location
The newly built item can be dragged and dropped in to any required position/sequence.
Run a ‘Compare’ action, in order to observe the matches, and mark up colours on both the 2D/3D models of
the Valve V110.
The location of the new component selected by dragging the selection along the pipe to its required
position
Schematic items which are matched to existing 3D items will not have its schematic data built into a 3D
item
The rules which control the building of Schematic data into 3D items are defined in the project
configuration explorer
Refer to (TM-1875) AVEVA Everything3D™ Schematic 3D Integrator (Administration), for the setup and
configuration of the Project configuration explorer
Exercise 6
4. Select schematic items ‘/SC_SW1001’, ‘/SC_SW1002’ and ‘/SC_SW1003’ from the Main table (Ctrl
+ select) and Build from the context menu
5. Display the ‘Equipment Details’ form for each selected equipment, observe and modify as required
9. Select, Unlink and delete the existing Pipe ‘PIPE 80-B-14’ from beneath the ZONE PIPES in the
Design explorer
10. Select the line entry ‘/80-B-14’ from the Schematic Main table, and Build from its context menu
11. Complete the creation of 3D pipes with the Pipe Router feature
Worked Example
This section attempts to describe a standard usage procedure for the Schematic 3D Integrator. This
assumes that the 3D/schematic objects and P&ID exists, and the checking / comparison objectives have
already been defined. The training P&IDs (A0-01-2012-0001 and A0-01-2012-0002) will both be utilised.
The display and interaction of the P&IDs within E3D will be of the SVG format of the original drawing. The
drawing/P&ID could be one developed within the AVEVA Diagrams product, or from a third party
application obtained via an ISO 15926 xml format, and consolidated through the Schematic Model Manager.
This also assumes that the application has been correctly configured and setup by the administrator.
Define deliverables
On conclusion of the checking process, a set of deliverables will need to be output. These could be defined
as:
Excel Report (From Integrator report, or Main Tables)
XML file from Integrator report
Colour marked up P&ID
Identify items
It is a good practice to identify the items which will be required for comparison. This is simply ensuring that
the user has access to the 3D and 2D objects (Equipment, Pipelines, instruments etc.).
Also identify that schematic items available within the drawing can be selected (highlighted), as this will
ensure that they will be marked up after comparison
Selecting the schematic item on the main table (or Subtype) should have it highlighted on its associated
drawing. It is also possible to have schematic items which are not represented on a drawing
Select config
Comparison configuration can be defined according to the scope of checking required. A configuration could
be defined for checking just Equipment items, Pipes, or a combination of items. The definition of
Configuration is an administrator task and should be setup by the administrator prior to using the application.
For this demonstration, select the default ‘Full check’ configuration as shown:
Match items
Display and ensure the main table display ‘Schematic Equipment’ as its main object type
Multi select the listed equipment items and run the ‘compare’ action for items within both default training
drawings
Corresponding 3D models will be displayed as long as they are matched to the compared schematic
equipment.
Matching can be achieved from by the names of the items. It is also possible for pipes to be matched by
the use of defined matching key attributes and pipe components could be matched by their type and
sequence on the pipeline
Link items
To ensure for a persistent connection between the matching objects, a link can be initiated between the
matching 2D and 3D item.
Linking objects like inline pipe components could also aid for the correct matching of other unmatched inline
components up or down stream of the pipe line, which are out of sequence, or have no defined Names.
On the displayed Integrator report, Navigate to the ‘Link all matched elements’ entry within the ‘Edit’ menu
pick list. This would initiate a link between all matching 2D and 3D items available within the Integrator report
(Click the ‘Yes to All’ button on the first link form which is displayed).
Having Linked all the matching items, it is a good practice to re run the Compare action, as this will
ensure that the cmpsts attribute for each item will now carry a correct report against the compared item
Do note that the matching and batch linking activities can also be achieved with the Compare/Update
feature within E3D 2.1 as well.
Checking / Analysis
Having identified, matched and Linked the relevant items, comparisons and detailed checks to identify
issues (according to usage intent) can be carried out.
Users can analyse identified attribute differences, sequence differences, connections errors, mismatches, or
missing elements from within the Integrator report.
The icon tooltips of parent items will note if there are issues with the selected item, or if there are
aggregate issues (a member item has an issue)
The icon tooltips of parent items will note there are issues, until all issues are cleared within the
member items, before it indicates an ‘OK’ status
Corrections can be applied to mismatched attributes (based on the configured rule) within the integrator
report, or 2D or 3D items which report errors can have their corrections implemented within their authoring
application (E3D, or P&ID application).
Attribute differences, or missing items can be accepted for later corrections, according to requirement.
Output deliverables
Deliverables which can be output from the integrator application includes:
2. Excel format document, output from within the Integrator main table:
The output Excel document displays the contents of the main table which could include the cmpsts column,
and any other user defined columns.
3. XML format document, output from the Integrator report can be saved and re read. This will display the
report within its standard integrator interface.
Navigating to and clicking the ‘Open’ File menu entry will display the file picker form, with which the user can
navigate to a valid saved XML file, and display its contents (Within the Integrator report interface).
4. Colour marked up drawings can be printed off as well directly from the Diagram Viewer form:
Besides sending the marked up diagram to a designated printer, the diagram could also be sent to a PDF
publisher, and saved off in a PDF format.
The demonstrated procedures could be similarly applied for other main object types /items (Pipes, offline
instruments etc.), with the same deliverables methods.
The checking/analysis and corrections procedures could be run iteratively, until the user is satisfied that all
compared/checked items are correctly matched and error free (According to the project requirement).
8.1 Overview
For the E3D modellers who would like to quickly run comparisons/checks between 3D items and
corresponding schematic items can also switch to the ‘Integrator Mode’ to perform these actions.
The Integrator Mode provides the basic functions required for running quick comparisons as well as
updating mismatched 3D attribute values with schematic equivalents as required.
This user interaction with the Integrator within the Integrator mode has been made to be lite, and highly
intuitive for the user. Associated interfaces have been kept to the minimum, and comparison can be run
directly from the context menu of a selected 3D item (provided that item has a matching or linked schematic
equivalent)
Do note that prior to initiating the Integrator mode, it is a good practice to ensure that the relevant 3D
models have been matched and Linked to their corresponding 2D objects
All comparison rules and criteria will need to have been setup and configured within the Integrator
configuration explorer
The Integrator mode can be launched from its own dedicated button within the Piping or Equipment
contextual menus
The Integrator mode can also be launched from the power wheel contextual menu of a matching 3D item:
On the clicking the ‘Integrator Mode’ button, either from the Piping/Equipment contextual menu bars, or the
power wheel menu entries, the 3D graphical view takes on a Monochrome display.
This displays the graphical interface with a white background, and outlined forms of the 3D objects.
This display within the graphical view indicates that the models are ready to be compared / checked.
Clicking on the ‘Integrator Mode’ button again, would return the application to its previous state,
turning off the monochrome display, and disabling the use of the ‘Comparison’ functions
Comparison can be run by simply right click on a 3D item (preferably a pre matched item e.g. PIPE 250-B-5)
to display its power wheel, then clicking on the ‘Integrator Mode’ button to display a contextual wheel menu:
Click the ‘Compare’ menu entry, to initiate a comparison of the selected PIPE against its schematic
equivalent.
On conclusion of the comparison operation, the 3D model will be colour marked (utilising the comparison
colour defined for the utilised comparison configuration). The comparison results form will also be displayed.
The displayed results form lists basic identified issues (Attribute mismatches, errors etc.) within its tabbed
views. Each tabbed view contains any identified issue for the pipe elements. In this case, the first tab view is
dedicated to the results of the main pipe element, the second tab view lists issues from the branch(s)
comparison, and the last tab view lists issues from the comparison of the line components.
The results form allows for the quick view of any identified comparison issues, which are listed
according to the element types which were included in the comparison (Tabbed views)
The form itself is presented in a translucent style, meaning that the objects or other forms will be visible
through the form
Clicking on a tab would have the related 3D model zoomed into, and highlighted with a darker colour
shade
Clicking on the ‘Integrator Mode’ button again, would return the application to its previous state, turning
off the monochrome display, and disabling the use of the ‘Comparison’ functions
Within the displayed results form, display the ‘Pipe issues’ tab, select the listed issue (mismatched
Insulation spec ISPE), and update the 3D model with the value of the schematic value by clicking the ‘Copy
from Diagram’ button as shown:
The ‘Redo Compare’ button becomes highlighted with an orange colour, indicating that there changes
which have occurred, and the object should be re-compared.
Display the ‘Branch Issues’ tab and perform an ‘Accept difference’ for the ‘Missing element’ issue, then
update the 3D element with the ISPE of the schematic equivalent:
Navigate to the next available branch by clicking the ‘next’ button, and applying updates as
demonstrated
Display the ‘Components issue’ tab, and apply data updates as shown previously, ensuring to apply the
changes to all available components (using the navigation buttons).
Click the ‘View On Diagram’ button to display and highlight the schematic equivalent of the compared Pipe
250-B-5 on the diagram viewer.
It is also possible to run a ‘Comparison’ from the diagram viewer, by selecting the schematic object
(SCPLIN 200-B-4) and clicking the ‘Compare’ button on its context menu.
To view the result form, listing any identified issues from this comparison, select the compared 3D pipe
(SCPLIN 200-B-4), and display the power wheel and click the ‘Re-focus Panel’ menu entry to display the
result form for the pipe compared from the diagrams.
Data updates can be applied on the 3D model objects, just as was demonstrated earlier.
The full (standard) integrator report can also be displayed, and utilised for more detailed comparison
analysis, or apply detailed data updates / link objects as demonstrated earlier in this guide. This can be
displayed by clicking the ‘View Report’ menu entry from the SCPLIN 200-B-4 context menu on the
Diagram, or the ‘View Report’ context menu entry from the 3D equivalent object.
OR
Limit points on a schematic pipeline are used to mark up sections of the pipeline which should be compared
with a 3D Pipe. This allows for the partial comparison of a line, where the other section of that line has not
been modelled in 3D yet.
This could also be useful for ‘sectioning’ up a schematic pipeline to indicate and mimic how the pipe is
divided within 3D, as well as run the comparisons accordingly.
Prior to setting up limit points on a schematic line, a ‘Limit Point’ world would need to have been defined
and selected for the project. This limit point world would store the information relevant for this
functionality to work. This could be an administrative task
Refer to (TM-1875) AVEVA Everything3D™ Schematic 3D Integrator (Administration), for the definition
of Integrator Limit Points world
For this demonstration, limit points will be setup for (SCPLIN 100-B-2) the limit points will be setup to
compare a section of its first branch (SCPLIN 100-B-2/B-1).
Limit points can only be inserted in the diagram viewer from the Integrator Mode and not from the
diagram viewer in the Integrator contextual menu
Highlight (SCPLIN 100-B-2/B-1) on the diagram viewer by clicking on the branch on the schematic explorer:
The selection and highlight of the schematic branch, helps highlight the entire extent of the branch, as
the limit points will be placed on this branch
This highlighting indicates that the branch terminates at the Valve V109
Right click on the schematic branch within the Diagram viewer (upstream of the first displayed TEE), and set
a limit point as shown:
Next, select a point just upstream of the control Valve (LV-119), and set another limit point there as
demonstrated earlier (using the right click context menu) as shown:
The sectioned line (with the limit points) should look something like this:
Next enter values (tags) to identify the sections which have been implied by the limit points. This can be
achieved by double clicking on the areas next to the arrow, to display a text field, and entering a required
value:
Pipe areas sectioned by the limit points should now be marked off as shown:
Entire marked off areas can be also be easily identifiable, by clicking the ‘Identify Area’ menu entry from the
line right click context menu:
The colour highlighted area represents the entire section covered within the marked limit points area
(Section B).
A comparison of only the marked off section (for example Section B) of the pipe can now be initiated as
normal, using the standard ‘Compare’ button from the context menu of the schematic line:
Just as shown above, the compared marked off area with all of their components will be colour coded (with
integrator comparison colours) on both the schematic and 3D models.
From within the context menu from the 3D model, the ‘Refocus Panel’ menu entry of the ‘Integrator Mode’
could be utilised to display the comparison result form for the compared pipe section;
Just as demonstrated earlier, the form will display identified issues within a tab view, according to the
compared elements (Pipe, Branch and components)
For any identified issue, the standard controls within the results form could be used to resolve some of
the issues e.g., ‘Accept Differences’, ‘Copy from Diagram’ etc. just as was demonstrated earlier in
Section 8.4
Comparison Colours, including limit points colour highlights from the ‘Identify Area’ function can be reset on
the diagram viewer with the ‘Reset Colours’ menu entry, within the right click context menu of either the
schematic line, or the diagram itself:
Resetting the colours, ensures that the line colour highlighting gets cleared out, as shown above.
Comparison colours within the 3D models can also be reset in a similar fashion, with the ‘Reset Colours’
menu entry, from the integrator mode of the power wheel this clears out all comparison colours:
Limit Points marks can either be hidden off from view on the diagram, or the limit points can be deleted
completely.
Exercise 6
1. From within the Integrator mode, compare the 3D Pipes (/100-B-1, /100-B-2, /150-A-3, /200-B-4,
/150-B-6 and /100-B-8) and observe the issues reported within the results form
2. Correct and Update the issues identified from the compared 3D models
3. Display the related diagrams from the context menu within the power wheel context menu
Schematic items whose data are to be utilised, will have to be first ‘Released to 3D’ from the authoring tool.
HVAC Designer application mode must first be selected for the Design module, prior to commencing with
the build.
Set the Main Object Type of the Main Table to HVAC lines then select the schematic HVAC item /TRA001-
RECT either from the Diagram Viewer or Main table and the Build entry from its context menu.
This action creates 3D HVAC inline components, with which full 3D HVAC lines can be modelled via the
HVAC designer.
The built HVAC line is highlighted on the Diagram with a cyan colour, similarly to build Equipment, Pipelines,
pipe components etc.
The HVAC fittings and components can be manipulated into a detailed HVAC line design via the HVAC
designer, as this assists with filling in the ducts. Utilise the functions within the ‘Tools’ group of the
HVAC contextual menu (Show Gaps or Fill Gaps)
Refer to (TM-1817) - AVEVA Everything3D™ Heating, Ventilating and Air Conditioning Modelling
Training Guide for detailed information on HVAC modelling
These Schematic Cables whose data are to be utilised, will have to be first ‘Released to 3D’ from the
authoring tool.
Cabling system application mode must first be selected prior to commencing with the build.
Set the Main Object Type of the Main Table to Schematic Cables then select the schematic cable item
/HVS001 either from the Diagram Viewer or Main table and the Build entry from its context menu.
This action creates 3D element on the Design explorer, with which full 3D cable lines can be modelled via
the Cable router.
The built Cable is highlighted on the Diagram with a cyan colour, similarly to build Equipment, Pipelines,
pipe components etc.
3D cables can be generated and routed with the Cable Data utility. Utilise the functions within the
‘Tools’ group of the Cabling System contextual menu
Refer to (TM-1815) - AVEVA Everything3D™ Cableway and Cable Modelling Training Guide for
detailed information on modelling cables
When the Integrator builds in 3D it carries out a set of actions under the control of the Project Configuration
Rules which is covered in the Schematic 3D Integrator Administration Guide.
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).
SUBEquipment are created for schematic sub equipment. Integrator will report unmatched 3D
SUBEs for information and not as errors, on the basis that there are likely to be more sub-
equipment in 3D than on a diagram as there will be more detail. However, unmatched
SCSUBEs will be reported as errors.
NOZZles are created for each schematic nozzle. Integrator will match nozzles at different levels
in the hierarchy, e.g. A NOZZle in a TMPL below a SUBEquipment may be matched to a
SCNOZZle directly below a SCEQUIpment. This allows nozzles in 3D to be grouped on
SUBEquipments even though there is no parallel schematic hierarchy.
ELCONNs will be created for each schematic electrical connection.
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.
If a catalogue reference has been set on a schematic nozzle or electrical connection it will be
copied to the NOZZle or ELCONN. The user has an opportunity to modify the specification later
in the build process.
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.
The schematic and 3D objects are linked.
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.
When the Integrator builds pipe work 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.
BRANches are created equivalent to the schematic branches.
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.
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.
Connection references are set in accordance with schematic connectivity if the connecting
objects exist in 3D. This includes branch head and tail references, nozzle connection
references, component connection references and connection reference arrays.
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 schematic and 3D objects are linked.
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.
Where a number of interconnected schematic pipelines are to be built in 3D, it is recommended
to build the main line first, before building offlegs.
Building Missing Components - Integrator can build missing piping components from the Integrator
Report form
Building Multiple Pipes for a Single Schematic Pipeline - Currently it is not possible to automatically
build part of a schematic pipeline into a pipe, or to automatically build several pipes from a single
schematic pipeline. If a schematic pipeline is to be represented in 3D as multiple pipes, each pipe must
be created using the Pipework application, and then linked to the schematic pipeline. Individual
components could then be built in 3D from the Integrator Report form
Integrator builds HVAC in 3D using a process that is equivalent to that for creating pipe work, 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 Plant
executables folder. Integrator will look for this file first in the %<proj>dflts%\modelmanagement folder and
then in the main executables 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.
The information used by Integrator to determine the appropriate component in 3D depends on the following
attributes of the SCHVFI (schematic HVAC fitting) object.
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 criterion would be a rectangular, three-way 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 more information on SCSTYP see the AVEVA Plant Diagrams HVAC Designer (TM-2212) Training
Guide
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
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.
Attribute values can be set on CABLES in accordance with the rules.
When a Schematic Multi-Cable (SCMCAB) is selected in the Diagram View, all its child
Schematic Cables (SCCAB) will be selected in the Main Table. When an SCCAB that is a
member of an SCMCAB is selected in the Main Table, its owning SCMCAB will be selected in
the Diagram View. Its sibling SCCABs may be automatically selected in the Main Table via
Select All Cables in the Multi-Cable command in the right click context menu.
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
Integrator builds offline instruments in 3D as equipment. In this context, offline instruments are instruments
remote from the pipe work (as opposed to instruments modelled as branch members even if they are
located off the centreline of the pipe).
APPENDIX C
3 Appendix C
When the Integrator builds in 3D it carries out a set of actions under the control of the Project Configuration
Rules which is covered in the Schematic 3D Integrator Administration Guide.
Integrator automatically ignores MDS trunnions. Trunnions are identified as any 3D branch with attribute
:MDSTrun TRUE. This means any trunnion defined in an application other than MDS can be handled in the
same way by setting this UDA. Four connection scenarios are handled:
An MDS cross will be matched with a schematic tee
An MDS reducer will be matched with a two way schematic reducer
An MDS elbow will be treated like a two way elbow and thus not significant for comparison
An MDS set-on tee will be ignored and thus not matched or treated as missing
Note that differences in the SPREF attribute for an MDS cross or reducer will be ignored and will not be
available to copy to 3D in the compare report
4 Appendix D
During the use of the standard integrator application, the user can select a comparison configuration
which has been pre created according to their comparison requirement. (See section 4.1)
The selection of the comparison configuration is performed from within the Integrator contextual menu:
For the use of the integrator within the ‘Integrator Mode’, the correct / required comparison configuration
will need to be setup prior to use. This can be done from the ‘Project Options’ section of the E3D 2.1
application:
Comparison configurations could be set from this location, without the need to switch into the full / standard
integrator application, as this would be the default comparison configuration which the integrator mechanism
will utilise for all comparison operations.