AVEVA Instrumentation Data Update

User Guide
AVEVA Solutions Ltd

Disclaimer
Information of a technical nature, and particulars of the product and its use, is given by AVEVA
Solutions Ltd and its subsidiaries without warranty. AVEVA Solutions Ltd and its subsidiaries disclaim
any and all warranties and conditions, expressed or implied, to the fullest extent permitted by law.

Neither the author nor AVEVA Solutions Ltd, or any of its subsidiaries, shall be liable to any person or
entity for any actions, claims, loss or damage arising from the use or possession of any information,
particulars, or errors in this publication, or any incorrect use of the product, whatsoever.

Copyright
Copyright and all other intellectual property rights in this manual and the associated software, and every
part of it (including source code, object code, any data contained in it, the manual and any other
documentation supplied with it) belongs to AVEVA Solutions Ltd or its subsidiaries.

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

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

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

First published September 2007

AVEVA Solutions Ltd, and its subsidiaries

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

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

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

The copyright, trade mark rights, or other intellectual property rights in any other product, its name or
logo belongs to its respective owner.
 Instrumentation Data Update User Guide

Instrumentation Data Update User Guide

Contents Page

AVEVA Instrumentation Data Update

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Assumptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Guide Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Product Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:2

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

Comparing and Updating Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
Filtering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
Instrument Tag and Loop Matching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2
Display of Comparison Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2
Instrument Grid Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:4
Accepting Changes for Update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:5
Updating the Schematic Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:5

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

Grid Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1
Column Setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1
Export to Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:2
Print Preview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:2
Grid and Colour Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:2
Grid Context Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:3

i 12.0
 Instrumentation Data Update User Guide

Toolbar Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:4

Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:4
Attribute Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:4
Attribute Mapping Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:5
Integration UDA Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:6

ii 12.0
 Instrumentation Data Update User Guide
Introduction

1 Introduction

The AVEVA Instrumentation Data Update User Guide describes the AVEVA Instrumentation
Data Update add-in to AVEVA Diagrams and AVEVA Schematic Model Manager. The add-in
can be used to compare attribute values for schematic instruments against data held in
AVEVA Instrumentation, and to update the schematic database with values from AVEVA
Instrumentation.

1.1 Assumptions
The AVEVA Instrumentation Data Update User Guide is used by Schematic and Diagrams
users to understand how to update their schematic models with instrumentation data
mastered in AVEVA Instrumentation.
It is assumed that:
Users have a valid AVEVA Schematics license and have installed AVEVA Plant or
AVEVA Marine.

1.2 Guide Structure

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

Introduction introduces the AVEVA Instrumentation Data Update

add-in.

Getting Started explains how to start up the add-in.

Comparing and Updating Data explains how the compare and update processes work.

Options and Mapping explains how to configure the behaviour of the add-in.

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.

1:1 12.0
 Instrumentation Data Update User Guide
Introduction

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 User Guide

1:2 12.0
 Instrumentation Data Update User Guide
Getting Started

2 Getting Started

To start the add-in, from the View menu select AVEVA Instrumentation Data Update.

The add-in will be displayed in a docked window, initially empty.

Click Login and select the desired Instrumentation project from the list available.

2:1 12.0
 Instrumentation Data Update User Guide
Getting Started

Click Select, and then enter the appropriate user name 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 Options window and define the attribute mappings. Refer to Toolbar
Options.
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 Filtering.

2:2 12.0
 Instrumentation Data Update User Guide
Getting Started

Note: A filter that was previously saved 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 on Refresh in the toolbar in order to proceed with the
compare process.

2:3 12.0
Instrumentation Data Update User Guide
Getting Started

2:4 12.0
 Instrumentation Data Update User Guide
Comparing and Updating Data

3 Comparing and Updating Data

The compare process starts automatically following login to the AVEVA Instrumentation
project, displaying a progress bar as it proceeds.

3.1 Filtering
Click Filtering in the toolbar to control which Tags and Loops will be compared from AVEVA
Instrumentation. Filtering is useful to limit the number of rows displayed in the grid when a
large number of Instruments and Loops are present in the AVEVA Instrumentation project.

3:1 12.0
 Instrumentation Data Update User Guide
Comparing and Updating Data

Click on Add Filter 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 with AND when generating the query.

Click on OK to save the filter.

Note: Filters are saved to the same file and folder as Attribute Mapping.

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

3.2 Instrument Tag and Loop Matching

