Sie sind auf Seite 1von 53

Compare/Update

User Guide
AVEVA Solutions Limited

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
Copyright and all other intellectual property rights in this manual and the associated software, and every part of it
(including source code, object code, any data contained in it, the manual and any other documentation supplied
with it) belongs to, or is validly licensed by, AVEVA Solutions Limited or its subsidiaries.

All rights are reserved to AVEVA Solutions Limited and its subsidiaries. The information contained in this document
is commercially sensitive, and shall not be copied, reproduced, stored in a retrieval system, or transmitted without
the prior written permission of AVEVA Solutions Limited. Where such permission is granted, it expressly requires
that this copyright notice, and the above disclaimer, is prominently displayed at the beginning of every copy that is
made.

The manual and associated documentation may not be adapted, reproduced, or copied, in any material or
electronic form, without the prior written permission of AVEVA Solutions Limited. The user may not reverse
engineer, decompile, copy, or adapt the software. Neither the whole, nor part of the software described in this
publication may be incorporated into any third-party software, product, machine, or system without the prior written
permission of AVEVA Solutions Limited, save as permitted by law. Any such unauthorised action is strictly
prohibited, and may give rise to civil liabilities and criminal prosecution.

The AVEVA software described in this guide is to be installed and operated strictly in accordance with the terms
and conditions of the respective software licences, and in accordance with the relevant User Documentation.
Unauthorised or unlicensed use of the software is strictly prohibited.

Copyright 2010 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved. AVEVA shall not
be liable for any breach or infringement of a third party's intellectual property rights where such breach results from
a user's modification of the AVEVA software or associated documentation.

AVEVA Solutions Limited, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom.

Trademark
AVEVA and Tribon are registered trademarks of AVEVA Solutions Limited or its subsidiaries. Unauthorised use of
the AVEVA or Tribon trademarks is strictly forbidden.

AVEVA product/software names are trademarks or registered trademarks of AVEVA Solutions Limited or its
subsidiaries, registered in the UK, Europe and other countries (worldwide).

The copyright, trademark rights, or other intellectual property rights in any other product or software, its name or
logo belongs to its respective owner.
Compare/Update User Guide

Revision Sheet

Date Version Comments / Remarks


September 2011 12.1.1 Issued
January 2012 Copyright added to all pages.
January 2013 AVEVA Everything3D added as a compatible product.

Side-by Side view added in section Display of Comparison


Results.
Clarification of unlinking
March 2014 Engineering 14.1 update
April 2015 Engineering 14.1.SP1 update
May 2015 Backport to PDMS 12.1.SP4
Compare/Update User Guide
Compare/Update User Guide

Compare/Update User Guide

Contents Page

Compare/Update
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Assumptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Guide Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:2
Product Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:2
References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:2

Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1


Compare and Update Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
Instrumentation, Electrical and P&ID Elements Matching . . . . . . . . . . . . . . . . . 3:2
Dabacon Elements Matching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2
Display of Comparison Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:3
Element Grid Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:5
Accept Changes for Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:6
Linking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:7
Update the Target Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:7
Using Compare/Update from PML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:13
Customising Compare/Update using PML Callbacks. . . . . . . . . . . . . . . . . . . . 3:16

Options and Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1


Grid Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1

Copyright 2010 to current year. i 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide

Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:6
Link Database Administration including Global Projects . . . . . . . . . . . . . . . . 4:17
Integration UDA Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:18

Copyright 2010 to current year. ii 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Introduction

1 Introduction

The Compare/Update User Guide describes how to configure and use the Compare/Update
application. Compare/Update can integrate data between Dabacon Design, Schematic and
Engineering databases, as well as data from AVEVA Instrumentation, Electrical and P&ID
into these Dabacon databases. When integrating between two Dabacon databases, it adds
the capability to link objects using the linking functions shared with Schematic 3D Integrator.
Compare/Update is currently used in the following products:
AVEVA Diagrams
AVEVA Engineering
AVEVA Everything3D
AVEVA Marine Outfitting
AVEVA Paragon (Electrical Application Only)
AVEVA Plant DESIGN
AVEVA Schematic Model Manager
AVEVA Tags.
The Update/Compare User Guide describes the generic configuration tasks required to use
the application, and highlights where any host product specific configuration is required.
The use of this application is then explained, and again where host product specific
differences occur these are highlighted.

1.1 Assumptions.
The Compare/Update User Guide is designed for use by administrators and users of the
above products.
It is assumed that:
Users have installed the required products, and have the valid licenses to run them.
Users have a working knowledge of the product which will host the Compare/Update
application.
Design and Outfitting users who want to integrate with Engineering or Schematic data,
will also need to be running in Integrated Mode.

Copyright 2010 to current year. 1:1 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Introduction

1.2 Guide Structure


The Compare/Update User Guide is divided into the following sections:

Introduction introduces the Compare/Update application.

Getting Started explains how to get working with the application.

Compare and Update Data explains how the compare and update processes work.

Options and Mapping explains how to configure the behaviour of the application.

1.3 Product Compatibility


AVEVA Compare/Update can be used with the following products and subsequent versions:
AVEVA Everything3D
AVEVA PDMS 12.1.SP2
AVEVA Marine 12.1.SP2
AVEVA Diagrams 12.1.SP2
AVEVA Engineering 12.1.SP2.

1.4 References
The following User Guides will provide supporting or complementary information.
AVEVA Diagrams User Guide
AVEVA Schematic Model Manager User Guide
AVEVA Tags User Guide
AVEVA Instrumentation Engineer and Wiring Manager User Guides
AVEVA Electrical Engineer and Wiring Manager User Guides
AVEVA P&ID User Guide
Cable Design User Guide
Catalogues and Specifications User Guide

Copyright 2010 to current year. 1:2 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Getting Started

2 Getting Started

Compare/Update is a generic capability in AVEVA products to compare object data across


