pdms:aveva instrumentation data update user guide

7/21/2019 PDMS:AVEVA Instrumentation Data Update User Guide

1/31

AVEVA Instrumentation Data UpdateUser Guide


2/31


3/31

Instrumentation Data Update User Guide

Contents Page

12.0i


AVEVA Instrumentation Data Update

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

Assumptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1

Guide Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:2

Product Compatibi li ty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:2

References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:2

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

Compare and Update Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1

Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1

Instrumentation Elements Matching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2

Display of Comparison Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2

Element Grid Detai ls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:4

Accept Changes for Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:5

Update the Target Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:5

Update the Schematic Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:5

Update the Catalogue Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:7

Update the Design Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:9

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

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

Column Setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:2


4/31

12.0ii


Export to Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:5

Print Preview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:5

Grid Context Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:5Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:6

Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:6

Attribute Mapping Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:6

Attribute Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:7

Integration UDA Defin it ion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:8


5/31


Introduction

12.01:1

1 Introduction

The AVEVA Instrumentation Data Update User Guide describes how to configure and use

the AVEVA Instrumentation Data Update application. The application update integrates

attribute level comparison, and controlled selective update capabilities, into a supported

Plant or Marine module, which enables the managed integration of AVEVA Instrumentation

data into the hosting modules database.

The AVEVA Instrumentation Data Update is currently used in the following products:

AVEVA Diagrams

AVEVA Schematic Model Manager

AVEVA Plant DESIGN, Cabling System Application

AVEVA Marine Outfitting, Cabling System Application

AVEVA Paragon (Electrical Application Only)

The AVEVA Instrumentation Data Update 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 AVEVA Instrumentation Data Update User Guide is designed for use by Schematic

Model Manager, Diagrams, Design, Outfitting and Paragon administrators and users, and

describes how to configure the application and use it to compare and integrate data

mastered in AVEVA Instrumentation into these products.

It is assumed that:

Users have installed AVEVA Plant or AVEVA Marine, and have valid licenses to run oneor more of the above modules.

Users have a working knowledge of the product which will host the AVEVAInstrumentation Data Update application update.


6/31

12.01:2


Introduction

1.2 Guide Structure

The AVEVA Instrumentation Data Update User Guide is divided into the following sections:

1.3 Product Compatibility

AVEVA Instrumentation Data Update can be used with the following products:

AVEVA Diagrams 12.0.SP6 or later.

AVEVA Schematic Model Manager 12.0.SP6 or later.

AVEVA Plant Design 12.0.SP6 or later.

AVEVA Paragon 12.0.SP6 or later.

AVEVA Marine Outfitting 12.0.SP6 or later.

1.4 References

The following User Guides will provide supporting or complementary information to the user.

AVEVA Diagrams User Guide

AVEVA Schematic Model Manager User Guide

AVEVA Instrumentation Engineer User Guide

Cable Design User Guide

Catalogues and Specifications User Guide

Introduction introduces the AVEVA Instrumentation Data Update

application.

Getting Started explains how to start up the application update.

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

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

update.


7/31


Getting Started

12.02:1

2 Getting Started

Once installed the AVEVA Instrumentation Data Update application can be accessed from

the following menu locations in each supported product:

Further details on configuring and loading this application update in the Schematic Model

Manager. Where an activity differs dependent on the hosting product this is explained.

To start the application, select View>AVEVA Instrumentat ion Data Updateto display the

AVEVA Instrumentation Data Update window, initially shown empty.

Click Loginand select the desired Instrumentation project from the list.

Schematic Model Manager: View > AVEVA Instrumentation Data Update

Diagrams: View > AVEVA Instrumentation Data Update

Paragon (Electrical Application): Utilities > AVEVA Instrumentation Data Update

Design (Cabling System Application): Utilities> AVEVA Instrumentation Data Update

Outfitting (Cabling System Application): Utilities > AVEVA Instrumentation Data Update


8/31

12.02:2


Getting Started

Click Select, and when prompted, enter the username and password for that project.

If attribute mappings have previously been set up, the compare process will start

automatically.

If attribute mapping have not been set up, the user will be prompted to do this now.

Click Yes to display the Optionswindow used to define the attribute mappings. Refer to

Optionsfor further information.

If element filtering has not been set up, the user will be prompted to do this now.

Click Yes to display the Filter window and define one or more filters. Refer to Filter for

further information.


9/31


Getting Started

12.02:3

Note: A previously saved filter will be applied to the data being read from AVEVA

Instrumentation. If the filter prevents display of the Instrumentation data, modify the

Filter settings, then click Refreshin the toolbar in order to proceed with the compare

process.


10/31

12.02:4


Getting Started


11/31


Compare and Update Data

