Professional Documents
Culture Documents
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 October 2010 AVEVA Solutions Ltd, and its subsidiaries AVEVA Solutions Ltd, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom
Trademarks
AVEVA and Tribon are registered trademarks of AVEVA Solutions Ltd or its subsidiaries. Unauthorised use of the AVEVA or Tribon trademarks is strictly forbidden. AVEVA product names are trademarks or registered trademarks of AVEVA Solutions Ltd or its subsidiaries, registered in the UK, Europe and other countries (worldwide). The copyright, trade mark rights, or other intellectual property rights in any other product, its name or logo belongs to its respective owner.
Contents
Page
12.0
Export to Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:5 Print Preview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:5 Grid Context Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:5
Options
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:6
ii
12.0
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 one or more of the above modules. Users have a working knowledge of the product which will host the AVEVA Instrumentation Data Update application update.
1:1
12.0
1.2
Guide Structure
The AVEVA Instrumentation Data Update User Guide is divided into the following sections: Introduction Getting Started Compare and Update Data Options and Mapping introduces the AVEVA Instrumentation Data Update application. explains how to start up the application update. explains how the compare and update processes work. explains how to configure the behaviour of the application update.
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
1:2
12.0
Getting Started
Once installed the AVEVA Instrumentation Data Update application can be accessed from the following menu locations in each supported product: Schematic Model Manager: Diagrams: Paragon (Electrical Application): Design (Cabling System Application): Outfitting (Cabling System Application): View > AVEVA Instrumentation Data Update View > AVEVA Instrumentation Data Update Utilities > AVEVA Instrumentation Data Update Utilities> AVEVA Instrumentation Data Update Utilities > AVEVA Instrumentation Data Update
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 Instrumentation Data Update to display the AVEVA Instrumentation Data Update window, initially shown empty.
Click Login and select the desired Instrumentation project from the list.
2:1
12.0
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 Options window used to define the attribute mappings. Refer to Options for 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.
2:2
12.0
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 Refresh in the toolbar in order to proceed with the compare process.
2:3
12.0
2:4
12.0
3.1
Filter
The Filter window 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.
3:1
12.0
Click 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 OK to save the filter. Note: Filters are saved to the same file and folder as Attribute 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 Refresh in the toolbar.
3.2
Note: If the UDA is not available this step will be skipped. Refer to Integration UDA Definition for further information. If the first two attempts have not generated a match, the third attempt will match on the default criteria.
3.3
3:2
12.0
The Attribute Details 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.
3:3
12.0
3.4
The Matched column displays if an element in the source database is matched against an existing element in the target database. Value Yes No Description There is a matching object in the target database. There is no matching object in the target database.
3:4
12.0
The Matched Against column lists the type of matching object in the Schematic Database. Value 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 Wrong type: <type> Not Matched Description When object is matched to an appropriate type.
When object is matched but not to an appropriate type. 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
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
3.6.1
3:5
12.0
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.
3:6
12.0
3.6.2
The Update Catalogue 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. Once the update process has completed a results summary similar to the Schematic Database update summary will be displayed.
3:7
12.0
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.
3:8
12.0
The following table lists the element to be added along with its valid owner. Element Type TABITEM GPART SCOMPONENT CCORSET CABDATA Valid Owner(s) CTABLE PRTWLD or PRTELE SECTION or CATEGORY SECTION or CATEGORY CMPTYPE
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
3:9
12.0
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 Element for 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.
3:10
12.0
Once the update process has completed, the results summary will be displayed.
Note: Changes are not actually saved until the next Save Work.
3:11
12.0
3:12
12.0
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.
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 Setup from the pop-up menu.
4:1
12.0
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 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 SchAiInstruments.xml or SchAiLoops.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 Filtering allows 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.
4:2
12.0
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 Summaries displays the icon in the No of Changes column. Clicking the icon displays the Select Summaries window.
The user can check one or all the boxes and click OK to receive a count displayed at the end of the No of Changes column.
4:3
12.0
Note: Clicking Refresh remove the count. Enable Column Sort allows 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 Colours displays 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.
4:4
12.0
Selecting Reset Default Feedback Row Colours, reverts the options back to their default colour settings. Not Matched Row Colour Match Without Changes Row Colour Matched With Changes Row Colour Update Fail Row Colour Silver White Yellow Red
The Paragon, Design and Outfitting modules have the same colour options except for Not Matched Row Colour is changed to New Element Row Colour with a default colour of pink.
4.1.3
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.
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
4:5
12.0
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 Options on the main toolbar to display the Option window.
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
4:6
12.0
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 drop-down list, 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. 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:\Documents and Settings\<Current User>\Local Settings\Applica tion Data\Aveva\PDMS\SchematicInstrumentationAddin with the filename SchAiSettings.xml To modify the existing mappings or create new mappings, click Attribute Mapping to display the Attribute Mapping window.
4.2.3
Attribute Mapping
The Attribute Mapping window allows mappings to be added or modified. Select Attribute Mapping from the Options window to display the Attribute Mapping window.
4:7
12.0
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 Type select the Common or separate type to which the mappings will apply. To add an attribute mapping, select a source database attribute from the left hand dropdown 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 OK to 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
4:8
12.0
Index
C
Compatibility . . . . . . . . . . . . . . . . . . . . . . 1:2
O
Options Column Setup . . . . . . . . . . . . . . . . . Grid . . . . . . . . . . . . . . . . . . . . . . . . . Grid Context Menu . . . . . . . . . . . . . . Print Preview . . . . . . . . . . . . . . . . . . Settings . . . . . . . . . . . . . . . . . . . . . . Toolbar . . . . . . . . . . . . . . . . . . . . . . . Options and Mapping . . . . . . . . . . . . . . . 4:1 4:1 4:5 4:5 4:2 4:6 4:1
D
Data Compare . . . . . . . . . . . . . . . . . . . . . . 3:1 Update . . . . . . . . . . . . . . . . . . . . . . . 3:1 Details Element Grid . . . . . . . . . . . . . . . . . . 3:4 Display Comparison Results . . . . . . . . . . . . . 3:2
U
Update Accept Changes . . . . . . . . . . . . . . . Catalogue Database . . . . . . . . . . . . Design Database . . . . . . . . . . . . . . . Schematic Database . . . . . . . . . . . . Target Database . . . . . . . . . . . . . . . 3:5 3:7 3:9 3:5 3:5
F
Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
G
Getting Started . . . . . . . . . . . . . . . . . . . . 2:1
I
Introduction . . . . . . . . . . . . . . . . . . . . . . . 1:1
M
Mapping Attribute Details . . . . . . . . . . . . . . . . 4:6 Attribute Window . . . . . . . . . . . . . . . 4:7 Export to Excel . . . . . . . . . . . . . . . . . 4:5 Logging . . . . . . . . . . . . . . . . . . . . . . . 4:6 Matching Instrument Elements . . . . . . . . . . . . 3:2
Index page 1
12.0