different data sources and products. It uses the concepts of source data, being a reference
set of objects in another database, and destination data, being the corresponding objects in
the current database. So for example, to a user working in 3D and referring to their
engineering data, their source data could be engineering linelist objects and their
destination data could be 3D pipes.
Compare/Update can be used in Scope by Source mode. This provides the capability to
synchronise populations of objects. It takes as its scope the set of objects of a chosen type
from the source database and looks for matching objects in the destination database. It will
report any objects missing from the destination database and any differences on those
objects for which a match has been found. You can then choose which objects to update,
automatically instantiating missing objects and copying over attribute data.
When used in Scope by Destination mode, Compare/Update provides the capability to verify
the objects in your current scope of work. This can be the current drawlist in Design or
Outfitting, the current diagram view in Diagrams or Schematic Model Manager, or the
current list in Tags. If a graphical selection has been made in the 3D view, diagram view or
list, then the scope is further reduced to those objects that have been selected. The scope
can also be the Current Element. Compare/Update will report any objects that are not
present in the source database and any differences on those objects for which a match has
been found. The user can then choose which objects to update, automatically copying over
attribute data.
Compare/Update will not carry out object deletions but the comparison results can be used
to trigger a manual process.
Compare/Update is available in Engineering, Diagrams, PDMS and Marine products, it is
invoked either from the Manage tab or from the Display or View menu.

Note: In PARAGON, it is available from the Utilities in the Electrical Application only.

Compare/Update is initially shown in Scope by Source mode.

Copyright 2010 to current year. 2:1 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Getting Started

Click in the Source drop-down list to select from the available data sources.
Depending on the host module and the available data sources, the list could include:
AVEVA Electrical
AVEVA Instrumentation
AVEVA P&ID
Schematic Database
Engineering Database
Design Database
The default database type for the host module will not be listed, as that is always the target
for comparison and update. (The exception is Engineering which is allowed as both source
and target). A source will also not be listed if there are no available databases of that type.
Selecting AVEVA Instrumentation, AVEVA Electrical or AVEVA P&ID will show the
appropriate Login option.

Click Login and select the desired Instrumentation, Electrical or P&ID project from the list.

Copyright 2010 to current year. 2:2 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Getting Started

Click Select, and when prompted, enter the username and password for that project. Then
select the desired source group. The available groups from AVEVA Instrumentation or
Electrical depend on the host module and can include Instruments, Loops, Equipment,
Cables and Cable Catalogue items. The available groups from AVEVA P&ID are the P&ID
types Equipment, Instrument, Line, LineFitting, Nozzle and Valve.
Selecting a Dabacon source will show the available source configurations.

If element filtering has not been set up, you may do this now. Click Filters to display the
Filter window and define one or more filters. Refer to Filter for further information.

Note: A previously saved filter will be applied to the source data. If the filter prevents
display of the data, modify the Filter settings, then click Refresh in the toolbar in
order to proceed with the compare process.

Select the desired source configurations. The default configurations consist of Equipment,
Pipelines/Pipes, Instruments, Valves and Piping Specials. The mapped schematic and
design types for each configuration are available, but engineering types depend on project
setup and so engineering configurations will not be available unless they have been
defined. Other configurations can be defined by the administrator. Refer to Options for
further information.
If configurations have previously been set up, the compare process will start automatically.
Compare/Update can be invoked directly in Scope by Destination mode using the other
options from the tab or menu. For example in Tags select Compare Current List.

Or in Design select the menu option Compare Current Selection. A list of available
configurations will be displayed.

Copyright 2010 to current year. 2:3 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Getting Started

Select the required configuration and click Open to run the comparison.
Within the Compare/Update tab or toolbar switch modes by clicking By Source or By
Destination.

Copyright 2010 to current year. 2:4 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Compare and Update Data

3 Compare and Update Data

If the Configuration has been setup the compare process starts automatically following login
or selection of source group. A progress bar is displayed as it proceeds.

3.1 Filter
The Filter window controls which elements will be retrieved from source data. Filtering can
be used to limit the number of rows displayed in the grid when a large number of matching
elements are present in the source data project. To display the Filter window, click Filters
on the main toolbar.

Two types of filters can be entered. The first is on attribute values. The second is on the
evaluation of a PML expression. Click the appropriate Add Filter to add a row.

Copyright 2010 to current year. 3:1 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Compare and Update Data

For the attribute filter select the attribute, operator and value. The available operators will be
appropriate to the data type of the selected attribute.
For the expression filter enter a PML expression.

Note: Multiple filters will be joined with AND when generating the query.

Click OK to save the filter.


To delete a filter, select the row and click Delete Filter.
To re-read the data from source data and repeat the compare process, click Refresh in the
toolbar.

3.2 Instrumentation, Electrical and P&ID Elements


Matching
Instrumentation, Electrical and P&ID element matching uses the following criteria:
If element data from the target database (e.g. Schematics) had previously been
imported into AVEVA Instrumentation, Electrical or P&ID, the Dabacon references will
have been stored in there. If available these will be used as the first attempt to match.
If AVEVA Instrumentation, Electrical or P&ID data have previously been imported into
the target database, and the integration UDA was available, the AVEVA
Instrumentation, Electrical or P&ID database references will have been stored in the
UDA. If available these will be used as the second attempt to match.
Note: If the UDA is not available this step will be skipped. Refer to Integration UDA
Definition for further information.

For Instrumentation, if the first two attempts have not generated a match, the third
attempt will match on the default criteria of Tag or Loop as appropriate.
Instruments from AVEVA Instrumentation can be matched to Dabacon types Instrument,
Equipment and Subequipment. This gives the capability for example to separate
instruments into inline, offline mounted and offline non-mounted.

3.3 Dabacon Elements Matching


Dabacon elements are matched for mapped types. Design and schematic types are fixed
for each source group. Type mapping for UDETs is as per their basetype.

Source Group Design Schematic


Pipelines / Pipes PIPE SCPLIN
Equipment EQUI SCEQUI
Instruments INST SCINST, SCOINS
Valves VALV, VTWAY, VFWAY SCVALV
Named items only Named items only
Piping Specials Piping BRAN members SCFITT
Named items only Named items only
Excluding instruments, valves, ATTAs,
WELDs, and HVAC fittings

Copyright 2010 to current year. 3:2 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Compare and Update Data

Engineering types are all UDETs with basetype ENGITEM. Each source group can have
one or more UDETs mapped against it. For example, the Engineering Equipment group may
have :ELECEQUIP and :MECHEQUIP both mapped.

Note: For valves and piping specials, only named elements are compared. Unnamed
elements are considered to be bulk items.

Note: Compare/Update is not able to insert Valves and Piping Specials as the insertion
point for such items should be considered carefully and appropriate items created
using the relevant application, e.g. Design Pipework

By default, matching of all elements is by Name.