12.03:1

3 Compare and Update Data

If the Attributes Mapping and Filtering has been setup the compare process starts

automatically following login to the AVEVA Instrumentation project. A progress bar is

displayed as it proceeds.

3.1 Filter

The Filterwindow controls which elements will be retrieved from AVEVA Instrumentation.

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 AVEVA Instrumentation project. To display the

Filter window, click Filtering on the main toolbar.


12/31

12.03:2



Click Add Fil ter to add a row then select the attribute, operator and value. The available

operators will be appropriate to the data type of the selected attribute.

Note: Multiple filters will be joined withANDwhen generating the query.

Click OK to save the filter.

Note: Filters are saved to the same file and folder asAttribute Mapping Details.

To delete a filter, select the row and click Delete Filter.

To re-read the data from AVEVA Instrumentation and repeat the compare process, click

Refreshin the toolbar.

3.2 Instrumentat ion Elements Matching

Instrumentation element matching uses the following criteria: If element data from the target database (like Schematics) had previously been

imported into AVEVA Instrumentation, the Schematic Database references will havebeen stored in AVEVA Instrumentation. If available these will be used as the firstattempt to match.

If AVEVA Instrumentation data have previously been imported into the target database,and the integration UDA was available, the AVEVA Instrumentation databasereferences combinations will have been stored in the UDA. If available these will beused as the second attempt to match.

Note: If the UDA is not available this step will be skipped. Refer to Integration UDA

Definitionfor further information.

If the first two attempts have not generated a match, the third attempt will match on thedefault criteria.

3.3 Display of Comparison Results

The results of the compare process will be displayed in the grid view. The selected element

name tab lists the matches with the total number of changes available for each.


13/31



12.03:3

TheAt tr ibute Detai ls tab lists the individual attribute differences for the selected element

type.

Select desired element name in the toolbar to display respective element's data in the grid.


14/31

12.03:4



3.4 Element Grid Details

The Element Grid lists the elements retrieved from source database and compared against

the target database. The following columns are always displayed:

The Acceptcolumn displays checkboxes showing the current choice for how data will be

updated.

The Matchedcolumn displays if an element in the source database is matched against an

existing element in the target database.

State Description

Checked ALL attributes for this element will be updated into the target

database.

When a module from which the application update is loaded, it allows

insertion of new elements, then the selected elements may be

created in the target database, if required pre-requisites are fulfilled.

Semi-checked Some attributes for this element will be updated into the target

database.

Unchecked No attributes for this element will be updated into the target database.

Unchecked and

disabled

No attributes for this element will be updated into the target database.

This state occurs for any of the following reasons:

There is no matching object in the target database for theelement in source database. In this case the row is greyed out.

When insertion of new elements is allowed, the row will becoloured using "New Element Row Colour" settings.

The element is matched and there are no attribute changes toupdate.

The element from target database matches the one in sourcedatabase, however the element type is not appropriate.

Value Description

Yes There is a matching object in the target database.

No There is no matching object in the target database.


15/31



12.03:5

The Matched Agains tcolumn lists the type of matching object in the Schematic Database.

The No. of Changescolumn 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 At tr ibutes to be Updated column displays a comma separated list of the attributes

which have changes available for update and which the user has chosen to be updated.

3.5 Accept Changes for Update

Use the following methods to accept which attributes should be updated: Use theAccept A ll checkbox in the toolbar to accept or reject all available changes on

all objects compared.

Use the Acceptcheckboxes in the Instruments or Loops tab to accept or reject allavailable changes for individual objects.

Use theAcceptcheckboxes in theAt tr ibutes Detailstab to accept or reject individualchanges for individual objects.

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 instrument or loop in the

selection.

Selecting an object in the module specific Explorer will select the corresponding rows in the

currently displayed tab if that object is available for update in the tab.

3.6 Update the Target Database

Click Update Databaseto apply all the accepted changes to the target database.

The following sub-sections describe the process of updating the target database for each

supported database type.

3.6.1 Update the Schematic Database

When updating in the Schematic Model Manager or the Diagrams module, the Update

Schematic Database window will be displayed showing the statistics from the compare

Value Description

One of the element types defined in

the respective module configuration

file, (for example

SchematicAIConfiguration.xml) or a

UDET based on one of these types

When object is matched to an appropriate type.

Wrong type: When object is matched but not to an appropriate

type.

Not Matched When object is not matched.


16/31

12.03:6



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.

Note: If an update error occurs for a particular attribute, only that attribute will fail to update.

Other attributes on the same object will still be updated if possible.

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

appropriate feedback colours.


17/31



12.03:7

3.6.2 Update the Catalogue Database