Instrument tag and loop matching uses the following criteria:
If Schematic Database instrument data have previously been imported into AVEVA
Instrumentation, the Schematic Database references will have been stored in AVEVA
Instrumentation. If available these will be used as the first attempt to match.
If AVEVA Instrumentation data have previously been imported into the Schematic
Database, and the integration UDA was available, the AVEVA Instrumentation InstKey/
LoopKey combinations 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.

If the first two attempts have not generated a match, the third attempt will match on
Tag/Name.
To re-read the data from AVEVA Instrumentation and repeat the compare process, click
Refresh in the toolbar.

3.3 Display of Comparison Results

The results of the compare process will be displayed in the add-in grid. The Instruments or
Loops tab lists the matches with the total number of changes available for each.

3:2 12.0
 Instrumentation Data Update User Guide
Comparing and Updating Data

The Attribute Details tab lists the individual attribute differences for each selected
instrument or loop.

Select Instruments or Loops in the toolbar to display either category's data in the grid.

3:3 12.0
 Instrumentation Data Update User Guide
Comparing and Updating Data

3.4 Instrument Grid Details

The Instrument Grid lists the instruments retrieved from AVEVA Instrumentation and
compared against the Schematic 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 ALL attributes for this object will be updated into the Schematic
Database.
Semi-checked Some attributes for this object will be updated into the Schematic
Database.
Unchecked No attributes for this object will be updated into the Schematic
Database.
Unchecked and No attributes for this object will be updated into the Schematic
disabled Database. This state occurs for any of the following reasons:
There is no matching object in the Schematic Database for the
object in AVEVA Instrumentation. In this case the row is greyed
out.
The object is matched and there are no attribute changes to
update.
The AVEVA Instrumentation object is matched but the Schematic
Database object is not an appropriate type, these being
SCOINS, SCINST, SCVALV, SCACTU, SCLOOP or a UDET
based on one of these types.

The Matched column displays whether an object in AVEVA Instrumentation is matched

against an existing object in the Schematic Database.

Value Description
Yes There is a matching object in the Schematic Database.
No There is no matching object in the Schematic Database. In this case
the row is greyed out.

3:4 12.0
 Instrumentation Data Update User Guide
Comparing and Updating Data

The Matched Against column lists the type of matching object in the Schematic Database.

Value Description
One of SCOINS, SCINST, SCVALV, When object is matched to an appropriate type
SCACTU, SCLOOP, or a UDET
based on one of these types
Wrong type: <type> When object is matched but not to an appropriate
type
NONE When object 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 the user has chosen to be updated.

3.5 Accepting Changes for Update

Use the following methods to accept which attributes should be updated:
Use the Accept All check box in the toolbar to accept or reject all available changes on
all objects compared.
Use the Accept check boxes in the Instruments or Loops tab to accept or reject all
available changes for individual objects.
Use the Accept check boxes in the Attributes Details tab to accept or reject individual
changes 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 Schematic Explorer will select the corresponding rows in the
currently displayed tab if that object is available for update in the tab.

3.6 Updating the Schematic Database

Click Apply Updates to apply all the accepted changes to the Schematic Database.
The Update Schematic Model database window will be displayed showing the statistics
from the compare process and the choices made for accepting changes. Click UpdateDB to
apply the updates.

3:5 12.0
 Instrumentation Data Update User Guide
Comparing and Updating Data

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

The grid will be updated with results messages and errors, with highlighting in the
appropriate feedback colours.

3:6 12.0
 Instrumentation Data Update User Guide
Comparing and Updating Data

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.

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

Note: Even if there are no attribute updates to be made, there may still be data updates for
InstKey/LoopKey combinations resulting from the matching process. Refer to
Instrument Tag and Loop Matching.

3:7 12.0
Instrumentation Data Update User Guide
Comparing and Updating Data

3:8 12.0
 Instrumentation Data 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 in any column title, and a
context menu accessed via a right click in any row.

4.1.1 Column Setup

Additional columns from the available AVEVA Instrumentation attributes may be displayed in
the grid, and the order may be changed. Right click in any column title and select Column
Setup.

4:1 12.0
 Instrumentation Data Update User Guide
Options and Mapping

Set the Visible check box to display any particular column. Select particular columns and
use the up and down buttons to reorder them. Click OK to update the current layout.

Note: Grid layouts are automatically saved in the folder

C:\Documents and Settings\<Current User>\Local

Settings\Application
Data\Aveva\PDMS\SchematicInstrumentationAddin
with filenames SchAiInstruments.xml or SchAiLoops.xml

4.1.2 Export to Excel

The current grid layout and content 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 dialogue.

4.1.3 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.4 Grid and Colour Settings