The recommended alternative for matching of pipelines to pipes is by key attributes, to
support the one to many relationships where one pipeline (schematic or engineering) may
be modelled in 3D as multiple pipes. Key attribute matching uses a combination of several
attribute values to identify matching 3D pipes for a source schematic or engineering line. For
example, several pipes may be matched to a single line according to their values for line
number, bore, pipe specification and duty. Key attribute matching must be setup using
Advanced Configuration.

Note: When working with many to one matches (such as would occur in Tags using key
attribute matching to compare engineering lines against Design Pipes), Compare/
Update is not able to insert or update elements. The only permitted operations are
link and unlink.

Note: If elements have been linked, this takes precedence over the rules for matching.
Linked elements will be treated as matched even if, for example, their names have
been changed so they no longer match. Refer to Linking.

3.4 Display of Comparison Results


The results of the compare process will be displayed in the grid view. The Elements Tab
lists the elements matched against the selected source, along with the number of compared
elements that have differences. The example shown below has instruments from AVEVA
Instrumentation.

The Attribute Details tab lists the individual attribute differences for selected or all elements
in the Elements tab.

Copyright 2010 to current year. 3:3 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Compare and Update Data

Note: If the results from AVEVA P&ID are blank refer to Setting up AVEVA P&ID to Connect
with PDMS Tags in the AVEVA P&ID User Guide and make sure all the steps have
been taken.

The mapped attributes for a single element can be displayed by selecting Side-by-Side
View in the tab or toolbar. This view lists the target database attributes along with the
current values in the source and target databases. The button has options to list All
Mapped Attributes or Differences Only.

The Side-by-Side View grid is populated only if a single row is selected in the Elements
Grid. In the Side-by-Side grid a right click menu allows immediate copying of one or more
values to the target database.

Copyright 2010 to current year. 3:4 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Compare and Update Data

Where the comparison includes a parent/child hierarchy, individual levels can be expanded
or collapsed by clicking on the "+" and "-" cells.

3.5 Element Grid Details


The Element Grid lists the elements retrieved from the source database and compared
against the target database. The following columns are always displayed:
The Accept column displays check boxes showing the current choice for how data will be
updated.

State Description
Checked If matched, this element may be linked and/or have all its mapped
attributes updated in the target database.
When not matched, this element will be created in the target
database, and may be linked and/or have all its mapped attributes
updated in the target database.
Semi-checked Some of the mapped attributes for this element will be updated in the
target database.
Unchecked No element will be created or linked and no attributes for this element
will be updated in the target database.
Unchecked and This can occur when the element is not matched in Schematic Model
disabled Manager. Here element creation from Compare/Update is not allowed
as data there is authored in another system.
It can also occur when an element is matched to an inappropriate
type.

The Matched column displays five possible options.

Value Description
Yes There is a matching object in the target database.
No There is no matching object in the target database.

Copyright 2010 to current year. 3:5 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Compare and Update Data

Multiple Matches One element in the source database is matched by multiple elements
in the target database. This occurs when pipes are matched by key
attributes to a pipeline. There will be one row for each matched
individual element. This situation occurs only when comparing
between two Dabacon databases.
Linked The element in the target database is linked to an element in the
source database. This situation occurs only when comparing between
two Dabacon databases.
Multiple Links Multiple elements in the target database are linked to an element in
the source database. This situation occurs only when comparing
between two Dabacon databases.

The Matched Against column lists the type of matching object in the target database.

Value Description
One of the types allowed for this When the element is matched to an appropriate
particular match, or a UDET based type.
on one of those types
Wrong type: <type> When the element is matched but not to an
appropriate type.
Not Matched When the element is not matched.

The No. of Changes column lists how many attribute changes are available for update.

Note: Only the attributes selected in Attribute Mapping are considered for comparison.
Other attributes which are not selected for Attribute Mapping are not considered
even if there may be mismatches between them.

The Changed Attributes column displays a comma separated list of the attributes which
have changes available for update.
The Attributes to be Updated column displays a comma separated list of the attributes
which have changes available for update and which you have chosen to be updated.

3.6 Accept Changes for Update


Use the following methods to accept which attributes should be updated:
Use the Accept options in the tab or toolbar to accept or reject available changes on
the elements compared.
All Displayed accepts all displayed rows including inserting new objects and
updating attribute values.
All Linked accepts all linked objects and is useful in order to unlink.
All Matched accepts all matched objects and is useful to link objects and/or update
attribute values.
All Unmatched accepts all unmatched objects and is useful to insert new objects.
None clears the current acceptance selection.
Use the Accept check boxes in the Elements tab to accept or reject all available
changes for individual elements.

Copyright 2010 to current year. 3:6 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Compare and Update Data

Use the Accept check boxes in the Attributes Details tab to accept or reject individual
changes for individual elements.
Selecting one or more rows in either tab will automatically select all the corresponding rows
in the other tab, and will set the current element to the first in the selection.
Selecting an element in the module specific Explorer will select the corresponding rows in
the currently displayed tab if that element is available for update in the tab.

Note: The setting of the Accept option is remembered across sessions, so that all available
changes can be accepted or rejected by default according to the last used setting.

3.7 Linking
Compare/Update can link matched elements when both the source and target are Dabacon
databases. The mechanism used is shared with Schematic 3D Integrator so that any links
are consistent. The link information is stored on a CYMLNK object not normally visible to
you. This has references to the linked objects. The deslnk, schlnk and englnk pseudo
attributes can be used as direct references between linked items to populate data on reports
and other deliverables.

Note: The setting of the Accept All check box is remembered across sessions, so that all
available changes can be accepted or rejected by default according to the last used
setting.

3.8 Update the Target Database


Click Update Database to review and apply all the accepted changes to the target
database.

Copyright 2010 to current year. 3:7 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Compare and Update Data

The following sub-sections describe the process of updating the target database for a
selection of supported database types.

Note: The Update Database window adapts to the different results so as to show only
relevant sections. For example if there are no linked items to update then that section
will not appear.

Update the Schematic Database


This example shows an update of a schematic database with instrument data from AVEVA
Instrumentation. The Update Database dialogue shows the statistics from the compare
process and the choices that have been made for accepting changes.

Click UpdateDB to apply these updates. Once the update process has completed, the
results summary will be displayed.

Copyright 2010 to current year. 3:8 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Compare and Update Data

Note: If an update error occurs for a particular attribute, only that attribute will fail to update.
Other attributes on the same element will still be updated if possible.

The grid view will be updated to display any messages and errors, highlighting in the
appropriate feedback colours.

Update the Catalogue Database