When updating in the Paragon module for importing / updating cable catalogue elements.

After selecting the catalogue items to be added / updated, click Update Database.

The Update Catalogue Databasewindow will be displayed showing the statistics from thecompare process and the choices that have been made for accepting changes or adding

new objects. Click UpdateDB to apply these updates.

Once the update process has completed a results summary similar to the Schematic

Database update summary will be displayed.


18/31

12.03:8



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. An owner (parent element)

will also need to 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.


19/31



12.03:9

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

Selecting an invalid element as owner will display a message box, as shown below,

containing name(s) of element types that are valid owners for the element to be added.

3.6.3 Update the Design Database

When updating in the Design or Outfitting module for importing / updating cables along with

their associated equipment.

Element Type Valid Owner(s)

TABITEM CTABLE

GPART PRTWLD or PRTELE

SCOMPONENT SECTION or CATEGORY

CCORSET SECTION or CATEGORY

CABDATA CMPTYPE


20/31

12.03:10



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, as shown below.

After selecting the equipment or cable(s) to be added / updated, click Update Database.

The Update Design Database window will be displayed showing the statistics from the

compare process and the choices that have been made for accepting changes or adding

new objects. Click UpdateDB to apply these updates.

Refer to Selecting Owner for an Elementfor more details on adding an element.

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 Elements Matching for further

details.


21/31



12.03:11

Once the update process has completed, the results summary will be displayed.

Note: Changes are not actually saved until the next Save Work.


22/31

12.03:12




23/31


Options and Mapping

12.04:1

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 OptionsThe 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.

4.1.1 Column Setup

Column Setup allows the user 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 Setupfrom the pop-up menu.


24/31

12.04:2


Options and Mapping

To display a Column Name in the grid view, check the required checkbox in the Visible

column. Unchecking a checkbox removes the Column Name from the grid view.

To change the position of a Column Name in the grid view, select the Column Nameand

click either the up or down arrows.

Click OKto update the grid view.

Note: Grid layouts are automatically saved in the folder

C: \ Documents and Set t i ngs\ \ Local Set t i ngs\ Appl i cati on Dat a\ Aveva\ PDMS\ Schemat i cI nst r ument at i onAddi n

with filenames SchAi I nst r ument s. xml or SchAi Loops. xml

4.1.2 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 Filteringallows the user 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 the column field and selecting a value from the drop-down list.


25/31


Options and Mapping

12.04:3

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.

Enable Column Summariesdisplays the icon in the No of Changescolumn. Clicking

the icon displays the Select Summarieswindow.

The user can check one or all the boxes and click OKto receive a count displayed at the

end of the No of Changescolumn.


26/31

12.04:4


Options and Mapping

Note: Clicking Refreshremove the count.

Enable Column Sortallows the user 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 the user in positioning the column.

Clicking Feedback Coloursdisplays a sub-menu:

Not Matched Row Colour.

Match Without Changes Row Colour.

Matched With Changes Row Colour.

Update Fail Row Colour.

Reset Default Feedback Row Colours.

Clicking the option, Not Matched Row Colour, Match Without Changes Row Colour,

Matched With Changes Row Colour or Update Fail Row Colour displays a Colour Selection

window which allows the user to select a colour for the selected option.


27/31


Options and Mapping

12.04:5

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

colour settings.

The Paragon, Design and Outfitting modules have the same colour options except for Not

Matched Row Colour is changed to New Element Row Colourwith a default colour of

pink.

4.1.3 Export to ExcelThe 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.

4.1.4 Print Preview

The user can view a print preview of the current grid layout and content. Right-click in any

column title and select Print Preview.

4.1.5 Grid Context Menu

Right-click in any row in the Instruments or Loopsgrid view display a context menu.

The Instruments grid view displays the following options:

Instrument Datasheetdisplays the AVEVA Instrumentation datasheet for the selectedinstrument.

Instrument Details displays the AVEVA Instrumentation window for the selectedinstrument.

The Loops grid view has on option:

Loop Detailsdisplays the AVEVA Instrumentation window for the selection loop.

Note: No context menu exists for the Attribute Details tab.

Not Matched Row Colour Silver

Match Without Changes Row Colour White

Matched With Changes Row Colou r Yellow

Update Fail Row Colour Red


28/31

12.04:6


Options and Mapping

Note: Context menu is not applicable for the gird displayed in Paragon, Design and

Outfitting modules.

4.2 Options

The types of elements that will be compared and how their attributes will be mapped are set

using the Options window. Click Optionson the main toolbar to display the Option window.

4.2.1 Logging

Use the Loggingoptions to maintain a log of compare process details. Check Enabledand

enter a filename in the Pathfield.