Right click in any column title and select Settings to display the settings submenu. Select
any of the grid settings to enable or disable that facility.

4:2 12.0
 Instrumentation Data Update User Guide
Options and Mapping

Select Settings > Feedback Colours to display the colours submenu. Select one of the
following options to display the colour selector dialogue for that category:
Settings > Feedback Colours > Not Matched Row Colour
(default: Silver)
Settings > Feedback Colours > Matched Without Changes Row Colour
(default: White)
Settings > Feedback Colours > Matched With Changes Row Colour
(default: Yellow)
Settings > Feedback Colours > Update Fail Row Colour
(default: Red)
Select Settings > Feedback Colours > Reset Default Feedback Row Colours to revert to
the default colours.

4.1.5 Grid Context Menu

Right click in any row in the Instruments or Loops tab to see the context menu (the
Attribute Details tab does not have a context menu).
When Instruments are selected:
Select Instrument Datasheet to view the AVEVA Instrumentation datasheet for that
object.
Select Instrument Details to view the AVEVA Instrumentation dialogue for that object.
When Loops are selected:
Select Loop Details to view the AVEVA Instrumentation dialogue for that object.

4:3 12.0
 Instrumentation Data Update User Guide
Options and Mapping

4.2 Toolbar Options

Click Options in the toolbar to display the Options dialogue which is used to set the types
of objects that will be compared and how their attributes will be mapped.

4.2.1 Logging
Use the Logging options to maintain a log of compare process details. Check Enabled and
enter a filename in the Path field.

4.2.2 Attribute Mapping

Use the Attribute Mapping Details options to define attribute mappings for selected
instrument or loop types.
Common attribute mappings can be defined using attributes of SCINST for instruments
and attributes of SCLOOP for loops. These common mappings can be applied to selected
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
Group option, then check the required types in the Common attribute applied for list.

Note: The available types in the Common attribute applied for list 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.

4:4 12.0
 Instrumentation Data Update User Guide
Options and Mapping

To modify the existing mappings or create new mappings, press Attribute Mapping to
display this dialogue.

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

C:\Documents and Settings\<Current User>\Local

Settings\Application
Data\Aveva\PDMS\SchematicInstrumentationAddin
with filename SchAiSettings.xml

4.2.3 Attribute Mapping Window

The Attribute Mapping window allows mappings to be added or modified.

Attribute mappings can be defined for any of the instrumentation types, these being
Common Instrument and Common Loop, along with the separate instruments types that
have not been included in common mapping.
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 Type select the Common or separate type to which the mappings will apply.
To add an attribute mapping, select an AVEVA Instrumentation Attribute from the left
hand pull down list, then select a Schematic Model Attribute from the right hand pull 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.

4:5 12.0
 Instrumentation Data Update User Guide
Options and Mapping

If multiple mappings are entered for the same Schematic Model attribute, the last available
mapping will be the one used.
Click OK to save the mappings.

4.3 Integration UDA Definition

The UDA pmg-sch-ai must be defined in Lexicon if the matching process is to use the
InstKey/LoopKey combinations, refer to Instrument Tag and Loop Matching.
The UDA may be created in any UGROUP in a current dictionary database. If used in
conjunction with the Schematic Model Manager UDAs, it is suggested to include this UDA in
the same group.
The Integration UDA should be created with the following details:

Attribute Value
UDA name pmg-sch-ai
UDA type text
UDA length 50
Element types SCOINS SCINST SCVALV SCACTU SCLOOP

4:6 12.0
 Instrumentation Data Update User Guide

Index

C U
Compatibility . . . . . . . . . . . . . . . . . . . . . . 1:1 Updating
Accept Changes . . . . . . . . . . . . . . . 3:5
F
Filtering . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1

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

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

M
Mapping
Attribute . . . . . . . . . . . . . . . . . . . . . . 4:4
Attribute Window . . . . . . . . . . . . . . . 4:5
Export to Excel . . . . . . . . . . . . . . . . . 4:2
Logging . . . . . . . . . . . . . . . . . . . . . . . 4:4

O
Options
Column Setup . . . . . . . . . . . . . . . . . . 4:1
Grid . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1
Grid and Colour . . . . . . . . . . . . . . . . 4:2
Grid Context Menu . . . . . . . . . . . . . . 4:3
Print Preview . . . . . . . . . . . . . . . . . . 4:2
Toolbar . . . . . . . . . . . . . . . . . . . . . . . 4:4
Options and Mapping . . . . . . . . . . . . . . . 4:1

Index page 1 12.0