This example shows an update in Paragon of cable catalogue data from AVEVA
Instrumentation.

Copyright 2010 to current year. 3:9 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Compare and Update Data

Selecting Owner for an Element


In order to add a new cable catalogue entry, four elements need to be created in the
Catalogue database and one element in the Property database. Owners must be selected
under which new elements will be created.

The button next to an element will when clicked display the Select Database Element
window for owner selection.

Copyright 2010 to current year. 3:10 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Compare and Update Data

The following table lists the element to be added along with its valid owner

Element Type Valid Owner(s)


TABITEM CTABLE
GPART PRTWLD or PRTELE
SCOMPONENT SECTION or CATEGORY
CCORSET SECTION or CATEGORY
CABDATA CMPTYPE

Update the Design Database


A similar process can be used to update a design database with cable, equipment and
instrument data from AVEVA Instrumentation, or cable and equipment data from AVEVA
Electrical.

Note: Before adding a cable element in the design database, make sure that the
associated cable catalogue, start equipment and end equipment are present in the
database. Without the associated elements a cable cannot be added to the design
database and an error message will be displayed in the grid.

Note: Even if there are no attribute updates to be made, there may still be data updates for
source or target database references or internally mapped elements, resulting from
the matching process. Refer to Instrumentation, Electrical and P&ID Elements
Matching for further details.

Update one Dabacon Database from Another Dabacon Database


This example shows update of a design database with equipment data from an engineering
database. The process is similar to those described above with the addition of options to
handle linking.

Copyright 2010 to current year. 3:11 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Compare and Update Data

Updating between Dabacon sources includes options for linking. Select from the following:
Link inserted items - when creating a new item in the target database, automatically link
it to the source item.
Link matched items - automatically link a matched target item to the source item.
Update attributes for linked items - only use this if you want that data directly on the
target item. Once the item is linked, you can reference that data from the linked source,
e.g. from Design, use description of schlnk to get the linked schematic item's
description in a report.
Unlink selected items - use this option if you have selected items in the grid that you
want to unlink.
Note: When unlinking selected items, it is the destination item that is unlinked. For
example, when design, schematic and engineering items are linked together,
performing the unlink operation in Design will unlink the design item from the other
two (irrespective of the source database selection), leaving the schematic and
engineering items linked to each other.

Click Update to apply these updates.

Copyright 2010 to current year. 3:12 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Compare and Update Data

3.9 Using Compare/Update from PML


The main functions of Compare/Update can be called from PML using the CompareUpdate
PML object. The following methods provide the equivalent of the main interactive functions.

Method Description
selectDesign() Select Design database source
selectSchematic() Select Schematic database source
selectEngineering() Select Engineering database source
compareEquipment() Compare Equipment list
compareLines() Compare Lines list
comparePipes() Compare Pipes list
compareInstruments() Compare Instruments list
compareValves() Compare Valves list
comparePipingSpecials() Compare Piping Specials list
compare(STRING Compare a named configuration
configuration name)
owner(STRING owner name ) Set the name of the owner for inserted elements
acceptAllDisplayed() Accept all available changes including inserting new
objects and updating attribute values
acceptAllLinked() Accept linked objects (use this to unlink previously linked
objects or update attributes on linked objects)
acceptAllMatched() Accept all matched objects (use this to link all matched
objects)
acceptAllUnmatched() Accept all unmatched objects (use this to insert new
objects)
updateLink() Update the target database by inserting and linking
elements and updating attribute values
updateUnlink() Update the target database by unlinking elements
export( Following a compare operation, output the contents of
STRING elements file path, the two grids into the named files in csv format
STRING attributes file path)

Note: Integration with AVEVA Instrumentation, AVEVA Electrical and AVEVA P&ID are not
currently supported from the command line and are available only interactively.

These methods require options and mappings to have been configured interactively.
A typical macro could include:
!run = object CompareUpdate()
!run.selectEngineering()
!run.compareEquipment()

Copyright 2010 to current year. 3:13 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Compare and Update Data

!run.acceptAllDisplayed()
!run.updateLink()

MMTools Object
The MMTools object provides methods to link and unlink, objects that could be linked
interactively using Schematic 3D Integrator or Compare/Update can be linked in this way. To
use these methods the following initialisation is required at the top of each PML file (object,
function, or macro) where these methods are to be used.
import 'MMservices'
handle any
endhandle
The following initialisation is also required in each method, function or macro where the
diagram methods are to be called.
using namespace 'Aveva.Pdms.MMServices'
!mmTools = object mmTools()
The string arguments can be a name like /MyName or a reference like =123/45678. If
duplicate names are used, it is best to always use reference numbers to avoid confusion.
The array arguments are arrays of strings of the same format.
!mmTools.link(!Name1 is STRING, !Name2 is STRING)
!mmTools.unlink(!Name is STRING)
!mmTools.unlink(!Names is ARRAY)

Note: The MMTools object is not available in 12.1.SP4, use the following integrator object
instead:

Equivalent initialisation:
!!integratorInit()
Equivalent methods:
!!integrator.link(!Name1 is STRING, !Name2 is STRING)
!!integrator.unlink(!Name is STRING)
!!integrator.unlink(!Names is ARRAY)

MMViewer Object
The MMViewer object provides diagram viewer methods. To use these methods the
following initialisation is required at the top of each PML file (object, function, or macro)
where these methods are to be used.
import 'MMservices'
handle any
endhandle
The following initialisation is also required in each method, function or macro where the
diagram methods are to be called.
using namespace 'Aveva.Pdms.MMServices'
!mmViewer = object mmViewer()

Copyright 2010 to current year. 3:14 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Compare and Update Data

The following methods can be used to clear colours and close the current or all diagrams.
!mmViewer.resetDiagramColours()
!mmViewer.resetAllDiagramColours()
!mmViewer.closeDiagram()
!mmViewer.closeAllDiagrams()
The findOnDrawing method opens the diagram for one or more schematic objects and
highlights them.

Note: That the argument is an array.