4.2.2 Attribute Mapping Detai ls

Use the At tr ibute Mapp ing Details options to define attribute mappings for selected

element.

Common attribute mappingscan be defined using attributes of SCINST for instruments

and attributes of SCLOOP for loops. These common mappings can be applied to selected


29/31


Options and Mapping

12.04:7

types, e.g. SCINST and SCOINS for instruments, whilst separate mappings can be applied

for other types, e.g. SCVALV.

To identify which types will have common mappings, select Instruments or Loops in the

Groupdrop-down list, then check the required types in the Common attribute applied for

list.

Note: The available types in the Common attribute applied forlist will include any UDETs

defined with an appropriate base type.

Note: Adding a type to common mapping will replace any previously defined separate

mapping for that type.

Note: When only a single element type is present, then individual and common attribute

mapping will be the same.

Note: Options and attribute mappings are automatically saved in the folder

C: \ Document s and Set t i ngs\ \ Local Set t i ngs\ Appl i cat i on Dat a\ Aveva\ PDMS\ Schemat i cI nst r ument at i onAddi n

with the filename SchAi Set t i ngs. xml

To modify the existing mappings or create new mappings, click At tr ibute Mapp ing to

display theAttribute Mappingwindow.

4.2.3 Attribute Mapping

TheAt tr ibute Mapping window allows mappings to be added or modified. Select Attribute

Mapping from the Options window to display the Attribute Mapping window.


30/31

12.04:8


Options and Mapping

Attribute mappings can be defined for any individual element types, as well as group of

elements included in common mapping like the Common Instrument and Common Loop.

For example, if SCOINS, SCINST and SCLOOP were included in common mappings,

then the options will be Common Instrument, Common Loop, SCACTU and SCVALV.

In Element Typeselect the Common or separate type to which the mappings will apply.

To add an attribute mapping, select a source database attributefrom the left hand drop-

down list, then select a target database attribute from the right hand drop-down list.

New empty rows will be added as rows are filled. A right-click context menu allows addition

of new rows and deletion of selected rows.

Click OKto save the mappings.

Note: Selection of the same attribute from either source or target database is not allowed. If

any attribute is selected multiple times, the row(s) will be highlighted in RED, and OK

will not save the mappings.

4.3 Integrat ion UDA Defini tion

The UDA's must be defined in LEXICON if the matching process is to use them for storing

source database references, refer to Instrumentation Elements Matching.

The UDA may be created in any UGROUP in a current dictionary database. If used in

conjunction with the specific module, it is suggested to include this UDA in the same group.

The Integration UDA should be created with the following details:

PDMS Module UDA Name UDA Type UDA Length Element Types

Schematic & Diagram pmg-sch-ai text 50 SCINSTRUMENT

SCOINSTRUMENT

SCLOOP

SCVALV

SCACTUATOR

UDA with above element

type as base type

Design & Outfitting design-ai text 50 CABLE

EQUIPMENT

Paragon cata-ai text 50 TABITEM

GPART

CABDATA

SCOMPONENT

CCORSET

CABCORE

TABQUESTION


31/31

Index


C

Compatibility . . . . . . . . . . . . . . . . . . . . . . 1:2D

Data

Compare. . . . . . . . . . . . . . . . . . . . . . 3:1Update . . . . . . . . . . . . . . . . . . . . . . . 3:1

DetailsElement Grid . . . . . . . . . . . . . . . . . . 3:4

Display

Comparison Results . . . . . . . . . . . . . 3:2F

Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1G

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

Introduction . . . . . . . . . . . . . . . . . . . . . . . 1:1M

Mapping

Attribute Details . . . . . . . . . . . . . . . . 4:6Attribute Window . . . . . . . . . . . . . . . 4:7Export to Excel . . . . . . . . . . . . . . . . . 4:5Logging. . . . . . . . . . . . . . . . . . . . . . . 4:6

Matching

Instrument Elements . . . . . . . . . . . . 3:2

O

Options

Column Setup . . . . . . . . . . . . . . . . . 4:1Grid . . . . . . . . . . . . . . . . . . . . . . . . . 4:1Grid Context Menu. . . . . . . . . . . . . . 4:5Print Preview . . . . . . . . . . . . . . . . . . 4:5Settings . . . . . . . . . . . . . . . . . . . . . . 4:2Toolbar. . . . . . . . . . . . . . . . . . . . . . . 4:6

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

Update

Accept Changes . . . . . . . . . . . . . . . 3:5Catalogue Database . . . . . . . . . . . . 3:7Design Database . . . . . . . . . . . . . . . 3:9Schematic Database . . . . . . . . . . . . 3:5Target Database . . . . . . . . . . . . . . . 3:5