Schematic Model Manager User Guide

8/13/2019 Schematic Model Manager User Guide

1/254

Schematic Model ManagerUser Guide


2/254

AVEVA Solut ions Ltd

Disclaimer

Information of a technical nature, and particulars of the product and its use, is given by AVEVASolutions Ltd and its subsidiaries without warranty. AVEVA Solutions Ltd and its subsidiaries disclaimany 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 orentity 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 everypart of it (including source code, object code, any data contained in it, the manual and any otherdocumentation 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 inthis document is commercially sensitive, and shall not be copied, reproduced, stored in a retrievalsystem, or transmitted without the prior written permission of AVEVA Solutions Ltd. Where suchpermission is granted, it expressly requires that this Disclaimer and Copyright notice is prominentlydisplayed at the beginning of every copy that is made.

The manual and associated documentation may not be adapted, reproduced, or copied, in any materialor electronic form, without the prior written permission of AVEVA Solutions Ltd. The user may also notreverse engineer, decompile, copy, or adapt the associated software. Neither the whole, nor part of theproduct 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 bylaw. Any such unauthorised action is strictly prohibited, and may give rise to civil liabilities and criminalprosecution.

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

First published November 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 itssubsidiaries, 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 orlogo belongs to its respective owner.


3/254


4/254

12.0ii

Schematic Model Manager User Guide

GTYPE Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2 Attribute Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2

Page Matching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:4 At tr ibute Derivat ion Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:5

Schematic Model Manager Project Options . . . . . . . . . . . . . . . . . . 3:1

Element Release Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:3Set Release Behaviour of Elements on Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:3Display Comments Dialog on Release to 3D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:5

General Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:5Copying Schematic Model Manager Options from another Project . . . . . . . . . . . . . . . . . . . 3:6

Exporting Schematic Model Manager Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:7Importing Schematic Model Manager Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:7Restore Default Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:7

Import Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:8Viewing/Editing Import Destination SCGROUP Elements . . . . . . . . . . . . . . . . . . . . . . . . . . 3:8Viewing/Editing Equipment and Off Line Instrument Positions . . . . . . . . . . . . . . . . . . . . . 3:10Specifying whether or not Drawings are to be Imported in Colour . . . . . . . . . . . . . . . . . . . 3:11

Units Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:11

Schematic Model Manager User Options . . . . . . . . . . . . . . . . . . . . . 4:1Import Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:2

File Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:2Set Default Import Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:2Set Default Export Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:3

Viewing/Edit ing Attr ibu te Derivation Rules . . . . . . . . . . . . . . . . . . . 5:1

Selecting Rules to be Applied During Import . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:4

Creating /Editing Rule Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:4

Creating/Editing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:5Creating a Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:5Rule Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:9Editing a Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:10

Moving Rules and Rule Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:10

Deleting Rules and Rule Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:10

Viewing/Editing Attribu te Mappings . . . . . . . . . . . . . . . . . . . . . . . . . 6:1

Tree View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:2


5/254

12.0


ii i

Default Attribute Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:3

Creating Attr ibu te Mapping Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:4

Creating Attr ibu te Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:6

XPath Expression Bui lder Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:9Building Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:9Setting up Mappings Using the XPath Expression Builder Dialog - Examples . . . . . . . . . 6:13

Automatic Setting of Attribute Units and Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:21Testing Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:22

Accessing the Source Data Dictionary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:24

Editing, Moving and Deleting Mapping Groups and Mappings . . . . . . . . . . . . 6:24Editing Mapping Groups and Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:24Moving Mapping Groups and Mappings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:24Deleting Mapping Groups and Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:25

Viewing/Edit ing GTYPE Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1

Import Designations f rom File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:3Conflict Resolution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:4Completing the Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:5

Setting up Rules for Automatic Completion of ISO 15926 Mappings . . . . . . . 7:6

Automatical ly Completing ISO 15926 Mappings . . . . . . . . . . . . . . . . . . . . . . . . 7:7Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:7

Import Designations f rom other Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:9

Overwrite Mappings in Databases wi th Current Mappings . . . . . . . . . . . . . . . 7:10

Configuring the Source Data Dict ionary . . . . . . . . . . . . . . . . . . . . . 8:1

Accessing the Configurati on Opt ions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:2

Resett ing the Dictionary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:3

Popul ating or Updating the Dictionary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:3

Line Lis t Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:1

Editing, Adding and Deleting Line List Configuration Rules . . . . . . . . . . . . . . . 9:3 Adding and Deleting Rule Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:3Entering PML Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:3

LLENTRY Conf iguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:4Creating LLENTRY SCPLINE Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:4Creating LLENTRY PIPE Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:5Creating LLENTRY SCBRANCH Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:6

Creating LLENTRY Branch Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:7


6/254

12.0iv


Creating LLENTRY Component Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:8

LLFROM/LLTO Conf iguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:9

Creating LLFROM/TO SCPLINE Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:10Creating LLFROM/TO PIPE Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:11Creating LLFROM/TO SCBRANCH Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:12Creating LLFROM/TO BRANCH Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:13Creating LLFROM/TO Component Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:14

LLDIAGRAMS Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:16Creating LLDIAGRAMS Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:16

Previewing Diagrams before Import . . . . . . . . . . . . . . . . . . . . . . . . 10:1

Select ing Diagrams to Preview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:1Schematic Model Manager Diagram Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:3Diagram Viewer Toolbar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:4Keyboard Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:5Closing Diagrams and the Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:5Diagram Viewer Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:6

Importing Diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:1

Import Diagrams Facil ity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:2

Diagr am Set Import Faci li ty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:4Creating Diagram Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:4Entering Release Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:11Importing Diagram Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:12Closing the Diagram Set Editor without Saving . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:13

Import Progress Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:14 Additional Import Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:14 Automatic Matching of Off-Page Connectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:16

Importing using PML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:16Preliminaries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:17Importing Diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:17

Saving Imported Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:18

Diagram Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:1

Diagr am Connect or Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:2Selecting or Changing the Source Off-page Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:3Setting up a Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:4Connection Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:5

Editing a Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:6


7/254

12.0


v

Schematic Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:1

Opening the Schemati c Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:1

Element Hierarchy in the Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:2

Using the Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:6Element Right-Click Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:6

Applying a Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:7Viewing Element Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:8Creating and Editing Elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:9Renaming Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:10Deleting Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:10Moving and Copying Elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:11Viewing Diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:11Saving Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:12

Viewing Imported Diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14:1

Select ing Diagrams to View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14:1

Schematic Model Manager Diagram Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . 14:4Highlighting and Selecting Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14:5Diagram Connectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14:6Other Viewer Functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14:6

Creating and Edit ing Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15:1

Configuring the Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15:3 Adding, Deleting, Re-ordering and Re-sizing Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . 15:3 Adding an Element Sequence Number Column. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15:5Grouping Elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15:5Filtering Elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15:7Sorting Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15:8Pinning Columns and Rows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15:9

Suppressing Unset and Nulref Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15:9Setting Cell Feedback Colours. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15:10Refreshing Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15:11Saving the Grid Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15:11

Editing Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15:12Cell Feedback Colours . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15:13

Creating Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15:14

Duplicating Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15:14

Deleting Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15:16


8/254

12.0vi


Exporting the Grid to an Excel Spreadsheet . . . . . . . . . . . . . . . . . . . . . . . . . . 15:16

Printing the Gri d . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15:17

Releasing and Un-Releasing Data . . . . . . . . . . . . . . . . . . . . . . . . . . 16:1

Searching in Schematic Model Manager. . . . . . . . . . . . . . . . . . . . . 17:1

Standard Searches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17:1Search Toolbar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17:2

Catalogue Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17:3

Schematic Model Manager Repor ts . . . . . . . . . . . . . . . . . . . . . . . . 18:1

Schematic Model Manager in LEXICON . . . . . . . . . . . . . . . . . . . . . 19:1Opening the LEXICON Module wi th Schematic Model Manager Installed . . . 19:1

Configuring UDAs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19:1UDA Catalogue Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19:3Viewing and Editing UDA Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19:5

Viewing/Edit ing At tr ibute Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19:6

Appendices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:1

Appendix A: Regular Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:1 Alternation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:1Grouping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:1Quantification using Metacharacters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:2Regular Expression Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:6

Appendix B: Releasing to 3D and the Schematic Database . . . . . . . . . . . . . . 20:8

Appendix C: XPath Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:9

Appendix D: Diagram Set Fi le Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:11XML File Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:11

Text File Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:13 Appendix E: Using Ext racts to Manage Working and Issued Schemat ic Data . . .20:15MDB and Database Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:15Managing Your Extract DB - PIDDATAEXTRACT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:18Issue Schematic Data to DB PIDDATA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:19Managing and Propagating Updates and Edits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:22

Appendix F: P&ID Status Cont ro l in Schemat ic Data Model Management . . 20:27P&ID Lifecycle used in this Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:27

Status Control Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:28


9/254

12.0


vi i

P&ID Status Control - An Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:34

Appendix G: Confi gurat ion of L ine Li st s using Pseudo At tr ibutes. . . . . . . . 20:44

Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:44Pseudo Attribute Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:45Example Rule: Component Rules - Butt Welded Piping Cap. . . . . . . . . . . . . . . . . . . . . . 20:46Saved Search Setup and Export to Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:48Line List Attributes and Comparison with the 3D Design . . . . . . . . . . . . . . . . . . . . . . . . . 20:53


10/254

12.0viii



11/254

Schematic Model Manager User GuideIntroduction

12.01:1

1 Introduction

1.1 Schematic Model Manager Module AVEVA Schematic Model Manager is a module that can be licensed for use with an existing AVEVA PDMS or Marine installation. It is used to import P&ID data into Schematicdatabases, and to view and manage this data. P&ID data (which conforms to the ISO 15926format) may be exported from the AVEVA Schematic Model Manager Gateway, AVEVAP&ID and from other supported P&ID systems.

AVEVA are committed to the use of open standards for the interchange of plant databetween AVEVA and 3rd-party products. ISO 15926 is an open standard for therepresentation of process plant life-cycle information. This representation is specified by ageneric, conceptual data model designed to be used in conjunction with reference data:standard instances that represent information common to a number of users, processplants, or both. For further information and for details of which P&ID systems can feed datainto the Schematic model through Schematic Model Manager, contact your local AVEVAsales office.

Once imported, P&ID data in the schematic database can be viewed and managed via ahierarchical data explorer (the Schematic Explorer ). This explorer includes facilities forreleasing selected schematic elements to the AVEVA Schematic 3D Integrator, forintegration with the 3D Design Model database. Facilities are also provided to view P&IDs,both before and after import. A set of standard PDMS report templates for the schematicdatabase are also included.

Note: This guide only describes functionality specific to the Schematic Model Managermodule.

Many of the facilities of the Schematic Model Manager module are the same as thosein the Plant DESIGN module and Marine Hull and Outfitting module. Such facilitiesare not described in this guide. Refer to the appropriate module documentation for

details of these.

1.2 Installation and Pre-ConfigurationFor the installation procedures for the Schematic Model Manager module, refer to thePDMS/Marine installation documentation.

For details of the pre-configuration procedures that should be completed before starting touse Schematic Model Manager, see Pre-configuration .


12/254

12.01:2


1.3 Accessing the Schematic Model Manager ModuleThe Schematic Model Manager Module is accessed using the standard PDMS or Marine

module access procedures and dialogs, for example:

Refer to the Plant DESIGN Module or Marine Hull and Outfitting Module documentation fordetails.

1.4 Using the Schematic Model ManagerThis section introduces the procedures of the Schematic Model Manager Module. They arepresented in the order in which they would usually be carried out:

Configuring the Schematic Model Manager Previewing Drawings before Import Importing Drawings Viewing Data using the Schematic Explorer Viewing Imported Drawings Creating and Editing Elements Searches, Reports and Line Lists

Most facilities of the module are accessed using menus and toolbars. For details of thesemenus and toolbars, see Schematic Model Manager Menus and Toolbars .


13/254


12.01:3

1.4.1 Configuring the Schematic Model Manager

The Tools menu provides access to various dialogs, which are used to specify howSchematic Model Manager operates.

See: Schematic Model Manager Project Options Schematic Model Manager User Options Viewing/Editing Attribute Derivation Rules Viewing/Editing Attribute Mappings Viewing/Editing GTYPE Mappings Configuring the Source Data Dictionary Line List Configuration

1.4.2 Previewing Drawings before ImportThe drawings from which P&ID data are to be imported can be viewed before an import fromthem takes place. This facility is accessed from the File menu.

See Previewing Diagrams before Import .

1.4.3 Impor ting Drawi ngs

The File menu also provides access to the facilities used to import diagram data. Theseoptions are also available on the SMM toolbar.

See Importing Diagrams .

The Diagram Connector, which is used to manually connect page connectors betweenimported diagrams, is accessed from the Tools menu and the SMM toolbar. See Diagram Connector .

1.4.4 Viewing Data using the Schematic Explorer

The data in the Schematic database is presented in a hierarchical data explorer called theSchematic Explorer. This is accessed from the View menu.

See Schematic Explorer .

1.4.5 Viewing Imported Drawings

Imported drawings may be viewed.See Viewing Imported Diagrams .

1.4.6 Creating and Edit ing Elements

Elements may be created and editing using the Edit Members dialog.

See Creating and Editing Elements .


14/254

12.01:4


1.4.7 Releasing and Un-releasing Data

Element data may be released to, i.e. made available to, the AVEVA Schematic 3DIntegrator. Element data may also be un-released if required.

See Releasing and Un-Releasing Data .

1.4.8 Searches, Reports and Line Lists

A number of facilities for searching for data in Schematic Model Manager are provided:

See Searching in Schematic Model Manager .

A number of reports can be run on the Schematic Database.

See Schematic Model Manager Reports .

Line lists may be generated. See:

Line List Configuration . 20.7: Appendix G: Configuration of Line Lists using Pseudo Attributes .

1.5 Schematic Model Manager Menus and Toolbars

1.5.1 Menus

File Menu

View... : Accesses facility for previewing drawings before they are imported. See Previewing Diagrams before Import .

For details of the other options on this menu, refer to the Plant DESIGN module or MarineHull and Outfitting module documentation.


15/254


12.01:5

Import:

This sub-menu access facilities for importing drawings and data.

Diagrams... : Used to import a single diagram. See Import Diagrams Facility .

Diagram Set... : Used to import a diagram set. See Importing Diagram Sets .

Diagram Set Edit or ... Used to create and edit diagram sets. See Creating Diagram Sets .

Import from Excel ... Used to import data from Excel files. Refer to the Excel Importand Export section of Design Common Functionality User Guide for further

information.For details of the other options on this menu, refer to the Plant DESIGN module or MarineHull and Outfitting module documentation.

Export:

Export from Excel ... Used to export data to Excel files. Refer to the Excel Import andExport section of Design Common Functionality User Guide for further information.


16/254

12.01:6


Edit Menu

Edit Members : Accesses the Edit Members dialog, used to create and editing elements.See Creating and Editing Elements

For details of the Undo and Redo options, refer to the Plant DESIGN module or Marine Hulland Outfitting module documentation.

View Menu

Catalog Search : This search facility provides direct access to the Plant or Marinecatalogue. See Catalogue Search .

Diagrams : This option is used to view imported diagrams. See Viewing Imported Diagrams .



17/254


12.01:7

Explorers:

The Schematic Explorer option is used to access the Schematic Explorer. See Schematic Explorer .


Tools Menu

Diagram Connector : Accesses the Diagram Connector, which is used to manually connectpage connectors between imported diagrams. See Diagram Connector .


18/254

12.01:8


Set Release Status : Used to set the release status of the current element, i.e. to release itto or un-release it from the 3D model. See Releasing and Un-Releasing Data .

At tr ibut e Derivat ion Rul es : Accesses facilities to set up rules that will be used toautomatically set the values of attributes during an import. See Viewing/Editing Attribute Derivation Rules .

At tr ibut e Mapp ing : Accesses facilities to map system/project specific attributes from thesource files to schematic or user-defined database attributes. See Viewing/Editing Attribute Mappings .

GTYPE Mappings : Accesses facilities to edit the mappings between ISO15926designations and corresponding GTYPE/SCSTYPE combinations. See Viewing/Editing GTYPE Mappings .

Source Dictionary Management : Accesses tools for maintaining the Source DataDictionary which is used to visualise the potential contents of import files when editing theattribute mappings and to keep track of metadata about source files such as the sourcesystems that data has come from. See Configuring the Source Data Dictionary .

Line List Options : Accesses facilities for specifying the settings which define how line listswill be generated. See Line List Configuration .

Project Options : Accesses facilities for specifying project-wide configuration settings. SeeSchematic Model Manager Project Options .

User Options : Accesses facilities for specifying user-specific configuration settings. SeeSchematic Model Manager User Options .


Window Menu

Refer to the Plant DESIGN module or Marine Hull and Outfitting module documentation fordetails of this menu.


19/254


12.01:9

Help Menu

Refer to the Plant DESIGN module or Marine Hull and Outfitting module documentation fordetails of this menu.

1.5.2 Toolbars

Search Toolbar

Refer to the Plant DESIGN module or Marine Hull and Outfitting module documentation fordetails of this toolbar.

Standard Toolbar


SMM Toolbar

Used to import a single diagram. See Import Diagrams Facility .

Used to import a diagram set. See Importing Diagram Sets .

Accesses the facility for importing data from Excel or CSV files. Refer to the PlantDESIGN module or Marine Hull and Outfitting module documentation for details.

Used to create and edit diagram sets. See Creating Diagram Sets .


20/254

12.01:10


Used to set the release status of the current element, i.e. to release it to or un-release itfrom the 3D model. See Releasing and Un-Releasing Data .

Accesses the Diagram Connector, which is used to manually connect page connectorsbetween imported diagrams. See Diagram Connector .

Excel Import and Export Toolbar

Access to the Excel Import and Export Tool is provided from the Import/Export Toolbar.

Import from Toolbar. Import is also available by selecting File > Import > Import fr omExcel from the main menu.

Export from Toolbar. Export is also available by selecting File > Export > Export toExcel from the main menu.

For further details on the use of this feature and for a worked example, refer to DesignCommon Functionality User Guide for further information.

History Toolbar


1.6 Schematic Model Manager Functionality in theLEXICON Module

A Schematic Model Manager option is displayed in the main LEXICON menu bar:

The UDA Catalogue option is used to specify which User Defined Attributes (UDAs)are available in each Schematic database with which Schematic Model Manageroperates, and to maintain the Attribute Mappings associated with the UDAs.

The At tr ib ut e Mapping s option is used to map system/project specific attributes fromthe source files to schematic attributes or UDAs.

For details, refer to Schematic Model Manager in LEXICON .


21/254

Schematic Model Manager User GuidePre-configuration

12.02:1

2 Pre-configuration

2.1 Post Instal lation Tasks

2.1.1 Database Conf igurat ion

Schematic Model Manager requires at least one Schematic database in the MDB beingused.

To make full use of the features available in Schematic Model Manager it is alsorecommended that a Dictionary database is created for the definition of the defaultSchematic Model Manager UDAs and a Design database is created for storing documentlinks and system hierarchies.

2.1.2 UDA Creation

Schematic Model Manager makes use of UDAs to store additional attribution from thesource ISO 15926 files. Of particular importance are the UDAs used to store informationabout page connectivity and source system persistent identities. The UDAs should beadded to the MDB as follows:

1. Create a Dictionary database and ensure it is part of the MDB in use.2. Open the LEXICON Module.3. Select UDA Catalogue... from the Schematic Model Manager menu.4. Select Ap ply from the UDA Catalogue dialogue.5. Select Save Work from the LEXICON menu.

See Configuring UDAs for further information on maintaining Schematic Model Managerdefined UDAs.

Creating the required UDAs in this way will automatically add the required attributemappings associated with the chosen UDAs.When upgrading from a previous version of Schematic Model Manager you should re-runthis activity with the new version. This is to ensure that your schematic database containsany new UDAs required by Schematic Model Manager.

2.2 Mapping Set-UpSchematic Model Manager includes a default set of GTYPE and attribute mappings. Theseare intended to give a reasonable starting point for the use of Schematic Model Manager,but will need to be assessed for each project, and amended or added to where appropriate.Schematic Model Manager provides tools which help in this task. See Import Configuration

Tab .


22/254

12.02:2


2.2.1 GTYPE Mapping

The default GTYPE mappings map a commonly used set of ISO 15926 classifications totheir corresponding GTYPE and SCSTYPE in the AVEVA P&ID schematic database.

The GTYPE mappings can be configured before importing any data, either manually or byanalysis of a set of source files, or may be configured after importing the data by analysingthe database(s). Once the mappings have been edited, any data in the schematicdatabases may have the mappings reapplied in order to update their attribution. Please seeViewing/Editing Import Destination SCGROUP Elements .

The GTYPE and SCSTYPE attributes may also be set using the Attribute mappings.GTYPEs and SCSTYPEs configured in AVEVA P&ID will be loaded automatically using thedefault attribute mappings whether or nor GTYPE mappings have been configured.

GTYPEs and SCSTYPE attributes set by the attribute mappings or derivation rules willoverride the GTYPE mappings.

2.2.2 Attribute Mapping

Attribute mappings should be configured before loading data as any subsequent changes tothe mappings will mean that previously imported data must be re-imported in order for thenew mappings to be applied to it. Attribute mappings are crucial to the page matchingprocess and must be correctly configured in order for diagrams to be matched and merged.

If default UDAs are being used, then all of the core attributes from the source data shouldalready be populated, but system-specific attributes stored within the GenericAttributeselements in the import files will not be present. To configure attribute mappings see Viewing/Editing Attribute Mappings .

Note: The rest of this section is relevant if source data is imported from files in the 3.2.0format of the ISO 15926 schema. It is not relevant if data is imported from version3.3.3 files or later.

The source data may use system-specific attributes in order to specify how segments areconnected across diagrams. If the source data has been generated using AVEVA P&ID andthe Schematic Model Manager default attribute mappings relating to the SCOPCI andSCOPCO schematic database elements have not been amended, then no additional cross-page connectivity related attribute mappings will be required. Pre-configured Attributemappings for matching page connections are provided with the application.

However, if the source data was generated from an alternative gateway or tool, cross-pageconnectivity attribute mapping may need to be configured in order to ensure that cross-pageconnectivity is maintained. To do this:

1. Find the values of the AttributeName attributes on the CrossPageConnection XMLelements in the source data file.

2. Open the source data file in a tool capable of displaying XML files (the contents of thesource file will not need to be edited). Find the values of the AttributeName attributeson the CrossPageConnection XML elements.The following example shows the CrossPageConnection element in a data sourcegenerated by AVEVA P&ID:


23/254


12.02:3

In this example the AttributeName attribute of the CrossPageConnection XML elementis "PipeId".

3. Ensure that the Schematic Model Manager source dictionary has been populated froma file or files which match the source data structure that will be used to load P&IDs intothe project (see Configuring the Source Data Dictionary ).

4. Using the attribute mapping tool, create an attribute mapping which operates on theSCOPCI and SCOPCO schematic database elements. The default attribute mappingmay be used on these elements when the Schematic Model Manager is installed as abasis for your custom attribute mapping.

5. The UDA :Pmgdfltmatch has been defined for storing diagram connection attributevalues where only one attribute is used for the connection. Set the database attributevalue of the attribute mapping to :Pmgdfltmatch:

6. The correct source data attribute must now be mapped to the UDA :Pmgdfltmatch, toensure that page matching occurs.


24/254

12.02:4


To do this, click the ellipsis button to the right of the attribute mapping's Source Attributefield. This will open the XPath expression builder:

7. Navigate to the attribute used in the source data file to store cross-page connectivitymatching values.The source data attribute PipeId is used in the AVEVA Schematic Model ManagerGateway. The example above shows this source attribute and its associated mappingin the Source Dictionary window of the Schematic Model Manager XPath ExpressionBuilder.

8. A mapping from this source data file attribute to the UDA :Pmgdfltmatch has now beencreated.If cross page connectivity in the source data files is represented using more than oneattribute, then it will be necessary to create additional UDAs against the SCOPCI andSCOPCO schematic database elements, and to then create additional attributemappings to ensure that these are populated during an import.

2.2.3 Page Matching

If issues with on and off page connectors not being correctly associated are created, thenconsult Attribute Mapping .


25/254


12.02:5

2.3 Attr ibute Der ivat ion RulesWhen attributes are imported, the values of attributes may be automatically set according to

user-defined rules based on DB Expressions, known as Attribute Derivation Rules.Default attribute derivation rules are not shipped with Schematic Model Manager.

It is recommended that attribute derivation rules are configured prior to importing data intothe schematic database. This is because attribute derivation rules cannot be applied toexisting elements in the schematic database, other than by re-importing existing schematicdata from the source import file or files.

A rule is set up by selecting the element type or types to which the attribute in questionbelongs. The attribute itself is then selected. The list of attributes available for selection isrestricted to those common to all the selected element types.

The DB Expression to be applied to the attribute during processing is then entered.

If required, filters may be set up to restrict the instances of elements, based on the value ofone or more of their attributes, to which the rule is applied.

Rules are grouped into rule groups. Rule groups may contain both rules and other rulegroups. As required, individual rules or an entire rule group may be switched off, i.e. setthat they are not applied on import.

Please see Viewing/Editing Attribute Derivation Rules for further information.


26/254

12.02:6



27/254

Schematic Model Manager User GuideSchematic Model Manager Project Options

12.03:1

3 Schematic Model Manager Project Opt ions

The Project Options dialog is used to set Schematic Model Manager project settings.

To access the dialog, select the Project Options... option from the Tools menu.


28/254

12.03:2


The Project Options dialog is then displayed.

The Project Options dialog consists of four tabs, as described below.

To save changes to the options and exit the dialog, select the OK button.

To exit the dialog without saving, select the Cancel button.


29/254


12.03:3

3.1 Element Release Tab

Some elements in the schematic database may be accessed by AVEVA Schematic 3DIntegrator, for integration into the Plant DESIGN or Marine Hull and Outfitting database.

Access to such elements by AVEVA Schematic 3D Integrator is controlled by the schematicdatabase release status of these elements.

The Element Release tab is used to specify: The element release status related actions carried out during the import of an

ISO15926 file into the schematic database. If the Release Comments dialog is displayed during release related activities initiated

during an import, and whether or not date and time stamps are automatically added tothe beginning of release comments.

3.1.1 Set Release Behaviour of Elements on Import

These options define the release behaviour of elements on import. Release behaviour isthe course of action taken during the P&ID import process for an element category, i.e.whether or not elements within that category are imported and the release status they areset to if they are.

Every imported element falls into one of three categories: Existing elements (i.e. elements imported before) that have been released

Existing elements that have not been released


30/254

12.03:4


New elements, i.e. elements not imported before

A different release behaviour can be specified for each category of element.

Exis ting Elements - Released

Select from the following options:

Ab or t Diagram Imp or t - If this option is selected, no elements will be imported fromdiagrams that include released elements. The release status of previously importedelements is retained. Default setting.

Import and set release status to OFF - The elements are imported and their releasestatus changed to not released.

Import and keep existi ng status (ON) - The elements are imported and their releasestatus retained, i.e. set to released.

Exis ting Elements - Not Released

Select from the following options: Import and keep existing status (OFF) - The elements are imported and their release

status retained, i.e. set to not released. Default setting. Import and set release status to ON - The elements are imported and their release

status changed to released

New Elements


31/254


12.03:5

Select from the following options: Set release status to OFF - The elements are imported and their release status set to

not released. Default setting Set release status to ON - The elements are imported and their release status set to

released.

3.1.2 Display Comments Dialog on Release to 3D

If the release comments are to be entered when data is released and un-released to the AVEVA Schematic 3D Integrator during an import, check the Enable Release Commentscheckbox. If not, uncheck the checkbox.

If the checkbox is checked, a Release Comments field is displayed when importingdiagrams using the user-interface (see Importing Diagrams ), for use when the releasestatus of an element is automatically changed when diagrams are imported.

To automatically add a date and time stamp to the beginning of release comment fields,check the Ad d Date/Time stamp to Release Com men t checkbox. This checkbox isdisabled if the Enable Release Comments checkbox is unchecked.

The date/timestamp format is as follows:

Dat e: [ Dat e f or mat t ed usi ng cl i ent r egi onal set t i ngs][ Hour s: Mi ns]

Note: For further information on Schematic Model Manager release related behaviour, referto 20.2: Appendix B: Releasing to 3D and the Schematic Database .

3.2 General Tab


32/254

12.03:6


The General tab is used to: Copy options settings from another project associated with the same PDMS instance/

Installation. Import options settings from files exported from another PDMS installation. Export options settings to files for importing into other PDMS installation. Reset the project to the default installation settings.

Note: Copying settings from another project, importing setting from files, and resetting tothe default settings will change the Attribute mappings, GTYPE mappings, and

Attribute derivation rules of the project, as well as the project options set up using theProject Options dialog.

3.2.1 Copying Schematic Model Manager Options from another Project

Schematic Model Manager option settings apply to the current project. Schematic ModelManager creates a record of Schematic Model Manager related options of a project, which itstores locally. This is done when a project is opened in PDMS, with Schematic ModelManager installed, and the default Schematic Model Manager options are amended.

To copy project options from another project, press the Copy from Project button. TheSelect Project dialog is then displayed and all Projects which have Schematic ModelManager options defined will be displayed.

The Select Proj ect dialog is then displayed.

The dialog lists all of the projects on the current PDMS installation for which SchematicModel Manager options have been saved.

Press the OK button. The options are then copied from the selected project. A message isdisplayed when the copy is complete.


33/254


12.03:7

3.2.2 Exporting Schematic Model Manager Options

Schematic Model Manager options can be exported to a file, which can then be imported byother PDMS/Marine installations for use by other projects (see below).

Press the Export button. The Browse For Folder dialog is then displayed. Browse for thelocation that the options file is to be exported to and press the OK button.

The options specified for the current project are then exported to that location into a file withthe default name of _Opt i ons. zi p . A message is displayed when the exportis complete.

3.2.3 Importing Schematic Model Manager Options

As described above, the options settings of a project can be exported to a file. This file canthen be imported into another project. The options settings of that project are then changedto those in the file.

Press the Import button. The Browse For Folder dialog is then displayed. Browse for thezip file containing the options. The default file name of the export files is_Opt i ons. zi p .

Select the OK button. The import then takes place, and the existing options settings arereplaced by those in the import file. A message is displayed when the import is complete.

3.2.4 Restore Default Options

To restore the default Schematic Model Manager options, press the Reset Defaults button.

Note that this will reset all GTYPE Mappings, Attribute Mappings, Attribute Derivation Rulesand project options. A message requesting confirmation of the reset is displayed:


34/254

12.03:8


A message is displayed when the reset is complete.

3.3 Import Configuration Tab

The Import Configuration tab is used to: set default SCGROUP database elements to import diagrams, off-line instruments, off-

line equipment and pipelines into set the default coordinates of equipment and off-line instruments specifying whether or not drawings are to be imported in colour

3.3.1 Viewing/Editing Import Destination SCGROUP ElementsWhen diagrams (SCDIAG), off-line instruments (SCOINS), off-line equipment (SCEQUI)and pipelines (SCPLIN) are imported, they are automatically placed in groups (SCGROU)within the database hierarchy.

The groups these elements are placed in may be specified using attribute mappings (seeViewing/Editing Attribute Mappings for details).

Alternately, the groups that these elements are placed in can be specified by the user usingthe Import Destination Groups dialog, as described below.

If both an attribute mapping and the Import Destination Groups dialog have been used tospecify the destination group for an element, then the attribute mapping will be applied.


35/254


12.03:9

If neither of these methods is used, the elements are instead placed in default groups, whichare automatically created in the database as part of the import process (if they do notalready exist).

The names of the default groups are in the following format:

/ */

For example:

To view or edit the groups into which diagrams, off-line equipment, equipment and pipelinesare imported into, press the View/Edit button on the Import Configuration tab. The ImportDestinatio n Groups dialog is then displayed.

The Database field displays the name of the current Schematic database. To view/changethe import destination groups of another database, select it from the drop-down list. The listconsists of every Schematic database in the MDB.

The grid beneath the Database field lists the four element types and the names of thegroups into which they are imported.


36/254

12.03:10


To select a different group for an element type, select the ... button at the end of the row.The Select Grou p dialog is then displayed:

Browse for the required group and select the OK button. Press the Cancel button to closethe dialog without making any changes.

Repeat as required for each of the four element types.

Press the OK button to close the Import Destination Groups dialog and save any changesthat have been made. Press the Cancel button to close the dialog without saving changes.

3.3.2 Viewing/Editing Equipment and Off Line Instrument Positions

The attributes of imported equipment and off-line instruments may not include a 3D positionfor these items. Therefore a default position that is to be used when creating 3D elementsmay be specified for use by such items.

The default position is entered in the Off Line Equipment & Instruments Default Positionfield on the Import Configuration tab.

For example:


37/254


12.03:11

For details of the format in which the coordinates must be entered, refer to PDMS or Marinedocumentation.

3.3.3 Specifying whether or not Drawings are to be Imported in Colour If drawings are to be imported in colour, ensure that the Import diagrams in colour checkbox is checked. This is the default setting.

If the checkbox is checked, drawings are imported in their original colours.

If the checkbox is not checked, all drawings are converted to black and white when they areimported.

3.4 Units Tab

Different diagrams may include measurements in different units of measure. For example,on one diagram weight may be measured in Kilograms, on another it may be measured inPounds. On import, all such measurements are converted into the units of measure used in

the Schematic database.The Units tab is used to select the units of measure that measurements are to be convertedinto. For example, the tab can be used to specify that all weight attributes values are to beconverted into Kilograms and all Volume attribute values are to be converted into CubicMetres.

In the An gle , Ar ea , Pressure , Temperature , Volume and Weight fields, select the unit ofmeasure to be applied to values measured in these unit types.

Note that the value in the Distance field cannot be changed because all distances aremeasured in millimetres in the database.


38/254

12.03:12


The default units of measure are as follows:

Changing the unit of measure for a unit type will not update the units of measure forinstances of this unit type that have already been imported. Previously imported data mustbe re-imported for the change to take effect.

The Schematic Model Manager default UDAs include attributes on the SCDIAG elementsthat store the units of measure used when a diagram is loaded. To determine the units for anattribute value determine which diagram the element was last loaded from and view theappropriate :Pmgunts attribute for the diagram.

Unit Type Default Units of Measure

Angle Degrees

Area Square Metres

Distance Millimetres

Pressure Bar

Temperature Degree Celsius

Volume Cubic Metres

Weight Kilogram


39/254

Schematic Model Manager User GuideSchematic Model Manager User Options

12.04:1

4 Schematic Model Manager User Options

The User Option s dialog is used to set user specific Schematic Model Manager options. Toaccess the dialog, select the User Options... option from the Tools menu.


40/254

12.04:2


The User Optio ns dialog is then displayed.

To save changes to the options and exit the dialog, select the OK button.

To exit the dialog without saving, select the Cancel button.

4.1 Import OptionsIf the Import Progress dialog (see Import Progress Dialog ) is to be closed automaticallywhen an import is complete, ensure that the Close Import Progress screen on importcompletion checkbox is checked. The default setting is unchecked.

4.2 File Locations

4.2.1 Set Default Import Locat ion

The default location which is accessed when browsing for files containing ISO 15926 data toimport or view is displayed in the Default Location field of the Data Import row in the FileLocations grid.


41/254


12.04:3

To change the default folder, select the Data Import row, and press the Modify button. TheBrowse for Folder dialog is then displayed.

Browse for the required folder and press the OK button. The new location is then displayedin the Default Locatio n field.

4.2.2 Set Default Export Locat ion

The default location to which options data is exported (see Import Configuration Tab ), isspecified in the Default Loc ation field of the Data Export row in the File Locations grid.

To change the default folder, select the Data Export row, and press the Modify button.

The Browse for Folder dialog is then displayed. Browse for the required folder and pressthe OK button. The new location is then displayed in the Default Locatio n field.


42/254

12.04:4



43/254

Schematic Model Manager User GuideViewing/Editing Attribute Derivation Rules

12.05:1

5 Viewing/Edi ting Attribute Derivation Rules

When diagrams are imported, the values of attributes may be automatically set according touser-defined rules, known as Attribute Derivation Rules. There are no default rules shippedwith Schematic Model Manager.

To view or edit Attribute Derivation Rules, select the At tr ib ute Derivat io n Rules... optionfrom the Tools menu.


44/254

12.05:2


The At tr ib ute Deri vat ion Ru les dialog is then displayed.


45/254


12.05:3

Rules are grouped into rule groups. Rule groups may contain both rules and other rulegroups. The left-hand pane of the dialog displays all existing rules and rules groups. All rulesand groups are grouped under a node called Attribute Processing Rules.

The currently selected element is displayed in bold. Details of the currently selected elementare displayed in the right-hand pane.

Rules that are not selected to be applied during import are greyed out (see below).

Invalid rules are displayed in red text.

Press the OK button to close the dialog and save any changes that have been made. Pressthe Cancel button to close the dialog without saving changes.


46/254

12.05:4


5.1 Selecting Rules to be Applied During ImportEach rule and rule group listed in the dialog has an enabled checkbox next to its name.

These are used to select which rules are to be applied during import.If a rule group checkbox is unchecked, all the rules and rule groups within that group areunselected, whether or not their checkboxes are checked.

If the At tr ibut e Pro cessi ng Rules checkbox is unchecked, all rules and rule groups areunselected, whether or not their checkboxes are checked.

Unselected rules and groups are greyed out, i.e. displayed in grey, or pale red if invalid.

5.2 Creat ing/Edit ing Rule Groups1. To create a new rule group, right-click on the Schematic Attribute Rules node, or the

node of an existing group, or on an existing rule, and select either Create > Group orInsert > Group from the menu that is then displayed. If the Create option is selected, the new group is created within the currently

selected node, beneath any rules and groups already in that node. If the Insert option is selected, the new group is created above the currently

selected node, or at the top of the list of rules and group if the Attribute ProcessingRules node was selected.


47/254


12.05:5

The new group is created and given the default new group name (New Group):

2. Select the new group. Details of the new group are displayed in the right-hand pane:

3. Enter the name of the new group.4. If the new rule group is to be processed, select True from the Enabled field.

Otherwise select False. The state of the checkbox against the rule group in the left-hand pane will change to reflect the setting made here, and vice versa.

5. Click outside of the dialog to create the new group and close the dialog.

To edit an existing rule group, simply select it so that its details are displayed in the right-hand pane and proceed as described above to edit them.

5.3 Creating/Editing Rules

5.3.1 Creating a Rule

1. To create a new rule, right-click on the Schematic Attribute Rules node, or the node ofrule group or a rule, and select either Create > Rule or Insert > Rule from the menuthat is then displayed. If the Create option is selected, the new rule is created within the currently selected

node, beneath any rules and groups already in that node. If the Insert option is selected, the new rule is created above the currently selected

node, or at the top of the list of rules and group if the Schematic Attribute Rulesnode was selected.

The new rule is created and given the default new rule name (New Rule):


48/254

12.05:6


2. Select the new rule. Details of the new rule are displayed in the right-hand pane:

3. Enter the name of the new rule in the Name field. This is optional, as a name derivedfrom the properties of the rule will be assigned to the rule when it is created. The nameentered here will suffix this identifier (see below for details).

4. If the new rule is to be processed, select True from the Enabled field. Otherwiseselect False. The state of the checkbox against the rule in the left-hand pane willchange to reflect the setting made here, and vice versa.

5. The number of attribute filters set up for the rule displayed in the At tr ibut e fi lt ers field.To add an attribute filter, click on the ... button at the end of the At tr ib ute f il ter s field.The At tr ibut e Fil ter s dialog is then displayed.


49/254


12.05:7

i. Enter a valid attribute in the displayed At tr ib ute field, or select a attribute from thedrop down.

ii. In the Operator field, select the required operator from the drop-down list.

iii. The In the List operator enables you to specify a list of values (separated byspaces) for the specified attribute value. These can be numeric or non-numeric,depending on the type of the attribute. For example, Attribute=AREA, Operator="Inthe List", Value="0 1 3", would find items which have AREA attribute equal to either0 or 1 or 3.

iv. In the Value field enter an appropriate value.v. Multiple attribute filters can be applied. To do so, click on the Ad d Fil ter option. A

new row of fields in which filter details can be entered is then displayed.vi. To delete a filter or filters, select the row or rows they are displayed in and click on

the Delete Filter option.vii. Once the required filters have been set up, press the OK button to close the dialog.

To close the dialog without saving any changes, press the Cancel button.6. Select the attribute to which the rule is be applied from the At tr ib ute field. The list

consists of the attributes shared by the selected Element Types, i.e. only attributeswhich are common to all the selected Element Types are listed.

If the selected element types are changed, the list of valid attributes may also change.If an attribute was selected that is now invalid, another attribute must be selected.

7. If a rule is a Name Clash Rule, select True in the NameClashRule field. Otherwiseleave this set to False.

The name attribute value of an element must be unique in the database. Due to theapplication of a rule, the name of an element may be set to a value that is already inuse. This is called a "name clash".


50/254

12.05:8


Name Clash Rules are set up to prevent this. If a name clash is detected during animport, the process will search for the Name Clash Rule of the element's element type(if one exists), and apply that instead.

It is recommended that for each rule which attempts to set the Name attribute of one ormore elements, there should be a corresponding Name Clash Rule, which SchematicModel Manager can apply to the Name attribute value of the same elements in theevent of a name clash.

8. If the application of a Name Clash Rule still results in a clash, or if there is no NameClash Rule found for the element type(s), a default name is applied instead.

9. The value applied to the selected attribute is determined by a DB expression. To enterthis expression, select the ... button at the end of the DB Expression field. The EditDB Expression dialog is then displayed.

Enter the required DB Expression.

For information on DB Expressions, refer to Expressions in the PDMS DatabaseManagement Reference Manual .

Select the OK button. The entered expression is then displayed in the DB Expressionfield.

If the expression is valid, a green tick will be displayed to the left of this field. If theexpression is invalid, or if no expression has been entered, a red cross is displayed.Invalid expressions are displayed in red text.

Note: If the DB Expression field is left blank, or an invalid DB Expression is provided, therule will be shown in red in the Attribute Derivation Rules explorer, and the rule willnot be active.


51/254


12.05:9

10. To select an element type or types to which the rule is to be applied, select the ... buttonat the end of the Element Types field. The Select Values dialog is then displayed.

11. The Select Values dialog consists of two lists. The Availabl e Values list lists theElement Types which are available for selection. The Selected Values list lists theElement Types that have been selected.To select an Element Type, select it in the Available Values list and press the > buttonto transfer it to the Selected Values list.To de-select an Element Type, select it in the Selected Values list and press the > button to move all Element Types to the Selected Values list. Use the


52/254

12.05:10


Attribute: NAME

Rule Name: (not defined)

...will be called:SCEQUI/NAME

5.3.3 Editing a Rule

To edit an existing rule, simply select it so that its details are displayed in the right-handpane and proceed as described above to edit them.

5.4 Moving Rules and Rule GroupsRules and rule groups can be moved to a different location in the hierarchy of rules and

groups by: Dragging and dropping Using the Ctrl+X (Cut) and Ctrl+V (Paste) keyboard commands Selecting the Cut and Paste options from the right-click menus of rules and groups.

If a rule group is moved, all rules and groups within that group are moved with it.

The Attribute Processing Rules node cannot be moved.

5.5 Delet ing Rules and Rule GroupsTo delete a rule or group, either select it and press the Delete key, or right-click and select

the Delete option. A message is then displayed, requesting that the deletion be confirmed.Press Yes to continue with the deletion.

If a rule group is deleted, all rules and groups within that group are deleted with it.

The Attribute Processing Rules node cannot be deleted.


53/254

Schematic Model Manager User GuideViewing/Editing Attribute Mappings

12.06:1

6 Viewing/Editing Attribute Mappings

To map system/project specific attributes from the source files to schematic or user-defineddatabase attributes, or to view existing mappings, use the At tr ib ut e Mapp ings dialog.

To access this dialog, select the At tr ibut e Mapp ing... option from the Tools menu in theSchematic Model Manager module or the At tr ibut e Mapp in g option from the SchematicModel Manager menu in the LEXICON module.


54/254

12.06:2


The At tr ib ute Mapp in gs dialog is then displayed:

The dialog can be used to organise attribute mappings into attribute mapping groups.

The dialog is divided into two sections. The left-hand section displays a tree-view of thecurrent attribute mapping groups and the attribute mappings they contain, and is used tocreate, move and delete mappings and groups.

The right-hand section displays the properties of the attribute mapping or mapping groupselected in the left-hand section, and is used to enter and edit these properties.

To close the dialog and save changes made to attribute mapping, press the OK button. Toclose the dialog without saving changes, press the Cancel button.

Note: Changes made in the LEXICON module are not committed to the database until aSave Work takes place.

6.1 Tree ViewThe tree view displays the hierarchy of attribute mapping groups and attribute mappings.

Attribute mapping groups may contain other attribute mapping groups as well as mappings. All groups and mappings are grouped under a node called Attribute Mappings. Attributemapping groups are represented by folder icons. Attribute mappings are represented bybook icons.

In older versions of Schematic Model Manager, attribute mappings were not organised intogroups. Any mappings created using these older versions of Schematic Model Manager areautomatically grouped into an attribute mapping group called Default Mappings whenSchematic Model Manager is upgraded.

Attribute mapping group nodes can be opened and closed using the + and - symbols.


55/254


12.06:3

6.2 Default At tr ibute Mappings A number of default mappings are supplied with Schematic Model Manager. They are listed

in the Default Mappings attribute mapping group folder.

If required, these default mappings can be edited.

To edit an attribute mapping, select it in the tree view. The properties of the mapping arethen displayed in the right-hand section, and can be edited as described in Creating

Attribute Mappings .


56/254

12.06:4


6.3 Creat ing Attribute Mapping GroupsTo create a new attribute mapping group right-click on either the top-level Attribute

Mappings node, or on an existing attribute group node. From the menu that is thendisplayed, select either the Create > Attribute Group option or the Insert > AttributeGroup option.

If the Create option is selected, the new attribute group node with the default name of New Attribute Mappings is then created at the bottom of the hierarchy of groups and mappingswithin the currently selected node.

If the Insert option is selected, the new attribute group is instead created directly above thenode that was selected when the option was selected. The Insert option is not availablefrom the top-level Attribute Mappings node.

The right-hand section of the dialog displays the properties of the new group.

Complete these properties to set up the attribute mapping group.1. In the Name field, change the default name of the mapping as required. Alternatively,

double-click on the name in the tree-view and type in the name. A mapping name maybe up to 50 characters. The @ symbol may not be included.

2. The Element Types field displays the SCTYPEs to which the mappings in the groupcan be applied.If no SCTYPEs are specified in this field, all SCTYPEs may be selected for mappings inthe group.


57/254


12.06:5

To select the SCTYPEs, press the ... button at the end of the field. The Select Valuesdialog is then displayed.

3. The Select Values dialog consists of two lists. The Availabl e Values list lists theSCTYPEs which are available for selection. The Selected Values list lists theSCTYPEs that have been selected.To select an SCTYPE, select it in the Available Values list and press the > button totransfer it to the Selected Values list.To de-select an SCTYPE, select it in the Selected Values list and press the < button totransfer it back to the Available Values list.Use the >> button to move all SCTYPEs to the Selected Values list. Use the


58/254

12.06:6


7. The File Format Version field displays the versions of the source file formatassociated with the source file attributes in the group. The default entry is blank,meaning all versions.

To select the versions, press the ... button at the end of the field. The Select Valuesdialog is then displayed.

See Creating Attribute Mapping Groups for details of this dialog.

6.4 Creating At tr ibute MappingsTo create a new attribute mapping right-click on either the top-level Attribute Mappingsnode, or on an attribute group node, or on an existing attribute mapping. From the menu thatis then displayed, select either the Create > Attribute Mapping option or the Insert >

At tr ib ute Gro up option.

If the Create option is selected, a new attribute mapping with the default name of New Attribute Mapping is then created at the bottom of the hierarchy of groups and mappingswithin the current node.

If the Insert option is selected, the new attribute mapping is instead created directly abovethe node that was selected when the option was selected.


59/254


12.06:7

The right-hand section of the dialog displays the default properties of the new mapping.

Complete these properties to set up the attribute mapping.

1. In the Name field, change the default name of the mapping as required. Alternatively,double-click on the name in the tree-view and type in the name. A mapping name maybe up to 50 characters. The @ symbol may not be included.

2. The Element Types field displays the SCTYPEs to which the mapping is to be applied.To select the SCTYPEs, press the ... button at the end of the field. The Select Valuesdialog is then displayed.Refer to Creating Attribute Mapping Groups for details of this dialog.The SCTYPES that are available for selection are limited to those specified for themapping group. If no SCTYPEs are specified for the group, any available SCTYPEmay be selected.

3. In the Database Attribute field select the UDAs/database attributes to which thesource file attribute is to be mapped to. The attributes that may be selected will bethose common to the SCTYPEs selected in the Element Types field.

4. Whether or not an attribute mapping is applied can be made conditional. To enter theconditions, press the ... button at the end of the Condition field and enter an XPath

Expression using the XPath Expression Builder dialog. See XPath Expression Builder Dialog for details.

If an invalid expression is entered, False is displayed in the Condition field, indicatingthat the mapping cannot be applied. If a valid expression is entered, True isdisplayed.

True is also displayed if no conditions are entered. If no conditions are entered,mappings are applied by default.

Note: Conditions may also be set up for the group as a whole. If conditions have beensetup for both the group and the mapping, both sets of conditions must be satisfied ifthe mapping is to be applied.


60/254

12.06:8


5. In the Source Attribute field, either enter the name of the source file attribute. Alternatively, press the ... button at the end of the field and enter an XPath Expressionusing the XPath Expression Builder dialog. See XPath Expression Builder Dialog for

details.6. In the At tr ib ut e Uni ts field, if applicable select the type of unit (e.g. weight, volume)associated with the source file attribute from the drop-down list.

Alternatively, press the ... button at the end of the field and enter an XPath Expressionusing the XPath Expression Builder dialog. See XPath Expression Builder Dialog fordetails.

This field may be automatically completed if the XPath Expression Builder dialog isused to enter an XPath Expression in the Source Attribute field. See Automatic Setting of Attribute Units and Types .On import, the type of unit will be converted to the unit of measure (e.g. kilogram, cubicmetres) specified on the Units tab of the Project Options dialog. See Units Tab .

7. In the Source Attribute Type field, enter the source attribute type, e.g. string, integeretc. The default entry is string.This field may be automatically completed if the XPath Expression Builder dialog isused to enter an XPath Expression in the Source Attribute field. See Automatic Setting of Attribute Units and Types .

8. In the File Format field, select the import source file format associated with the sourcefile attribute from the drop-down list. The default entry is that of the attribute group.

9. The File Format Version field displays the versions of the source file formatassociated with the source file attribute. The default entry is that of the attribute group.

To select the versions, press the ... button at the end of the field. The Select Values dialogis then displayed.


61/254


12.06:9

See Creating Attribute Mapping Groups for details of this dialog.

6.5 XPath Expression Builder DialogThe XPath Expression Builder dialog is accessed from the Condition , Source Attributeand Source Attribute Units fields of the main At tr ib ut e Mapp ings dialog. It is used toconstruct XPath expressions to populate these fields.

For more information on XPath expressions, see 20.3: Appendix C: XPath Expressions .

The dialog includes a Build tab, used to construct expressions (see Building Expressions ),and a Preview tab which is used to test them (see Setting up Mappings Using the XPath Expression Builder Dialog - Examples ).

6.5.1 Bui ldi ng ExpressionsExpressions are constructed using the Build tab. The Build tab consists of three sections.The Source Dictionary pane section, the Shortcuts, XPath Operators and XPath Functionstabs section and the Expression pane section.

An XPath expression may be constructed manually, by typing directly into the Expressionarea of the dialog. In addition, source file attributes for inclusion in the expression may beselected from the Source dictionary, by navigating to the required element in the sourcedictionary tree view and double clicking on the required attribute. This attribute will then beadded to the expression.

Additional elements for constructing an XPath expression are provided on the Shortcuts,XPath Operators and XPath Functions tabs.


62/254

12.06:10


Once the required expression has been constructed, select the OK button to close thedialog. The expression is then displayed in the relevant field in the main At tr ibut eMappings dialog.

Source Dict ionar y Pane

The Source Data Dictionary is a tool which helps in visualising and understanding the

potential contents of import files, in terms useful when creating attribute mappings.The Source Dictionary pane contains a tree-view that lists all the relevant Source DataDictionary information for the current attribute mapping or attribute mapping group.

The database element types are al

Schematic Model Manager User Guide

Documents