If an object appears on more than one diagram, you will be prompted to choose which
diagram to open. This example shows how to view the linked schematic object for the
current element in 3D.
!itemList[1] = !!ce.schlnk.ref.string()
!mmViewer.findOnDrawing(!itemList)
Individual schematic objects can be coloured on the diagram view using the following
methods. Note that these methods do not open a diagram or select an object. The results
will be visible only if the relevant diagram is already open in the viewer.
!mmViewer.setColour(!Name is STRING, !Colour is STRING)
!mmViewer.setColour(!Name is STRING, !Colour is REAL

Note: The MMViewer object is not available in 12.1.SP4, use the following
IntegratorManager object instead:

Equivalent initialisation:
import 'IntegratorAddin'
handle any
endhandle
using namespace 'Aveva.Pdms.IntegratorAddin'
!intMan = object IntegratorManager()
Equivalent methods:
!intMan.resetDiagramColours()
!intMan.resetAllDiagramColours()
!intMan.closeDiagram()
!intMan.closeAllDiagrams()
!itemList[1] = !!ce.schlnk.ref.string()
!intMan.findOnDrawing(!itemList)
!intMan.setColour(!Name is STRING, !Colour is STRING)
!intMan.setColour(!Name is STRING, !Colour is REAL)

MMManageLinks Object

Note: This method should be used only when all of the databases holding objects that have
been linked are current on the MDB.

Copyright 2010 to current year. 3:15 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Compare and Update Data

The MMManageLinks object provides a method to validate and clean uplinks. To use this
method the following initialisation is required at the top of each PML file (object, function, or
macro) where this method is to be used.
import 'MMservices'
handle any
endhandle
The following initialisation is also required in each method, function or macro where the
method is to be called.
using namespace 'Aveva.Pdms.MMServices'
!!mmManageLinks = object mmManageLinks()
The validate method outputs a list of links and any errors to the command line. It cleans up
any link objects with invalid references, such as may have occurred when objects have
been deleted. It will also merge partially populated links, e.g. 3D object "A" is linked to
schematic object "A" by one link and schematic object "A" is linked to engineering object "A"
by another link, as can occur when links are created in separate extract databases.
!!mmManageLinks.validate()

Note: The MMManageLinks object is not available in 12.1.SP4, use the following integrator
object instead:

Use the equivalent initialisation


!!integratorInit()
Use the equivalent method:
!!Integrator.validateLinks()

3.10Customising Compare/Update using PML Callbacks


Specific company and project customisations can be implemented using PML callbacks.
A framework is provided in the cuProjectHandler PML object in the pmllib\common\objects
folder. A global instance !!cuProjectHandler of this object is created on entry to any module
using Compare/Update.

Note: Compare/Update PML callbacks are not available for cable catalogue operations.

Debug Mode
You can switch on or off debug mode using the commands cuDebugOn and cuDebugOff
which have been defined as synonyms to run the corresponding methods. In debug mode a
line of text is output to the command line for each method call.

Where to Add Code


Each place where customised code can be added is delimited as follows.

Copyright 2010 to current year. 3:16 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Compare and Update Data

Note: Other parts of the PML code should not be modified.

A number of examples are provided (commented out) in the PML code.

Methods
The following methods are provided in the cuProjectHandler PML object:

Method Description
.cuProjectHandler() Constructor
.debugOn() Set debug flag
.debugOff() Clear debug flag
.raiseEvents()is Switch events on or off.
BOOLEAN
Called once for each comparison run.
Return FALSE to prevent further callbacks.
.beginCompare( Add checks before comparing the whole set of objects.
!module is STRING, Information from the selected configuration is provided.
!configurationName Mode: Source or Destination
is STRING,
!sourceDatabase Return a non-blank message to abort the whole run.
is STRING,

!sourceType
is STRING,

!destinationDatabase
is STRING,
!destinationType
is STRING,
!mode is STRING
) is STRING
.beforeCompare( Add checks before comparing a source/destination object
!element is DBREF that is a DBREF.

) is STRING Return a non-blank message to skip comparison of this


object.

Copyright 2010 to current year. 3:17 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Compare and Update Data

.beforeCompare( Add checks before comparing a source object that is an


!elementId is STRING external named string.

) is STRING Return a non-blank message to skip comparison of this


object.
.afterCompare( Add actions after comparing a matched source object that
!compareOk is a DBREF.
is BOOLEAN, CompareResult: Yes, No, Multiple Matches, Linked,
!compareResult Multiple Link
is STRING,
!sourceElement
is DBREF,
!destinationElement
is DBREF
)
.afterCompare( Add actions after comparing a matched source object that
!compareOk is an external named string.
is BOOLEAN, CompareResult: Yes, No, Multiple Matches, Linked,
!compareResult Multiple Link
is STRING,
!sourceId is STRING,
!destinationElement is
DBREF
)
.afterCompare( Add actions after comparing an unmatched source or
!compareOk destination object that is a DBREF.
is BOOLEAN, CompareResult: Yes, No, Multiple Matches, Linked,
!compareResult Multiple Link
is STRING,
!element is DBREF
)
.afterCompare( Add actions after comparing an unmatched source object
!compareOk that is an external named string.
is BOOLEAN, CompareResult: Yes, No, Multiple Matches, Linked,
!compareResult Multiple Link
is STRING,
!sourceId is STRING
)
.endCompare() Add actions after comparing the whole set of objects.
is STRING
Return a csv file path to capture list of skipped objects and
reasons.
.getCompareResults() Capture the compare results grid content.
is STRING
Return an xls file path for compare grid result

Copyright 2010 to current year. 3:18 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Compare and Update Data

.beginUpdate( Add actions before updating the whole set of accepted


!linkInsertedElements objects.
is BOOLEAN, Settings from the Update dialogue are provided.
!linkMatchedElement
is BOOLEAN, Return a non-blank message to abort the whole update.

!updateLinkedInserted
Elements
is BOOLEAN,
!updateLinkedMatched
Elements
is BOOLEAN,
!unlinkElements
is BOOLEAN,
!ownerElement
is DBREF
) is STRING
.beforeUpdate( Add actions before updating when the matched source
!sourceElement object is a DBREF.
is DBREF, Return a non-blank message to skip update of this object
!destinationElement
is DBREF,
!destinationType
is STRING
) is STRING
.beforeUpdate( Add actions before updating when the matched source
!sourceId is STRING, object is an external named string.

!destinationElement Return a non-blank message to skip update of this object.


is DBREF,
!destinationType
is STRING
) is STRING
.beforeUpdate( Add actions before updating when the unmatched source
!sourceElement object is a DBREF.
is DBREF, Set ownerRef to override the owner specified for the run.
!destinationType
is STRING, Return a non-blank message to skip update of this object.

!ownerRef is DBREF
) is STRING
.beforeUpdate( Add actions before updating when the unmatched source
!sourceId is STRING, object is an external named string.

!destinationType Set ownerRef to override the owner specified for the run.
is STRING,
Return a non-blank message to skip update of this object.
!ownerRef is DBREF
) is STRING

Copyright 2010 to current year. 3:19 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Compare and Update Data

.beforeUpdate( Add actions before updating when the unmatched


!destinationElement destination object is a DBREF.
is DBREF, Return a non-blank message to skip update of this object.
!destinationType
is STRING
) is STRING
.afterUpdate( Add actions after updating when the matched source
!updateOk object is a DBREF.
is BOOLEAN, UpdateResult: Ok or error message
!updateResult
is STRING,
!sourceElement
is DBREF,
!destinationElement
is DBREF,
!updatedAttributes
is ARRAY
)
.afterUpdate( Add actions after updating when the unmatched source or
!updateOk destination object is a DBREF.
is BOOLEAN, UpdateResult: Ok or error message
!updateResult
is STRING,
!element is DBREF,
!updatedAttributes
is ARRAY
)
.afterUpdate( Add actions after updating when the unmatched source
!updateOk object is an external named string.
is BOOLEAN, UpdateResult: Ok or error message
!updateResult
is STRING,
!sourceId is STRING,
!updatedAttributes
is ARRAY
)
.endUpdate() Add actions after updating the whole set of objects.
.getUpdateResults() Capture the update results grid content.
is STRING
Return an xls file path for update grid results.

Copyright 2010 to current year. 3:20 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Options and Mapping

4 Options and Mapping

Options are provided in the toolbar and context menus to configure how the data will be
compared and displayed.

4.1 Grid Options


The grid has a configuration menu accessed via a right-click on any column title, and a
context menu accessed via a right-click in any row.

Column Setup
Column Setup allows you to choose which columns to display in the grid view and which
order to display them. To display the Column Setup window, right-click on any column title
and select Column Setup from the pop-up menu. The Column Setup dialogue contains the
standard columns for the grid along with the attribute columns for the source type.

Copyright 2010 to current year. 4:1 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Options and Mapping

To display a Column Name in the grid view, select the required check box in the Visible
column. Clearing a check box removes the Column Name from the grid view.
To change the position of a Column Name in the grid view, select the Column Name and
click either the up or down arrows.
Click OK to update the grid view.

Note: Grid layouts are automatically saved in the folder

C:\Documents and Settings\<Current User>\LocalSettings\Applicat


ion Data\Aveva\PDMS\SchematicInstrumentationAddin
with filenames like SchAiInstruments.xml or SchAiLoops.xml

Settings
Right-clicking on any column title and selecting Settings, displays a settings sub-menu:
Enable Filtering
Enable Column Summaries
Enable Column Sort
Feedback Colours
Enable Filtering allows you to display a filter row in the grid view. The filter row is used to
filter the grid to show only certain records. Instant "on the fly" filtering is achieved by
selecting the icon in the column field and selecting a value from the drop-down list.

Further filtering is available by selecting the small icon to the left of a column (field) caption,
selecting from the drop-down list and entering a value into the highlighted field. The grid
view will automatically refresh to reflect the selected criteria.

Copyright 2010 to current year. 4:2 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Options and Mapping

Enable Column Summaries displays the icon in the No of Changes column. Clicking
the icon displays the Select Summaries window.

You can check one or all the boxes and click OK to receive a count displayed at the end of
the No of Changes column.

Copyright 2010 to current year. 4:3 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Options and Mapping

Note: Clicking Refresh remove the count.

Enable Column Sort allows you to change the column order. Click and hold on the column
title and drag the column either left or right into a new position. Two arrows are displayed to
assist you in positioning the column.

Clicking Feedback Colours displays a sub-menu:

Note: New Element Row Colour is used when an element is not matched and Compare/
Update is able to insert it. The Not Matched Row Colour is used when an element is
not matched and Compare/Update is not able to insert it.

Clicking any of the options displays a Colour Selection window.

Copyright 2010 to current year. 4:4 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Options and Mapping

Selecting Reset Default Feedback Row Colours, reverts the options back to their default
colour settings.

New Element Row Colour Salmon

Not Matched Row Colour Grey

Matched With No Changes Row Colour White

Matched With Changes Row Colour Pale Yellow

Linked With No Changes Row Colour White

Linked With Changes Row Colour Pale Yellow

Update Fail Row Colour Red

Export to Excel
The current grid layout and contents can be saved to an Excel file. Right-click in any column
title and select Export to Excel, then enter a filename in the file browser window.

Print Preview
You can view a print preview of the current grid layout and content. Right-click in any
column title and select Print Preview.

Grid Context Menu


Instrument datasheets and details can be displayed when the target is the schematic
database and the source is AVEVA Instrumentation. Right-click in any row in the
Instruments or Loops grid view to display a context menu.
The Instruments grid view displays the following options:
Instrument Datasheet displays the AVEVA Instrumentation data sheet for the selected
instrument.
Instrument Details displays the AVEVA Instrumentation window for the selected
instrument.

Copyright 2010 to current year. 4:5 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Options and Mapping

The Loops grid view has one option:


Loop Details displays the AVEVA Instrumentation window for the selection loop.
Note: No context menu exists for the Attribute Details tab.

The diagram view can be displayed when the source is Schematics Database, the selected
source item appears on a diagram, and the SVG file is available for that diagram. Right-click
in any row in the Elements grid view to display a context menu. Show in Diagram displays
the diagram view for the selected source object.

4.2 Options
The types of elements that will be compared and how their attributes will be mapped are set
using the Options dialogue. From the main toolbar, select Options.

Manage Configuration
Element and attribute mapping is controlled using the Compare/Update Configuration
wizard. To create and edit configurations you must be a member of team CUADMIN. A
single configuration defines the source and target types of objects that will be compared,
and their attributes that will be mapped. The stages to define the configuration consist of:
1. Create a new configuration or choose an existing configuration to edit
2. Define the type of source object

Copyright 2010 to current year. 4:6 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Options and Mapping

3. Define the type of destination object


4. Define member element type mappings
5. Set whether to use advanced rules
6. Define an expression to identify destination owner objects
7. Define filters to be applied to the source object population
8. Map the attributes.
Click Manage Configuration.

Select to create a new configuration or to edit an existing configuration. The latter option will
display a list of existing configurations to select from.

Note: Certain out of the box configurations have specific behaviours associated with them
which are not available to new created configurations. These out of the box
configurations can be edited to add source filters and attribute mappings.

Note: In Diagrams, select the out of the box AVEVA Instrumentation source for Instruments
in order to compare a combined set of SCINSTRUMENTs and SCOINSTRUMENTs.

Note: In Paragon, select the out of the box AVEVA Instrumentation or Electrical source for
Cable Catalogue in order to compare the five destination types.

Click Next to continue.

Copyright 2010 to current year. 4:7 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Options and Mapping

The source data is the data that will be the basis of comparison.
Set Mode to Local if the source data is to be from a product installed on the same
computer.
Set Mode to Service if the source data is to be from the AVEVA Integration Service. The
window changes to show fields for Server Name, Port and Source. These should be set
according to the Service configuration.
Select the Source database from the drop-down list. If the source is AVEVA Electrical,
AVEVA Instrumentation or AVEVA P&ID, a Login button will appear. Click on this and log in
to the source system.
Enter the Display Name that will be used for this source list in the Compare/Update window
Either click on Element Type and select the type of object in the source database or click on
Group and select one of the pre-defined source groups. Source groups will be available
only in certain contexts such as Design Valves or Design Piping Specials where the group
represents a combination of element types.
Select the Name Attribute that is to be used for name matching, and the Unique Attribute
that is to be used for internal ids.
These are to be set as follows.

Copyright 2010 to current year. 4:8 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Options and Mapping

Database Type Name Attribute Unique Attribute

Dabacon All Name RefNo

Aveva Cable CableNo CableId


Instrumentation
and Electrical Cable Catalogue CatalogNo CableCatId

Equipment EquipmentNo EquipId

Instrument TagNo InstKEY

Loop LoopNo LoopKEY

Aveva P&ID All Label ID

Click Next to continue.

The target data is the data in the default database for the current session, for example: in
Tags it will be engineering data. Target data is compared against source data.
In Element Type select the type of object in the target database.

Copyright 2010 to current year. 4:9 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Options and Mapping

Enter the Display Name that will be used in the Attribute Mapping screen.
If Compare/Update finds unmatched objects, it can create corresponding new objects in the
target database. Check Allow insertion if this is to be allowed.
By default, inserted objects take the same name as their source objects. An optional Name
Prefix can be specified.
Check Create Reverse Configuration to automatically create a configuration with source
and target swapped (this option will be available only when both are Dabacon databases).
Click Next to continue.

If this configuration is to include parent/child hierarchy, select one or more member element
configurations. For example, a previously defined nozzle configuration can be selected as a
member for an equipment configuration.
Click Next to continue.

Copyright 2010 to current year. 4:10 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Options and Mapping

If advanced rules are required for this configuration, select a Project Configuration File
(this will usually be the default filename for the project, for example: for Sample project this
would be %SAMDFLTS%\ModelManagement\ProjectConfiguration.xml). Then select a
Rule Set and check Use Advanced Rules.
Select the Restrict the Configuration to Admin Users only check box, if you want to test
this configuration before publishing it for general use on the project.
Click Next to continue.
Select the Make this Configuration available standalone check box to allow end users to
be able to run it when it is not part of a group of configurations.

Copyright 2010 to current year. 4:11 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Options and Mapping

An optional Owner Expression can be entered. This will be evaluated against the
appropriate source object during the Update Database process to determine the owner for
an inserted object.
The expression can be tested by selecting an object of the appropriate source type and
pressing the Test button.
During the Update Database process, the precedence of determining the owner for an
inserted object will be:
From the parent/child hierarchy if updating using a child configuration
From a PML callback if defined
From the owner expression if defined
From the setting in the Update Database dialogue.

Copyright 2010 to current year. 4:12 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Options and Mapping

Add filters to limit the population of source data that will be used in the comparison. Note
that the end user will have the option to further filter the source data at run time.
Two types of filters can be entered. The first is on attribute values. The second is on the
evaluation of a PML expression. Click the appropriate Add Filter to add a row.
For the attribute filter select the attribute, operator and value. The available operators will be
appropriate to the data type of the selected attribute.
For the expression filter enter a PML expression.

Note: Multiple filters will joined with AND when generating the query.

Click Next to continue.

Copyright 2010 to current year. 4:13 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Options and Mapping

Certain out of the box configurations such as AVEVA Instrumentation Instruments and
AVEVA Electrical Cable Catalogue have specific behaviours to use multiple destination
types. In such cases select each Element Type in turn to define its attribute mappings.
Click Add Mapping to add an empty attribute mapping row to the list. On the source side do
one of the following:
Select an attribute from the drop down list.
Type the name of a pseudo attribute.
Type a PML expression, enclosed in brackets, for example: (DESC of OWNE). The
expression will not be evaluated at this point but will be evaluated at comparison time
against the source object.
Type a static value, to set a default value onto a target attribute. Any value entered in
this way will not be validated at this point.
Then on the destination side select an attribute from the drop down list.
Select a mapping row and click Delete Mapping to remove it.
Use the Allow Update check boxes to control which attributes will be compared only, and
which may be updated.
Click Finish to complete and save the configuration.

Copyright 2010 to current year. 4:14 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Options and Mapping

Note: Configuration files are saved in the project defaults folder, for example:
%samdflts%\CUConfigs2.0.

Advanced Configuration
Users who are members of team CUADMIN can set up advanced rules by clicking
Configuration Explorer. This displays the Project Configuration Explorer shared with
Schematic 3D Integrator. There you can configure more elaborate rules for element
matching and updating, in particular key attribute mapping to match multiple pipes against
schematic or engineering pipelines. An example set of rules using key attributes for
engineering to design matching is included in the out of the box ProjectConfiguration.xml
file. Refer to the Schematic 3D Integrator User Guide section on How to Configure Rules.

Note: A target attribute specified in an Assign Action must also be included in the attribute
mappings in order to appear in a results column. The source attribute in the mapping
will be overridden by the advanced configuration action.

Manage Groups
Members of the team CUADMIN can define groups of configurations to be run in a single
operation. Select Manage Groups to display the Manage Groups window.

Copyright 2010 to current year. 4:15 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Options and Mapping

Select the required source database then click Add and enter the name of the new group.
Select the Restrict this Group to Admin Users only check box, to test it before making it
available to the project.
Use the arrow buttons to choose which configurations will be in the group then select Apply.
A configuration can be in one or more groups and can also be available standalone if
marked as such. When running a Compare operation, users will be able to select from the
available groups and standalone configurations.

Manage Links
Users who are members of team CUADMIN can click on Manage Links to display this
window:

This is an administrative window used to manage Link Worlds. Before using it, create a
separate Design Reference database in Admin, and ensure it is current on all MDBs where
linking will occur, and all users who need to link can write to it.

Copyright 2010 to current year. 4:16 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Options and Mapping

Note: The Manage Links window is shared between Integrator and Compare/Update.
Design Reference databases can be written to by 3D, schematic and engineering
users.

The list includes all the Design and Design Reference databases available, identifying any
that contain links (links created prior to 12.1 reside in Design databases). The following
functions are available from the File menu or on a right click context menu.

Create Create a new Link World in the selected database.

Validate Output a list of links and any errors to the command line for the
selected database. This action will also merge partially populated
links, for example: 3D object "A" is linked to schematic object "A"
by one link and schematic object "A" is linked to engineering
object "A" by another link, as can occur when links are created in
separate extract databases.

Validate All As for Validate for all databases in the list.

Remove invalid Remove invalid references from links in the selected database.
references Invalid references can occur when elements are deleted and the
Link World database cannot be updated.

Caution: This operation should be used only when all of the databases holding objects
that have been linked are current on the MDB.

Properties Display the number of links in the selected database.

The Edit menu provides Cut, Copy, Paste and Delete functions to move Link Worlds
between databases. You can also drag and drop from one database to another to move or
merge a Link World.

4.3 Link Database Administration including Global


Projects
All Compare/Update users require write access to a single Link World (CYMWRL). If this is
not present when a Link function is performed then Compare/Update will return an error.
Project administrators are recommended to use the following procedures:
Create a separate Design Reference database in Admin, and ensure it is current on all
MDBs for Compare/Update users, and all Compare/Update users can write to it.
Use Manage Links to create a Link World in the new database, or to merge links from
an old link world (prior to 12.1 link worlds resided in Design databases).
For a global project, create variant extracts of the link world database and make one
extract primary at each location that needs to use Compare/Update. This will ensure
the link data can be issued back to the parent db and combined from the various
locations with no claim conflicts.
Links created prior to 12.1 reside in Design databases. These must be migrated to Design
Reference databases in order to be used by Compare/Update in schematic and engineering
modules. Project Administrators are recommended to use the following procedures:
If using extract databases, then in PDMS DESIGN or Marine Outfitting, use the Extract
Control form to select the existing CYMWRL and issue all changes. Repeat this step
for all levels of extract database. The next step should then be carried out in the parent
database.

Copyright 2010 to current year. 4:17 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Options and Mapping

In PDMS DESIGN or Marine Outfitting, use Manage Links to merge links from the
Design database to a new Design Reference database (e.g. by drag and drop). Then
click on the Design database and delete the old Links.
Refresh any extracts of the Design and Design Reference databases.
When working in an extract database, issuing, flushing or dropping an element that has a
referencing link will automatically include the link object. The reference array attribute
INCFLU (include flush) returns any link elements that reference the current element.
Flushing, issuing or dropping an element with referencing link objects will act on those link
objects even if the element itself is not claimed or modified. The Extract Control form will
display an "R" label on such elements.

4.4 Integration UDA Definition


The UDAs must be defined in LEXICON if the matching process is to use them for storing
source database references, refer to Instrumentation, Electrical and P&ID Elements
Matching.
The UDAs may be created in any UGROUP in a current dictionary database. If used in
conjunction with the specific module, it is suggested to include these UDAs in the same
group.
The Integration UDAs should be created as Indexed UDAs with the following details:

UDA Name(s) UDA Type UDA Length Element Types


pmg-sch-ai text 50 SCINSTRUMENT
SCOINSTRUMENT
SCLOOP
SCVALV
SCACTUATOR
pmg-sch-ae text 50 SCEQUIPMENT
pmg-engi-ai text 50 Tags Instrumentation UDET(s)
pmg-engi-ae text 50 Tags Electrical UDET(s)
pmg-engi-pid text 150 Tags P&ID UDET(s)
pmg-design-ai text 50 CABLE
EQUIPMENT
INSTRUMENT
SUBEQUIPMENT

Copyright 2010 to current year. 4:18 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Options and Mapping

UDA Name(s) UDA Type UDA Length Element Types


pmg-design-ae text 50 CABLE
EQUIPMENT
pmg-cata-ai text 50 TABITEM
pmg-cata-ae GPART
CABDATA
SCOMPONENT
CCORSET
CABCORE
TABQUESTION

Note: In order to store the source database references for elements already imported, re-
run Compare/Update on the existing data, accept all rows even though there are no
changes listed, and complete the Update Database process.

Copyright 2010 to current year. 4:19 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide
Options and Mapping

Copyright 2010 to current year. 4:20 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Compare/Update User Guide

Index

C O
Compatibility . . . . . . . . . . . . . . . . . . . . . . 1:2 Options
Column Setup . . . . . . . . . . . . . . . . . 4:1
D Grid . . . . . . . . . . . . . . . . . . . . . . . . . 4:1
Grid Context Menu . . . . . . . . . . . . . . 4:5
Data Print Preview . . . . . . . . . . . . . . . . . . 4:5
Compare . . . . . . . . . . . . . . . . . . . . . . 3:1 Settings . . . . . . . . . . . . . . . . . . . . . . 4:2
Update . . . . . . . . . . . . . . . . . . . . . . . 3:1 Toolbar . . . . . . . . . . . . . . . . . . . . . . . 4:6
Details Options and Mapping . . . . . . . . . . . . . . . 4:1
Element Grid . . . . . . . . . . . . . . . . . . 3:5
Display U
Comparison Results . . . . . . . . . . . . . 3:3
Update
F Accept Changes . . . . . . . . . . . . . . . 3:6
Catalogue Database . . . . . . . . . . . . 3:9
Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1 Design Database . . . . . . . . . . . . . . 3:11
Schematic Database . . . . . . . . . . . . 3:8
G Target Database . . . . . . . . . . . . . . . 3:7

Getting Started . . . . . . . . . . . . . . . . . . . . 2:1

I
Introduction . . . . . . . . . . . . . . . . . . . . . . . 1:1

M
Mapping
Export to Excel . . . . . . . . . . . . . . . . . 4:5
Matching
Instrument Elements . . . . . . . . . . . . 3:2

Copyright 2010 to current year. Index page 1 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.