Professional Documents
Culture Documents
Schematic Model Manager User Guide
Schematic Model Manager User Guide
User Guide
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 November 2007. This revision published September 2009.
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
1:3
1:3
1:3
1:3
1:3
1:3
1:4
1:4
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:4
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:8
Pre-configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
Post Installation Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
Database Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
UDA Creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
12.0
3:6
3:7
3:7
3:7
ii
12.0
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:7
iii
12.0
10:4
10:5
10:5
10:6
12:3
12:4
12:5
12:6
iv
12.0
12.0
Appendices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:1
Appendix A: Regular Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:1
Alternation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Grouping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Quantification using Metacharacters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Regular Expression Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
20:1
20:1
20:2
20:6
20:15
20:18
20:19
20:22
vi
12.0
Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Pseudo Attribute Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Example Rule: Component Rules - Butt Welded Piping Cap. . . . . . . . . . . . . . . . . . . . . .
Saved Search Setup and Export to Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
vii
20:44
20:45
20:46
20:48
12.0
viii
12.0
Introduction
1.1
1.2
1:1
12.0
1.3
Refer to the Plant DESIGN Module or Marine Hull and Outfitting Module documentation for
details.
1.4
Importing Drawings
Most facilities of the module are accessed using menus and toolbars. For details of these
menus and toolbars, see Schematic Model Manager Menus and Toolbars.
1:2
12.0
1.4.1
1.4.2
1.4.3
Importing Drawings
The File menu also provides access to the facilities used to import diagram data. These
options are also available on the SMM toolbar.
See Importing Diagrams.
The Diagram Connector, which is used to manually connect page connectors between
imported diagrams, is accessed from the Tools menu and the SMM toolbar. See Diagram
Connector.
1.4.4
1.4.5
1.4.6
1:3
12.0
1.4.7
1.4.8
1.5
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 Marine
Hull and Outfitting module documentation.
1:4
12.0
Import:
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 Hull
and Outfitting module documentation.
1:5
12.0
View Menu
Catalog Search: This search facility provides direct access to the Plant or Marine
catalogue. See Catalogue Search.
Diagrams: This option is used to view imported diagrams. See Viewing Imported Diagrams.
For details of the other options on this menu, refer to the Plant DESIGN module or Marine
Hull and Outfitting module documentation.
Explorers:
The Schematic Explorer option is used to access the Schematic Explorer. See Schematic
Explorer.
For details of the other options on this menu, refer to the Plant DESIGN module or Marine
Hull and Outfitting module documentation.
1:6
12.0
Tools Menu
Diagram Connector: Accesses the Diagram Connector, which is used to manually connect
page connectors between imported diagrams. See Diagram Connector.
Set Release Status: Used to set the release status of the current element, i.e. to release it
to or un-release it from the 3D model. See Releasing and Un-Releasing Data.
Attribute Derivation Rules: Accesses facilities to set up rules that will be used to
automatically set the values of attributes during an import. See Viewing/Editing Attribute
Derivation Rules.
Attribute Mapping: Accesses facilities to map system/project specific attributes from the
source files to schematic or user-defined database attributes. See Viewing/Editing Attribute
Mappings.
GTYPE Mappings: Accesses facilities to edit the mappings between ISO15926
designations and corresponding GTYPE/SCSTYPE combinations. See Viewing/Editing
GTYPE Mappings.
Source Dictionary Management: Accesses tools for maintaining the Source Data
Dictionary which is used to visualise the potential contents of import files when editing the
attribute mappings and to keep track of metadata about source files such as the source
systems that data has come from. See Configuring the Source Data Dictionary.
Line List Options: Accesses facilities for specifying the settings which define how line lists
will be generated. See Line List Configuration.
Project Options: Accesses facilities for specifying project-wide configuration settings. See
Schematic Model Manager Project Options.
1:7
12.0
User Options: Accesses facilities for specifying user-specific configuration settings. See
Schematic Model Manager User Options.
For details of the other options on this menu, refer to the Plant DESIGN module or Marine
Hull and Outfitting module documentation.
Window Menu
Refer to the Plant DESIGN module or Marine Hull and Outfitting module documentation for
details of this menu.
Help Menu
Refer to the Plant DESIGN module or Marine Hull and Outfitting module documentation for
details of this menu.
1.5.2
Toolbars
Search Toolbar
Refer to the Plant DESIGN module or Marine Hull and Outfitting module documentation for
details of this toolbar.
1:8
12.0
Standard Toolbar
Refer to the Plant DESIGN module or Marine Hull and Outfitting module documentation for
details of this toolbar.
SMM Toolbar
History Toolbar
Refer to the Plant DESIGN module or Marine Hull and Outfitting module documentation for
details of this toolbar.
1:9
12.0
1.6
The UDA Catalogue option is used to specify which User Defined Attributes (UDAs)
are available in each Schematic database with which Schematic Model Manager
operates, and to maintain the Attribute Mappings associated with the UDAs.
The Attribute Mappings option is used to map system/project specific attributes from
the source files to schematic attributes or UDAs.
1:10
12.0
Pre-configuration
2.1
2.1.1
Database Configuration
Schematic Model Manager requires at least one Schematic database in the MDB being
used.
To make full use of the features available in Schematic Model Manager it is also
recommended that a Dictionary database is created for the definition of the default
Schematic Model Manager UDAs and a Design database is created for storing document
links and system hierarchies.
2.1.2
UDA Creation
Schematic Model Manager makes use of UDAs to store additional attribution from the
source ISO 15926 files. Of particular importance are the UDAs used to store information
about page connectivity and source system persistent identities. The UDAs should be
added 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 Apply from the UDA Catalogue dialogue.
5. Select Save Work from the LEXICON menu.
See Configuring UDAs for further information on maintaining Schematic Model Manager
defined UDAs.
Creating the required UDAs in this way will automatically add the required attribute
mappings associated with the chosen UDAs.
When upgrading from a previous version of Schematic Model Manager you should re-run
this activity with the new version. This is to ensure that your schematic database contains
any new UDAs required by Schematic Model Manager.
2.2
Mapping Set-Up
Schematic Model Manager includes a default set of GTYPE and attribute mappings. These
are 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.
2:1
12.0
2.2.1
GTYPE Mapping
The default GTYPE mappings map a commonly used set of ISO 15926 classifications to
their corresponding GTYPE and SCSTYPE in the AVEVA P&ID schematic database.
The GTYPE mappings can be configured before importing any data, either manually or by
analysis of a set of source files, or may be configured after importing the data by analysing
the database(s). Once the mappings have been edited, any data in the schematic
databases may have the mappings reapplied in order to update their attribution. Please see
Viewing/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 the
default attribute mappings whether or nor GTYPE mappings have been configured.
GTYPEs and SCSTYPE attributes set by the attribute mappings or derivation rules will
override the GTYPE mappings.
2.2.2
Attribute Mapping
Attribute mappings should be configured before loading data as any subsequent changes to
the mappings will mean that previously imported data must be re-imported in order for the
new mappings to be applied to it. Attribute mappings are crucial to the page matching
process 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 should
already be populated, but system-specific attributes stored within the GenericAttributes
elements 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.0
format of the ISO 15926 schema. It is not relevant if data is imported from version
3.3.3 files or later.
The source data may use system-specific attributes in order to specify how segments are
connected across diagrams. If the source data has been generated using AVEVA P&ID and
the Schematic Model Manager default attribute mappings relating to the SCOPCI and
SCOPCO schematic database elements have not been amended, then no additional crosspage connectivity related attribute mappings will be required. Pre-configured Attribute
mappings for matching page connections are provided with the application.
However, if the source data was generated from an alternative gateway or tool, cross-page
connectivity attribute mapping may need to be configured in order to ensure that cross-page
connectivity is maintained. To do this:
1. Find the values of the AttributeName attributes on the CrossPageConnection XML
elements in the source data file.
2. Open the source data file in a tool capable of displaying XML files (the contents of the
source file will not need to be edited). Find the values of the AttributeName attributes
on the CrossPageConnection XML elements.
The following example shows the CrossPageConnection element in a data source
generated by AVEVA P&ID:
2:2
12.0
6. The correct source data attribute must now be mapped to the UDA :Pmgdfltmatch, to
ensure that page matching occurs.
2:3
12.0
To do this, click the ellipsis button to the right of the attribute mapping's Source Attribute
field. This will open the XPath expression builder:
7. Navigate to the attribute used in the source data file to store cross-page connectivity
matching values.
The source data attribute PipeId is used in the AVEVA Schematic Model Manager
Gateway. The example above shows this source attribute and its associated mapping
in the Source Dictionary window of the Schematic Model Manager XPath Expression
Builder.
8. A mapping from this source data file attribute to the UDA :Pmgdfltmatch has now been
created.
If cross page connectivity in the source data files is represented using more than one
attribute, then it will be necessary to create additional UDAs against the SCOPCI and
SCOPCO schematic database elements, and to then create additional attribute
mappings 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, then
consult Attribute Mapping.
2:4
12.0
2.3
2:5
12.0
2:6
12.0
3:1
12.0
3:2
12.0
3.1
3.1.1
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 to
the beginning of release comments.
Existing elements (i.e. elements imported before) that have been released
3:3
12.0
Abort Diagram Import - If this option is selected, no elements will be imported from
diagrams that include released elements. The release status of previously imported
elements is retained. Default setting.
Import and set release status to OFF - The elements are imported and their release
status changed to not released.
Import and keep existing status (ON) - The elements are imported and their release
status retained, i.e. set to released.
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
3:4
12.0
3.1.2
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.2
General Tab
3:5
12.0
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.
Note: Copying settings from another project, importing setting from files, and resetting to
the 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 the
Project Options dialog.
3.2.1
The dialog lists all of the projects on the current PDMS installation for which Schematic
Model Manager options have been saved.
Press the OK button. The options are then copied from the selected project. A message is
displayed when the copy is complete.
3:6
12.0
3.2.2
The options specified for the current project are then exported to that location into a file with
the default name of <Project>_Options.zip. A message is displayed when the export
is complete.
3.2.3
3.2.4
3:7
12.0
3.3
3.3.1
set default SCGROUP database elements to import diagrams, off-line instruments, offline equipment and pipelines into
3:8
12.0
If neither of these methods is used, the elements are instead placed in default groups, which
are automatically created in the database as part of the import process (if they do not
already exist).
The names of the default groups are in the following format:
To view or edit the groups into which diagrams, off-line equipment, equipment and pipelines
are imported into, press the View/Edit button on the Import Configuration tab. The Import
Destination Groups dialog is then displayed.
The Database field displays the name of the current Schematic database. To view/change
the import destination groups of another database, select it from the drop-down list. The list
consists of every Schematic database in the MDB.
The grid beneath the Database field lists the four element types and the names of the
groups into which they are imported.
3:9
12.0
To select a different group for an element type, select the ... button at the end of the row.
The Select Group dialog is then displayed:
Browse for the required group and select the OK button. Press the Cancel button to close
the 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 changes
that have been made. Press the Cancel button to close the dialog without saving changes.
3.3.2
3:10
12.0
For details of the format in which the coordinates must be entered, refer to PDMS or Marine
documentation.
3.3.3
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 in
Pounds. 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 converted
into. For example, the tab can be used to specify that all weight attributes values are to be
converted into Kilograms and all Volume attribute values are to be converted into Cubic
Metres.
In the Angle, Area, Pressure, Temperature, Volume and Weight fields, select the unit of
measure to be applied to values measured in these unit types.
Note that the value in the Distance field cannot be changed because all distances are
measured in millimetres in the database.
3:11
12.0
Angle
Degrees
Area
Square Metres
Distance
Millimetres
Pressure
Bar
Temperature
Degree Celsius
Volume
Cubic Metres
Weight
Kilogram
Changing the unit of measure for a unit type will not update the units of measure for
instances of this unit type that have already been imported. Previously imported data must
be re-imported for the change to take effect.
The Schematic Model Manager default UDAs include attributes on the SCDIAG elements
that store the units of measure used when a diagram is loaded. To determine the units for an
attribute value determine which diagram the element was last loaded from and view the
appropriate :Pmgunts attribute for the diagram.
3:12
12.0
4:1
12.0
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 Options
If the Import Progress dialog (see Import Progress Dialog) is to be closed automatically
when an import is complete, ensure that the Close Import Progress screen on import
completion checkbox is checked. The default setting is unchecked.
4.2
File Locations
4.2.1
4:2
12.0
To change the default folder, select the Data Import row, and press the Modify button. The
Browse for Folder dialog is then displayed.
Browse for the required folder and press the OK button. The new location is then displayed
in the Default Location field.
4.2.2
4:3
12.0
4:4
12.0
5:1
12.0
5:2
12.0
Rules are grouped into rule groups. Rule groups may contain both rules and other rule
groups. The left-hand pane of the dialog displays all existing rules and rules groups. All rules
and groups are grouped under a node called Attribute Processing Rules.
The currently selected element is displayed in bold. Details of the currently selected element
are 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. Press
the Cancel button to close the dialog without saving changes.
5:3
12.0
5.1
If the Attribute Processing Rules checkbox is unchecked, all rules and rule groups are
unselected, 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
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 Processing
Rules node was selected.
5:4
12.0
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:
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 of
rule group or a rule, and select either Create > Rule or Insert > Rule from the menu
that 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 Rules
node was selected.
The new rule is created and given the default new rule name (New Rule):
5:5
12.0
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 derived
from the properties of the rule will be assigned to the rule when it is created. The name
entered here will suffix this identifier (see below for details).
4. If the new rule is to be processed, select True from the Enabled field. Otherwise
select False. The state of the checkbox against the rule in the left-hand pane will
change to reflect the setting made here, and vice versa.
5. The number of attribute filters set up for the rule displayed in the Attribute filters field.
To add an attribute filter, click on the ... button at the end of the Attribute filters field.
The Attribute Filters dialog is then displayed.
5:6
12.0
i.
Enter a valid attribute in the displayed Attribute field, or select a attribute from the
drop 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 by
spaces) for the specified attribute value. These can be numeric or non-numeric,
depending on the type of the attribute. For example, Attribute=AREA, Operator="In
the List", Value="0 1 3", would find items which have AREA attribute equal to either
0 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 Add Filter 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 Attribute field. The list
consists of the attributes shared by the selected Element Types, i.e. only attributes
which 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. Otherwise
leave this set to False.
The name attribute value of an element must be unique in the database. Due to the
application of a rule, the name of an element may be set to a value that is already in
use. This is called a "name clash".
5:7
12.0
Name Clash Rules are set up to prevent this. If a name clash is detected during an
import, 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 or
more elements, there should be a corresponding Name Clash Rule, which Schematic
Model Manager can apply to the Name attribute value of the same elements in the
event of a name clash.
8. If the application of a Name Clash Rule still results in a clash, or if there is no Name
Clash 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 enter
this expression, select the ... button at the end of the DB Expression field. The Edit
DB Expression dialog is then displayed.
5:8
12.0
10. To select an element type or types to which the rule is to be applied, select the ... button
at the end of the Element Types field. The Select Values dialog is then displayed.
11. The Select Values dialog consists of two lists. The Available Values list lists the
Element Types which are available for selection. The Selected Values list lists the
Element Types that have been selected.
To select an Element Type, select it in the Available Values list and press the > button
to 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 transfer it back to the Available Values list.
Use the >> button to move all Element Types to the Selected Values list. Use the <<
button to move all Element Types to the Available Values list.
Elements may also be selected/deselected by double clicking.
Press the OK button once the required Element Types have been selected. The
selected Element Types are then displayed in the Element Types field of the Rule
Attribute dialog.
Press the Cancel button to close the dialog without saving any selections that have
been made.
5.3.2
Rule Names
Names of rules are in the following format:
5:9
12.0
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-hand
pane and proceed as described above to edit them.
5.4
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
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.
5:10
12.0
6:1
12.0
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 the
current attribute mapping groups and the attribute mappings they contain, and is used to
create, move and delete mappings and groups.
The right-hand section displays the properties of the attribute mapping or mapping group
selected 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. To
close the dialog without saving changes, press the Cancel button.
Note: Changes made in the LEXICON module are not committed to the database until a
Save Work takes place.
6.1
Tree View
The 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. Attribute
mapping groups are represented by folder icons. Attribute mappings are represented by
book icons.
In older versions of Schematic Model Manager, attribute mappings were not organised into
groups. Any mappings created using these older versions of Schematic Model Manager are
automatically grouped into an attribute mapping group called Default Mappings when
Schematic Model Manager is upgraded.
Attribute mapping group nodes can be opened and closed using the + and - symbols.
6:2
12.0
6.2
6:3
12.0
6.3
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 mappings
within the currently selected node.
If the Insert option is selected, the new attribute group is instead created directly above the
node that was selected when the option was selected. The Insert option is not available
from the top-level Attribute Mappings node.
The right-hand section of the dialog displays the properties of the new group.
6:4
12.0
To select the SCTYPEs, press the ... button at the end of the field. The Select Values
dialog is then displayed.
3. The Select Values dialog consists of two lists. The Available Values list lists the
SCTYPEs which are available for selection. The Selected Values list lists the
SCTYPEs that have been selected.
To select an SCTYPE, select it in the Available Values list and press the > button to
transfer it to the Selected Values list.
To de-select an SCTYPE, select it in the Selected Values list and press the < button to
transfer it back to the Available Values list.
Use the >> button to move all SCTYPEs to the Selected Values list. Use the << button
to move all SCTYPEs to the Available Values list.
Press the OK button once the required SCTYPEs have been selected. The selected
SCTYPEs are then displayed in the Element Types field.
Press the Cancel button to close the dialog without saving any selections that have
been made.
4. Whether or not the attribute mappings in the group are applied can be made
conditional. To enter the conditions, 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, indicating
that the mapping cannot be applied. If a valid expression is entered, True is
displayed.
True is also displayed if no conditions are entered. If no conditions are entered,
mappings are applied by default.
5. In the Source System field, select which source system the mappings in the group are
to be applicable to. The mappings in the group will only be applied to data imported
from this system. The default entry is blank, meaning all systems.
Note: The list of source systems can be added to by processing data files using the Source
Dictionary Management interface.
6. In the File Format field, select the import source file format associated with the source
file attributes in the group from the drop-down list. The default entry is blank, meaning
all formats.
6:5
12.0
7. The File Format Version field displays the versions of the source file format
associated 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 Values
dialog is then displayed.
6.4
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 mappings
within the current node.
If the Insert option is selected, the new attribute mapping is instead created directly above
the node that was selected when the option was selected.
6:6
12.0
The right-hand section of the dialog displays the default properties of the new mapping.
4. Whether or not an attribute mapping is applied can be made conditional. To enter the
conditions, 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, indicating
that the mapping cannot be applied. If a valid expression is entered, True is
displayed.
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 been
setup for both the group and the mapping, both sets of conditions must be satisfied if
the mapping is to be applied.
6:7
12.0
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 Expression
using the XPath Expression Builder dialog. See XPath Expression Builder Dialog for
details.
6. In the Attribute Units 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 Expression
using the XPath Expression Builder dialog. See XPath Expression Builder Dialog for
details.
This field may be automatically completed if the XPath Expression Builder dialog is
used 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, cubic
metres) 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, integer
etc. The default entry is string.
This field may be automatically completed if the XPath Expression Builder dialog is
used 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 source
file 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 format
associated 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 dialog
is then displayed.
6:8
12.0
6.5
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
Building Expressions
Expressions are constructed using the Build tab. The Build tab consists of three sections.
The Source Dictionary pane section, the Shortcuts, XPath Operators and XPath Functions
tabs section and the Expression pane section.
An XPath expression may be constructed manually, by typing directly into the Expression
area of the dialog. In addition, source file attributes for inclusion in the expression may be
selected from the Source dictionary, by navigating to the required element in the source
dictionary tree view and double clicking on the required attribute. This attribute will then be
added to the expression.
Additional elements for constructing an XPath expression are provided on the Shortcuts,
XPath Operators and XPath Functions tabs.
6:9
12.0
Once the required expression has been constructed, select the OK button to close the
dialog. The expression is then displayed in the relevant field in the main Attribute
Mappings dialog.
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 Data
Dictionary information for the current attribute mapping or attribute mapping group.
The database element types are all listed against the top node of the tree view. This node
can be expanded to display the import file standards, for example XMpLant, of the imported
data.
Each import file standard node can be expanded to list the attributes which are common to
all of the selected database element types and that are of that import file standard.
If the required attributes are not displayed, or no attributes are displayed, the dictionary
must be populated by extracting attribute data from diagram import files. See Accessing the
Source Data Dictionary.
Each of the attribute nodes can be expanded to display the following nodes, which display
attribute metadata.
6:10
12.0
Src - XPath to the source of the attribute. This is the text that will be added to the
expression if the attribute is added to it.
SrcUnits - XPath to the units of the attribute (if applicable).
Type - Storage type for the attribute (e.g. string, integer).
Has Content - Yes/No, indicates whether or not the attribute has been observed with
content at any time.
Min Cardinality - Displays the minimum observed cardinality of the attribute.
Max Cardinality - Displays the maximum observed cardinality of the attribute.
Of the above, Src and SrcUnits can be added to an expression. The other data is presented
for information only.
To add an attribute or attribute data to an expression, either drag and drop the data item
from the Source Dictionary pane into the Expression pane, or double-click on the data item.
If dragged and dropped, the data item is added to the expression where it is dropped. If
double-clicked the data item is added to the expression at the point that the cursor is
currently located in the Expression pane.
The XPath Operators tab lists XPath expression operators, for use in constructing XPath
expression operations.
6:11
12.0
The XPath Functions tab lists XPath expression functions, for use in constructing XPath
expression operations.
To add an operation, operator, or function to an expression, either drag and drop it from the
tab into the Expression pane, or double-click on it.
If dragged and dropped, the item is added to the expression where it is dropped.
6:12
12.0
If double-clicked, operators are added to the expression at the point that the cursor is
currently located in the Expression pane.
If double-clicked, operations and functions are placed at the start of the expression, and the
expression is automatically enclosed in parenthesis following the item. If the Expression
pane is empty, the item is placed followed by empty parenthesis.
Expression Pane
As described above, items selected in the upper sections are copied into the Expression
pane. Multiple attributes, operations, etc can be selected to construct complex expressions.
XPath expressions, or parts of expressions, may also be typed directly into the pane.
Standard Cut, Copy and Paste text editing options are available on a right-click menu. The
right-click menu also includes a Clear Text option, which will clear the Expression pane.
The Status: symbol indicates the validity of the expression. A white question mark within a
blue circle indicates that the expression has not yet been validated. See Setting up
Mappings Using the XPath Expression Builder Dialog - Examples for details.
6.5.2
6:13
12.0
1. Using the Attribute Mappings dialog, create a new mapping and name it
appropriately.
The XPath Expression Builder dialog is then displayed, with the SCDIAGRAM
element listed in the Source Dictionary pane.
6:14
12.0
4. Between the first parenthesis and the comma in the concat operator, enter the URL of
the drawing location (excluding the file name) in double quotes.
6:15
12.0
5. Place the cursor after the comma and then double-click on the Name attribute of the
SCDIAGRAM element. The Name attribute is then placed into the expression.
6. After the second comma (which is added when the Name attribute is selected), enter
the file extension of the source drawing.
7. The expression is now complete. Select the OK button the save it and close the dialog.
The expression is displayed in the Source Attribute field of the main Attribute
Mappings dialog.
8. When SCDIAGRAM elements are imported into the database, their URL attributes are
automatically populated using the XPath expression.
6:16
12.0
6:17
12.0
1. Using the Attribute Mappings dialog, create a new mapping and name it
appropriately.
The XPath Expression Builder dialog is then displayed, with the SCEQUIPMENT
element listed in the Source Dictionary pane.
6:18
12.0
4. Place the cursor in the Expression pane in front of the Tag attribute:
6:19
12.0
The substring function is then added to the expression, with the Tag attribute as its
subject.
5. After the first comma, enter the start position of the substring within the string (i.e.
within the Tag attribute), in this case 1. After the second comma, enter the length of the
substring, in this case also 1. This will result in the first character only of the Tag
attribute of equipment being selected.
6. The expression is now complete. Select the OK button the save it and close the dialog.
The expression is displayed in the Source Attribute field of the main Attribute
Mappings dialog.
7. From the Attribute Type field select dbelement, which indicates that the mapping will
generate new elements.
6:20
12.0
8. When an equipment element is imported, the mapping will refer to the name (Tag
attribute) of the equipment. It will take the first character of the equipment and create a
new group (if necessary), using that character as the groups name, and will set the
Owner attribute of the equipment as that group.
6.5.3
The XPath Expression Builder dialog was opened from the Source Attribute field.
6:21
12.0
The existing unit value in the Source Attribute Unit field is different from the default
value (or this field is blank).
If the Yes button is pressed, the user may also be asked if the attribute type should be
automatically set.
If the Yes button is pressed, both the Source Attribute Unit field and Attribute Type field
are automatically completed with the unit and attribute types of the selected attribute,
derived from the Source Data Dictionary.
6.5.4
Testing Expressions
Expressions are tested using the Preview tab.
The tab is used to test whether is an XPath expression is valid and returns data which
conforms to the schematic element attribute type that the mapping would be applied to.
The tab is also used to preview the results that would be generated in the database for the
elements that an expression would be applied to in a selected drawing, so that it can be
checked that the expected result of applying the expression would be achieved.
6:22
12.0
A green tick indicates that the expression has been checked and is valid. A red cross
indicates that the expression has been checked and is not valid.
A white question mark within a blue circle indicates that the expression has not yet
been validated. If the expression is changed after it has been validated, the Status:
symbol reverts to this symbol.
5. For each of the elements that the expression would be applied to were the selected
diagram to be imported, the source element type is displayed in the TYPE column, the
tag of the element in the drawing is displayed in the Tag field, and the attribute value
would result from the application of the expression is displayed in the Result field.
6:23
12.0
6.5.5
6.6
6.6.1
6.6.2
6:24
12.0
6.6.3
6:25
12.0
6:26
12.0
7:1
12.0
Note: Note that not all schematic items have equivalents in the 3D database. Such items
do not need to have mappings set up against their ISO15926 designations.
The grid displays any mappings that have already been set up. A limited set of default
mappings are supplied with Schematic Model Manager.
To add a new mapping, click on the blank row at the bottom of the grid enter the designation
of the schematic item type in the ISO 15926 Designation field.
7:2
12.0
Note: Lists of designations can be imported into these fields from a file, or from data
previously loaded into the current mdb (see below).
Complete the mapping by selecting a GTYPE, and if applicable, entering an SCSTYPE.
Note that mappings can be automatically completed in accordance with user-defined rules
(see below).
To delete existing mappings, select the rows containing the mappings and press the Delete
Selected Row(s) button.
To delete all mappings, press the Delete All button.
To close the dialog and save any changes, press the OK button.
To close the dialog without saving changes, press the Cancel button.
7.1
Browse for the XML file that contains the designations. Once the file is selected, press the
Open button. This button will not be active until an XML file has been selected.
7:3
12.0
7.1.1
Conflict Resolution
If the selected file does not contain any valid designations, an error message is displayed.
Otherwise, the Conflict resolution message is displayed:
The selected file may include GTYPE and STYPE mappings that conflict with those already
set up in the ISO15926 Mapping dialog.
Conflicts may also exist within the import file, i.e. the file may include multiple instances of
the same designator mapped to different GTYPEs or STYPEs.
If such conflicts are detected, the following rules are applied to resolve them:
GTYPES
If a GTYPE conflict is detected, the following dialog is displayed during the import for each
conflict:
Select the preferred GTYPE to map to the designator from the list and press OK.
If the Yes button was selected on the Conflict resolution message, the list will include the
GTYPE currently mapped to the designator in the ISO15926 Mapping dialog. If the No
button was selected, this GTYPE will not be included.
STYPES
If conflicting STYPE values are found then the assumption is made that no valid choice can
be made between them, either by the software or by the user, and a blank STYPE will be
saved, overwriting any existing mappings.
A summary of the rules for conflict resolution is displayed by pressing the Help button.
7:4
12.0
7.1.2
If a designator in the import file is mapped to an STYPE value but not a GTYPE value then
the designator will be treated as if it has an invalid GTYPE and not imported.
When the import is completed successfully, the following message is displayed:
The designations in the file are then copied into the ISO 15926 Designation fields.
The GTYPE and SCSTYPE fields are completed with the GTYPEs and STYPEs mapped to
the designations in the imported files.
7:5
12.0
7.2
To set up a rule:
1. In the Rule field enter a Regular Expression that is used to select which designators
are to be mapped using the rule.
For example, if the rule is to map Control Valves, enter CONTROL VALVE. If the rule is
to be used to map different sorts of valve, enter VALVE. All designators containing
"VALVE" would be mapped using this rule.
For guidance on using Regular Expressions see 20.1: Appendix A: Regular
Expressions.
2. In the GTYPE field, select the GTYPE that designators selected by the rule expression
are to be mapped to.
7:6
12.0
3. In the SCSTYPE field, if required, enter the SCSTYPE that designators are to be
mapped to.
4. The order in which rules are listed is the order in which they are processed.
To change the position of a rule in the list of rules, select the row containing the rule and
press the up or down arrow button as required.
Once a rule has been applied to an ISO15926 designator, the mapping it applies
cannot be overwritten during that process by another rule.
If the Overwrite existing values checkbox is checked, existing mappings are overwritten
when rules are applied. If the checkbox is unchecked, existing mappings, either entered by
the user or set by a previous Auto Complete process, are not overwritten.
To delete existing rules, select the rows containing the rules and press the Delete Selected
Row(s) button.
To delete all rules, press the Delete All button.
To close the dialog and save any changes, press the OK button.
To close the dialog without saving changes, press the Cancel button.
7.3
7.3.1
Example
The list of designators is as displayed below:
7:7
12.0
7:8
12.0
7.4
The dialog lists all the Schematic databases in the Master database (MDB).
To select the database(s) to import designations from, check the appropriate Apply
checkboxes.
Once the required selections have been made, press the OK button. The import then takes
place.
Press the Cancel button to close the dialog without proceeding with the import.
The designations in the selected databases are then copied into the ISO 15926
Designation fields. Note that designations already listed in these fields are not imported,
and therefore existing mappings will not be overwritten.
7:9
12.0
7.5
The dialog lists all the Schematic databases on the MDB. Select the required databases as
described above, and press the OK button.
7:10
12.0
On creation of a project, for the purposes of configuring the attribute mappings, prior to
the import of diagram files.
After editing the GTYPE mappings or attribute mappings in such a way that the element
types created in the database are affected.
On configuring attribute mappings for data from a new source system or file format.
8:1
12.0
8.1
Alternatively, press the Manage Source Dictionary button on the XPath Expression
Builder dialog (see Accessing the Source Data Dictionary).
The Source Dictionary Management dialog is then displayed.
8:2
12.0
8.2
8.3
8:3
12.0
The following dialog is then displayed while the selected files are processed and information
about the elements and their attributes is added to the dictionary.
8:4
12.0
9:1
12.0
The dialog consists of three sections. The left-hand section displays a tree-view of the
configuration rule groups and the rules they contain, and is used to create and delete rules.
The rule nodes are LLENTRY, LLFROM/LLTO and LLDIAGRAMS. LLENTRY, LLFROM,
LLTO and LLDIAGRAMS are pseudo attributes of the SCPLINE and SCBRANCH elements
that are used to configure line lists.
The rule groups and the top level Line List Configuration node are fixed and cannot be
deleted or added to.
The Rule Properties section is used to define and display the properties of whichever rule or
group is currently selected in the tree view. The Rule Filters section is used to create filter to
apply the currently selected rule.
Note that a number of default rules are supplied with the application. These are described
briefly below.
To close the dialog and save changes made to line list configuration, press the OK button.
To close the dialog without saving changes, press the Cancel button.
9:2
12.0
9.1
The new rule is listed beneath any existing rules in the folder.
Note: The order that rules are listed in a folder is important as this is the order in which they
are assessed against the data when a line list in generated. During this process, data
is tested to see if it matches the criteria for having rules applied to it. Once a rule from
a folder is applied, the rules lower down the list in that folder will not be applied.
The order of rules within a folder may be changed by dragging and dropping.
To delete a rule, right-click on a rule and select the Delete option from the menu.
9.1.1
9:3
12.0
9.1.2
PML expressions are automatically validated on entry. If a PML expression is valid (or if the
field is blank), a green tick is displayed at the beginning of the PML expression entry field. If
a PML expression is invalid, a red tick is displayed.
If a rule contains an invalid PML expression, the rule will not be applied.
9.2
LLENTRY Configuration
Under the LLENTRY node in the tree-view, there are three further rule group nodes:
SCPLINE Rules, SCBRANCH Rules and Component Rules:
In the SCPLINE Rules group, rules are set up to specify which SCPLINEs are to be
excluded from line lists.
In the SCBRANCH Rules group, rules are set up to specify which SCBRANCHs are to
be excluded from line lists.
In the Component Rules group, rules are set up to specify which end components for a
SCBRANCHs are to result in SCBRANCHs with those end components (e.g. drains
and end caps) being excluded from line lists.
9:4
12.0
9.2.1
9:5
12.0
9.2.2
9.2.3
Any - rule applies to all SCBRANCHs regardless of whether the HREF or TREF
attributes of those SCBRANCHs has been set.
Valid HREF/TREF - rule only applies to SCBRANCHs with the HTEF or TREF
attributes set.
HREF/TREF unset - rule only applies to SCBRANCHs with the HTEF or TREF
attribute not set.
The HREF and TREF attributes define the start and end components of an SCBRANCH.
In the Item Types field, select which category of component, i.e. the SCTYPEs, to which the
rule applies. For example, SCFITTING.
9:6
12.0
To select the SCTYPEs, press the ... button at the end of the field. The Select Values dialog
is then displayed. For details of this dialog, refer to Creating Attribute Mapping Groups.
The selected SCTYPEs are listed below the Item Types field.
Enter the name of the rule in the Name field.
In the Attribute Filters section, specify which end component attributes are to result in a
SCBRANCH being excluded.
For example, if SCBRANCHs that have end caps as their end component are to be
excluded, the following rule could be set up:
9.3
LLFROM/LLTO Configuration
Under the LLFROM/TO node in the tree-view, there are three further rule group nodes:
SCPLINE Rules, SCBRANCH Rules and Component Rules:
In the SCPLINE Rules group, rules are set up to specify which text is to be used to
identify the From and To values of SCPLINEs in line lists.
In the SCBRANCH Rules group, rules are set up to specify which text is to be used to
identify the From and To values of SCBRANCHs in line lists.
Note that SCBRANCH Rules are only applied to SCBRANCHs with no components, or
if there are no Component Rules.
In the Component Rules group, rules are set up to derive the text is to be used to
identify the From and To values of SCBRANCHs from the attributes of the first/last
components on branches.
The from/to text for SCBRANCH elements may also be included in the SCPLINE attribute
values.
9:7
12.0
9.3.1
LFROM
LLTO
Supplied Rule
The ALL SCPLINEs rule (see the example above) is supplied with the product. It calculates
the LLFROM and LLTO attributes for all SCPLINEs using SCBRANCH attributes.
9:8
12.0
9.3.2
LFROM
LLTO
9.3.3
LFROM
LLTO
9:9
12.0
In the End Condition field, select which end conditions the rule will apply to (i.e. the rule will
only apply to SCBRANCHs with the selected end condition). Select from the following:
Any - rule applies to all SCBRANCHs regardless of whether the HREF or TREF
attributes of those SCBRANCHs has been set.
Valid HREF/TREF - rule only applies to SCBRANCHs with the HTEF or TREF
attributes set.
HREF/TREF unset - rule only applies to SCBRANCHs with the HTEF or TREF
attribute not set.
The HREF and TREF attributes define the start and end components of an SCBRANCH.
In the Item Types field, select which category of component, i.e. the SCTYPEs, to which the
rule applies. For example, SCFITTING.
To select the SCTYPEs, press the ... button at the end of the field. The Select Values dialog
is then displayed. For details of this dialog, refer to Creating Attribute Mapping Groups.
The selected SCTYPEs are listed below the Item Types field.
Enter the name of the rule in the Name field.
In the PML Expression field, enter a PML expression which will generate the SCBRANCH
From/To text.
This expression is applied either to the branch or the end component, as specified in the
PML Expression Object field. Select either SCBRANCH or EndComponent.
If the rule is only to be applied to SCBRANCHs with specific attribute values, a filter can be
set up in the Rule Filters section.
9:10
12.0
Supplied Rules
The following rules are supplied with the product:
Unset HREF/TREF Components: If a branch is unconnected and ends on a
component, then the DESC attribute is output as the LLFROM or LLTO attribute (see
example above).
Unset HREF/TREF SCTUBING: If a branch ends with an SCTUB, then the text 'Open
Pipe' is output for the LLFROM or LLTO attribute.
HREF/TREF Components: If a branch terminates at a component of another
SCPLINE, then the name of the SCPLINE is provided as the LLFROM or LLTO
attribute value.
SCNOZZLEs: the name of the owning equipment is output with the nozzle name in
brackets.
Equipment: the name of the Equipment is output with its DESC attribute in brackets.
Offline Instruments: The name of the instrument is output with the DESC attribute in
brackets.
9.4
LLDIAGRAMS Configuration
Rules are set up to define how diagram names are presented in line lists under the
LLDIAGRAMS node.
The character that separates multiple diagram names in line lists in specified by selecting
the LLDIAGRAMS node itself. Enter the required character in the Separators field in the
Rule Properties section.
9:11
12.0
9.4.1
Supplied Rule
The All diagrams rule (see the example above) is supplied with the product. It calculates the
LLDIAGRAMS attributes for all SCDIAGs using the NAME attribute.
9:12
12.0
10
10.1
10:1
12.0
Browse for and select the XML file or files of the diagrams to be previewed (each file
contains data for a single P&ID), and press the Open button. The default location is
specified on the User Options dialog (see File Locations).
If all of the selected files are invalid, an error message is displayed, listing the invalid files.
No diagrams are displayed.
If some of the selected files are invalid, a warning message is displayed, listing the invalid
files. The message gives the user the option of continuing or cancelling. If the user chooses
to continue with the procedure, only diagrams associated with valid files are displayed.
Note: Once the Diagram Viewer is opened, if a diagram was opened recently, it can be
opened from the list of recently opened diagrams which can be accessed by
selecting the arrow to the right of the View Diagram button on the Diagram Viewer
toolbar:
10:2
12.0
10.2
The viewer displays the selected diagrams. Each diagram is displayed on a tab, labelled
with diagram file name.
Hover the mouse cursor over a tab to display the file name and location of the diagram file.
10:3
12.0
If multiple diagrams are being displayed, their tabs may not all fit in the viewer window. If this
is the case, next > and previous < buttons will be displayed in the right-hand corner of the
window to enable these tabs to be displayed.
The number of diagrams that may be opened at once, and whether the tabs are displayed at
the top or the bottom of the window is specified using the Settings dialog. See Diagram
Viewer Settings.
To close a diagram, right-click on the diagram or on the diagram tab, and select the Close
Diagram option from the menu that is then displayed.
10.2.1
10:4
12.0
Previous Bookmark - sets the view to the bookmark that was set before the
current bookmark
Next Bookmark - sets the view to the bookmark that was set after the current
bookmark
Delete Bookmark - deletes the current bookmark
Clear All Bookmarks - deletes all bookmarks
Settings - opens the Settings dialog for the Diagram Viewer. See Diagram Viewer
Settings.
If the cursor is hovered over this button, a tooltip displaying information on keyboard
commands is displayed. See below.
Note: Bookmarks are not saved when the Diagram Viewer is closed.
10.2.2
Keyboard Commands
Useful keyboard commands include:
10.2.3
To zoom into an area of a diagram, hold down the Ctrl key and left-click on one corner
of the area and then drag the cursor to the opposite corner of the area.
To pan, hold down Alt and the left mouse button and drag the cursor in the required
direction.
10:5
12.0
10.2.4
The Highlighting options are used to specify the colour used to highlight elements
when they are selected and when the mouse is hovered over them. These options are
only applicable to imported diagrams.
The default colours are bright red and orange respectively, as displayed in the example
above. To pick a different colour, double-click on the appropriate coloured area to open
a colour selection dialog.
The Tabs Layout option is used to specify whether the tabs on which the names of
open diagrams are displayed are at the top or the bottom of Diagram Viewer window.
The Maximum size of Recent Diagrams list setting is used to specify the maximum
number of diagrams that the list of recently opened diagrams can consist of. The list is
accessed from the arrow on the right-hand side of the View Diagram toolbar button.
The Maximum number of Diagram Page tabs setting is used to specify the maximum
number of diagram tabs that can be open at once in the Diagram Viewer, in other words
the number of diagrams that can be open at the same time.
If the Set CE from diagram checkbox is checked, when an element is selected in the
Diagram Viewer, that element is set as the current element. This setting is only
applicable to imported diagrams.
10:6
12.0
11
Importing Diagrams
There are two import facilities available in the Schematic Model Manager module, the
Import Diagrams facility (see Import Diagrams Facility) and the Import Diagram Set facility
(see Diagram Set Import Facility).
These two facilities are used to select the data to be imported. In the case of the Import
Diagram Set facility, these are predefined sets of diagrams, which once defined, can be
selected for import multiple times. In the case of the Import Diagrams facility, the diagram or
diagrams to be imported are selected at the time of import.
The import itself is then monitored using the Import Progress dialog (see Import Progress
Dialog).
Diagram data can also be imported using the facilities available by using PML (see
Importing using PML).
Whichever method is used, after data has been imported, it must be saved to the database
(see Saving Imported Data).
Note: Data can also be imported into the database from Excel and CSV files. This facility is
available from the Import > Excel/CSV... option on the File menu and from the
button on the SMM toolbar. Refer to the Plant DESIGN module or Marine Hull and
Outfitting module documentation for detailed information of this facility.
11:1
12.0
11.1
button from the SMM toolbar or the Import > Diagrams... option from
11:2
12.0
Browse for and select the XML file or files of the diagrams to import, and press the Open
button. The default import file location is specified on the User Options dialog (see Set
Default Import Location).
As part of the import procedure, depending on the settings specified on the Project Options
dialog (see Set Release Behaviour of Elements on Import), elements may be automatically
released.
If this is the case, comments may be entered regarding the change in release status and
recorded against each released element in the schematic database in the Release
Comments dialog, which is automatically displayed.
Enter the comments and press the OK button. If the Cancel button is pressed, no release
comments are entered. This does not cancel the import.
Whether or not this dialog is displayed is also specified on the Project Options dialog.
Data is may be released (or un-released) after the import if required. See Releasing and UnReleasing Data.
The Import Progress dialog is then displayed. See Import Progress Dialog.
11:3
12.0
11.2
11.2.1
11:4
12.0
This dialog used to create and edit Diagram Sets and initiate imports.
The title bar of the Diagram Set Editor will display the name of the current File Set, or New
Diagram Set if a new file set is in the process of being created. On entry, a new Diagram
Set is opened by default.
If an asterisk is displayed next to the title, this indicates that the current File Set has been
changed but not saved.
If the current Diagram Set has not been saved, you will be prompted to save it, and if
required assign it a file name and specify its location.
To construct a new Diagram Set, the diagram XML files that are to comprise the Diagram
Set must be selected.
To add a single file or multiple files to a new Diagram Set, select the Add Diagrams button:
11:5
12.0
Browse for and select the XML file or files of the diagrams to add to the Diagram Set, and
press the Open button. The default import file location is specified on the File Locations tab
of the User Options dialog (see Set Default Import Location).
The selected file or files is then displayed in the diagram list section of the Diagram Set
editor (see below for details of the diagram list section).
To add all the valid XML diagrams within a folder to the file set, select the Add All Files in a
Folder button:
11:6
12.0
A folder browser is then displayed. Browse for the required folder and press OK.
All XML files in the folder that are in the correct format, plus all files listed in Diagram Sets
that are in that folder, are then added to the diagram list.
Notes:
If an existing Diagram Set is selected or is in a selected folder, its files are added to the
current Diagram Set (its release comments are not included).
If a text file containing a list of files is selected or is in a selected folder to process, all
the files listed will be added to the Diagram Set.
If files cannot be added then the user is informed via a warning message, for example
if a file could not be found or is not valid.
The Add All Files options does not include any subfolders within the selected folder,
only files.
The diagram name attribute in the schematic database has a maximum length of 50
characters. Diagram names in the schematic database begin with a / character. If a
diagram name in an import file does not begin with a / character, then Schematic
Model Manager adds one to the beginning of the diagram name on import.
Diagram names in import files may therefore be no more than 50 characters, if the
diagram name begins with a / character, or no more than 49 characters if the diagram
name does not begin with a / character. If these lengths are exceeded then the file will
not be added to the file set. A message will be displayed to inform the user of this.
11:7
12.0
When all the required files have been selected, save the new Diagram Set by selecting the
Save Diagram Set button:
A save dialog is then displayed. Specify the name and location of the Diagram Set and
press Save.
If there is a Diagram Set already open with unsaved changes, you will be prompted to save
it, and if required assign it a file name and specify its location.
An Open dialog is then displayed. Select the required Diagram Set and press Open. The
contents of the selected Diagram Set are then displayed in the diagram list section of the
Diagram Set Editor.
11:8
12.0
When opening an existing Diagram Sets, the files it consists of are validated. The Diagram
Set Editor - Open Diagram Set Summary dialog is displayed.
Files which have been changed since the last time the set was changed, files which cannot
be located, and files which updated as a result of an import are listed separately.
Press the Dismiss button to close the dialog.
Changed files are displayed in orange text in the file list. Missing files are displayed in grey.
The selected files are then removed from the diagram list and the Diagram Set.
11:9
12.0
Save changes to the Diagram Set by using the Save Diagram Set button:
It displays details of both new diagrams, i.e. diagrams that are not present in the database,
and existing diagrams, i.e. diagrams that are already present in the database.
Multiple files can be selected in the list using standard Windows methods. By default, the list
is sorted in ascending order of diagram name. Click on a different column heading to sort by
that column instead.
The list section also includes a DB Match field. The DB Match fields display the diagram
name of the diagrams in the database that the listed diagrams will update when the import
takes place.
Where a diagram was placed in this grid by the system, the Matched DB Diagram Name
field will be the same as the entry in the Diagram name. A different diagram can be selected
if required (see below).
To select a diagram name, press the button at the end of the field.
11:10
12.0
11.2.2
Whether or not this field is enabled is also specified on the Project Options dialog.
11:11
12.0
11.2.3
11:12
12.0
Select the required Diagram Set and press the Open button.
As part of the import procedure, depending on the settings specified on the Project Options
dialog (see Set Release Behaviour of Elements on Import), elements may be automatically
released.
If this is the case, comments may be entered regarding the change in release status and
recorded against each released element in the schematic database in the Release
Comments dialog, which is automatically displayed.
Enter the comments and press the OK button. If the Cancel button is pressed, no release
comments are entered. This does not cancel the import.
Whether or not this dialog is displayed is also specified on the Project Options dialog.
The Import Progress dialog is then displayed. See Import Progress Dialog.
11.2.4
11:13
12.0
11.3
the number of diagrams already processed out of the total number to be processed,
If the dialog is to be closed automatically when the import is complete, check the Close on
import completion checkbox. The default settings of this checkbox is specified on the
Import Settings tab on the Project Options dialog (see Units Tab).
To close the dialog once the import is finished, press the Dismiss button.
11.3.1
11:14
12.0
The Errors tab lists details of import errors as they are detected.
Note: After data has been imported it must be saved to the database. See Saving Imported
Data.
11:15
12.0
11.3.2
They must be of different types, i.e. one must be a SCOPCO (connector out) and the
other must be a SCOPCI (connector in).
The data for each OPC includes a reference to a diagram that the other end of the
connection (the other OPC) is located on. This is known as the Match Diagram.
The Match Diagram of one OPC must be the diagram on which the other OPC is
located, and vice versa.
The data for each OPC includes a reference to a Match Attribute. This is a reference to
an attribute of the other end of the connection. Each end of the connection must have
the same Match Attribute.
The data for each OPC includes a Match Attribute Value. The Match Attribute Value for
one end of the connection must be the value of that attribute at the other end of the
connection, and vice versa.
For example, the OPCs with the following data would be matched automatically (assuming
the connection is unique):
11.4
SCOPCO on 905675
SCOPCI on 905677
Match Diagram
905677
905675
Match Attribute
PersistentId
PersistentId
0123456
6543210
PersistentId
6543210
0123456
11:16
12.0
11.4.1
Preliminaries
All imports are executed using an instance of the SMM PML object. A SMM PML object may
be created as in the following example:
!pid=object smm()
It is possible to see the methods available on this object by using the command:
Q methods !pid
The first time the command line is used to import P&IDs after installing Schematic Model
Manager the user may need to execute the 'PML REHASH ALL' command to update the
PML library index file. If this has not been done then the an error message will be displayed.
11.4.2
Importing Diagrams
There are three ways of importing diagrams using the Command Window.
Collectively, by specifying a folder containing diagram files - all valid diagrams in that
folder are imported.
Collectively, by specifying a File Set - all valid diagrams in that file set are imported.
For a description of what File Sets are and how they are created see 11.2: Diagram Set
Import Facility.
Note: Once diagrams have been imported, a Save Work must take place to save changes
to the database. See 11.5: Saving Imported Data.
!pid.ImportFilesInDir('Folder)
If release comments are required, enter (refer to Entering Release Comments):
!pid.ImportFilesInDir('Folder','Release Comment')
For example:
11:17
12.0
!pid.ImportFilesInDir('V:\SchematicModelManager\TestData\
','Update to Diagrams')
The files in the specified folder are then imported. The Command Window displays
progress, error and warning messages as the import is carried out.
If the specified folder is not found, an error message Directory doesnt exist will be
displayed.
If any of the files in the folder are invalid, an error message File type not
recognised will be displayed for each of them. The import procedure will then ignore the
invalid files.
!pid.ImportFromFileSet('Diagram Set)
For example:
!pid.ImportFromFileSet('V:\SchematicModelManager\
ImportFileSet.xml')
The files in the specified Diagram Set are then imported. The Command Window displays
progress, error and warning messages as the import is carried out.
!pid.logfile = !pid.logFile()
Q !logfile
C:\AVEVA\Plant\PDMS12.0.SP5\SchematicModelManager\Logs\
9fjvegnk.log
11.5
11:18
button from
12.0
To save changes to the database using the command line, enter 'save work' at the
command prompt.
11:19
12.0
11:20
12.0
12
Diagram Connector
Connections between Off-Page Connectors (OPCs) may be established automatically when
diagram data is imported (see Automatic Matching of Off-Page Connectors). The Diagram
Connector is used to edit existing connections, and to set connections between OPCs that
were not established on import.
The Diagram Connector is opened either by:
Or by selecting the
12:1
12.0
12.1
When then dialog is opened, if the Current Element (CE) is an off-page connector, the
Source OPC field is automatically completed with that connector. This is always the case
when the dialog is opened from the Schematic Explorer or from the Diagram Viewer.
If there is already a connection set up for that off-page connector, the connected off-page
connector is displayed in the Target OPC field. Otherwise, the field will be blank.
If the dialog was opened from the Schematic Model Manager menu and the CE was not an
off-page connector, both fields will be blank. The source connector must therefore be
selected.
Note: Source and Target is no indication of the type of off-page connector, i.e. Source
does not indicate that a connector is a SCOPCO (connector out) and Target does
not indicate that a connector is a SCOPCI (connector in).
In this context, the Source connector is the subject of this procedure, to which a
selected Target connector is connected.
12:2
12.0
12.1.1
Use Saved Searches (see Searching in Schematic Model Manager) to locate the
required off-page connector, right click on the search result and select the Navigate To
option from the menu that is then displayed.
Note: There are Schematic Model Manager saved searches that can be used for finding
connected, unconnected and manually connected OPCs.
Select the OPC on a diagram in the Diagram Viewer (see Diagram Connectors).
To select the required off-page connector from a list, press the ... button next to the Source
OPC field. The OPC Browser dialog is then displayed.
12:3
12.0
Once a connector is selected, the Source OPC field is populated with the name of the
selected connector. If there is an existing connection set up for this connector, the name of
the connected off-page connector is displayed in the Target OPC field.
12.1.2
Setting up a Connection
Once a source off-page connector has been selected, a connection can be established by
selecting a target off-page connector.
If a connection has already been established for the source off-page connector, it can be
edited (see Editing a Connection).
To select a target off-page connector, proceed as described above for selecting a source offpage connector, either by selecting the current element or choosing a connector from a list.
Target off-page connectors cannot be of the same type as the source off-page connector.
For example, if the source off-page connector is a SCOPCO, the target must be a SCOPCI.
The CE button is therefore only active if the correct type of off-page connector is selected in
the Schematic Explorer, and the list of connectors in the OPC Browser dialog only includes
connectors of this type.
The list only includes connectors that are not currently connected (as indicated by the red
cross in the first column).
To select a connector, either double-click on it, or click on it once and press the OK button.
Once a connector is selected, the Target OPC field is populated with the name of the
selected connector.
To connect the source and target OPCs, press the Connect button.
If a user attempts to match two connectors that are not part of the same SCPLINE, a
message will be displayed to warn that this could result in changes to the attributes of the
downstream SCPLINE.
Select the OK button to set up the connection anyway, or the Cancel button to abort the
operation.
12:4
12.0
Once a connection is saved the Target OPC field is greyed out, the adjacent buttons
disabled and the Connect button replaced by a Disconnect button.
12.1.3
Connection Details
Details of the source and target connections are displayed in fields in the main part of the
dialog, under the headings of Source OPC and Target OPC.
and
segment
These elements can be made the current element, i.e. they will be selected in the
Schematic Explorer, either by double-clicking on them, or right-clicking and selecting
Navigate to from the menu that is then displayed.
The Type fields displays the type of each connector, i.e. SCOPCO or SCOPCI.
12:5
12.0
The Match SCDIAG fields display the names of the diagrams that each connector connects
to.
The Match attribute fields display the names of the source data attribute used to match the
connectors to each other.
The Attribute match value fields display the values of the source data match attributes.
The bottom three fields indicate the quality of the match between the two connectors.
The SCDIAGs matched? field:
If Yes is displayed in both fields and a green tick is displayed in the left-hand column,
this indicates that both connectors refer to the diagram that the other is located on.
In other words, the Match SCDIAG of the source connector is the diagram that the
target connector is located on and vice versa.
If Yes is displayed in one field and No in the other, and an orange tick is displayed in
the left-hand column, this indicates that one of the connectors refers to the diagram that
the other is located on (the connector displaying Yes), but the other connector does
not.
In other words the Match SCDIAG of the source connector is the diagram that the
target connector is located on, but the Match SCDIAG of the target connector is not the
diagram that the source connector is located on, or vice versa.
If No is displayed in both fields and a red cross is displayed in the left-hand column,
this indicates that the Match SCDIAG field of neither connector refers to the diagram
that the other is located on.
If Yes is displayed in both fields and a green tick is displayed in the left-hand column,
this indicates that both connectors are on the same SCPLINE.
If No is displayed in both fields and a red cross is displayed in the left-hand column,
this indicates that the connectors are on different SCPLINEs.
If Yes is displayed in both fields and a green tick is displayed in the left-hand column,
this indicates that both connectors have match attributes that satisfy the attribute
connection criteria.
If Yes is displayed in one field and No in the other, and an orange tick is displayed in
the left-hand column, this indicates that one of the connections has a match attribute
that satisfies the connection criteria specified in the source data, but the other does not.
If No is displayed in both fields and a red cross is displayed in the left-hand column,
this indicates that neither connector has match attributes that satisfy the attribute
connection criteria.
12.1.4
Editing a Connection
To edit an existing connection, select the off-page connection at one end of the connection
in the Source OPC field as described above.
The Target OPC field is then populated with the off-page connection at the other end of the
connection. The field is greyed out and the adjacent buttons disabled.
Press the Disconnect button. The Target OPC field and adjacent buttons then become
active. Select another target off-page connection as described above.
12:6
12.0
13
Schematic Explorer
Once imported into the Schematic database, P&ID data can be viewed in a hierarchical data
Explorer.
The Explorer can also be used to release the data in the Schematic database to the AVEVA
Schematic 3D Integrator.
13.1
13:1
12.0
13.2
13:2
12.0
SCTEMP
SCSTEN
SCLOOP
SCILIN
(same as under SCPLIN - see above)
SCACTU
Note: Element Types in italics cannot be imported into the database using Schematic
Model Manager. However, they can be created using other methods such as the
Create menu options (see below), or the command line, so they may appear in
Explorer.
Schematic WORL *: The topmost level of the Schematic database hierarchy within which
all other elements exist. Cannot be moved, renamed or deleted.
STLNKW : Status Link World.
STLNKS : Groups of Status Links.
Note: STLNKS may contain other STLNKS, which in turn may contain STALNK elements
or more STLNKS.
STALNK : Status Link.
SCGROU: Administrative elements containing groups of elements.
By default, groups for Diagrams, Instruments, Equipment and Pipelines are created
automatically when these elements are imported into the database. Other groups are
created as required by users (see Creating and Editing Elements). The default groups can
be changed using the Project Options dialog (see Viewing/Editing Import Destination
SCGROUP Elements), or by setting the OWNER attribute using the attribute mapping
facilities (see Viewing/Editing Attribute Mappings).
Note: Groups may also contain other groups, which may in turn contain any of the
elements a higher level SCGROU may contain.
13:3
12.0
SCPLIN: Pipelines.
13:4
12.0
SCEQUI: Equipment.
SCSUBE: Sub-equipment.
SCNOZZ: Equipment nozzles.
SCELCO: Electrical connections.
SCOINS: Offline instruments.
13:5
12.0
SCTEMP: Templates.
SCPAGE: Schematic page.
SCIND: Schematic index.
SCSTEN: Stencils.
SCLOOP: Schematic instrument loop.
SCILIN: Schematic instrument line.
SCACTU: Schematic actuator.
13.3
13.3.1
13:6
12.0
13.3.2
The Attributes option is used to view the attributes of the current element. See
Viewing Element Attributes.
The Diagram Connector option is used to open the Diagram Connector, used to edit
existing connections, and to set connections between Off Page Connectors that were
not established on import. See Diagram Connector.
If the current element is a diagram, the Show Diagram option is used to open that
diagram in the Diagram Viewer. See Viewing Imported Diagrams.
The Show in Diagram option is used to open the Diagram Viewer and displays the
diagram in which the current element is located. See 14: Viewing Imported Diagrams.
The New option displays a sub-menu from which elements can be created. See
Creating and Editing Elements.
The Edit Members options displays a sub-menu from which multiple elements can be
created and edited. See Creating and Editing Elements.
The Add Link option is used to create a link element, i.e. a link between the current
element and an external document or url. Refer to DESIGN documentation for details.
The Rename option is used to change the name of the current element. See Renaming
Elements.
The Delete option is used to delete the current element and elements beneath it in the
element hierarchy. See Deleting Elements.
The Cut, Copy and Paste options are used to move and copy elements. See Moving
and Copying Elements.
Applying a Filter
The displayed elements can be filtered so that only diagram elements and elements above
diagrams in the hierarchy are displayed.
To apply the filter, check the Filter checkbox.
13:7
12.0
13.3.3
13:8
12.0
13.3.4
The new element is created without a name and is placed beneath the selected element in
the element hierarchy.
Elements are shown in the Schematic Explorer with their TYPE and element sequence
number (SEQU) combined.
13:9
12.0
13.3.5
Renaming Elements
To rename an element, select the element, right-click, and select the Rename option from
the menu. The Name dialog is displayed.
Enter the new name of the element and press the Apply button. Refer to Plant DESIGN
module or Marine Hull and Outfitting module documentation for additional details of this
dialog.
Enter the name of the new element. The following characters are not permitted in the name
of an element:
$ @ * ' '
A name may be a maximum of 50 characters.
It is not recommended that SCDIAG elements are renamed once loaded as it will affect the
ability of Schematic Model Manager to maintain the data associated with the diagram.
Rather than rename a diagram, it may be better to delete the diagram element and its
related elements from the database and re-import the diagram with the new name.
13.3.6
Deleting Elements
To delete elements other than diagrams, select the element, right-click, and select the
Delete option from the menu. The Confirm Delete dialog is displayed.
Note: If an element is deleted, all elements beneath it in the element hierarchy are also
deleted.
Press the OK button to complete the deletion.
13:10
12.0
Deleting Diagrams
To delete a diagram, select the diagram element, right-click, and select the Delete option
from the menu. The Delete Diagram dialog is then displayed.
13.3.7
Copying Elements
Elements can be copied.
To copy an element, right-click on the element and select the Copy option from the menu.
Select the element in the hierarchy beneath which the element is to be placed, right-click,
and select the Paste option from the menu. The element is then copied to the selected
location.
The name of a duplicate is the name of the original element prefixed with "Copy-of-". If
subsequent duplicates are made of the original element then each duplicated element is
prefixed with "Copy-([])-of-[Element Name]", where [] is an incremental count of the
number of duplicates for that element.
To rename an element, see Renaming Elements.
Note: When moving or copying the selected location must be valid for the element type in
the hierarchy. For example, a diagram element can be placed beneath a group
element, but not the other way round.
13.3.8
Viewing Diagrams
To view a diagram, select the diagram element, right-click, and select the Show Diagram
option from the menu.
The diagram is then displayed in the Schematic Model Manager Diagram Viewer.
13:11
12.0
Note that when an item on an imported diagram is selected, it becomes the current element
(i.e. is selected) in the Schematic Explorer.
See Viewing Imported Diagrams for details.
13.3.9
Saving Changes
To save changes to the database using the user interface, either select the
the Standard toolbar, or the Save Work option from the File menu.
button from
To save changes to the database using the command line, enter 'save work' at the
command prompt.
Note: Changes made in the explorer are not saved into the database until a Save Work
takes place.
13:12
12.0
14
14.1
Select a diagram or diagrams in the Schematic Explorer, and select Diagrams from the
View menu.
If no diagram is selected when the menu option is selected, the Diagram Viewer will open
without a diagram being displayed. Open a diagram using the View Diagram dialog as
described next, or drag and drop and diagram into the viewer from the Schematic Explorer.
or select a diagram or diagrams in the Schematic Explorer, right-click, and select the
Show Diagram option from the menu that is then displayed:
14:1
12.0
or select a diagram or diagrams in the Schematic Explorer, and drag and drop them
into the Diagram Viewer.
or, once the Diagram Viewer is opened, if the diagram was opened recently, select it
from the list of recently opened diagrams which can be accessed by selecting the
arrow to the right of the View Diagram button on the Diagram Viewer toolbar:
or, once the Diagram Viewer is open, use the View Diagram dialog to select and open
a diagram:
1. Select the View Diagram button from the Diagram Viewer toolbar:
14:2
12.0
To zoom into an area of a diagram preview, hold down the Ctrl key and left-click on one
corner of the area and then drag the cursor to the opposite corner of the area.
With the cursor over the diagram preview, press Ctrl and click on the diagram preview
to zoom in.
With the cursor over the diagram preview, press Ctrl+Shift and click on the diagram
preview to zoom out.
To pan, hold down Alt and the left mouse button and drag the cursor in the required
direction.
6. To reduce the number of diagrams listed in the Diagram Page window, or to search
for specific diagrams, use the Search For field and Search button. Select the
Diagram and By Diagram Name options and enter all or part of a diagram name in
the Search For field. Click Search.
The list of diagrams is then restricted to those with names containing the search
criteria.
14:3
12.0
If the search results are to displays pages instead of diagrams, select the Pages
option instead of the Diagram option.
To search the content of diagrams instead of diagram names, select the By
Content option instead of the By Diagram Name option.
The following wildcards may be used in the search criteria:
# - matches a digit
7. To open a diagram, select it from the list and press the OK button.
14.2
14:4
12.0
14.2.1
The mouse-over and highlight colours are specified using the Settings dialog. See Diagram
Viewer Settings.
When an item is selected, it may be set as the current element, and be selected in the
Schematic Explorer.
Whether or not this is the case is specified using the Settings dialog. See Diagram Viewer
Settings.
14:5
12.0
14.2.2
Diagram Connectors
To open the diagram that is the source or target of an off-sheet connector on the current
diagram, right-click on the connector and select the Go To Connected OPC option from the
menu that is then displayed.
The connected diagram is then opened in the viewer. If the option is disabled, no connection
exists. The connector is also highlighted and made the current element as described above.
To set up or edit a page connection, select the Diagram Connector option from the menu.
The Diagram Connector dialog is then displayed. See Diagram Connector.
14.2.3
14:6
12.0
15
Or right-click on an element in the Schematic Explorer and select the Edit Members option.
15:1
12.0
Element data is displayed in a grid. The parent of the elements is displayed in the title bar.
If the dialog was opened from the Schematic Explorer, the grid only displays elements that
of the selected type that are below the current element in the database hierarchy, i.e. a filter
is automatically applied (see Filtering Elements).
If the current element is changed, the list of displayed elements may change to reflect this,
depending on the setting of this button on the toolbar:
If the button if selected (this is the default setting) the list of elements in the grid changes
when the current element changes, i.e. the elements below the new current element in the
database hierarchy are then displayed.
The display of data in the grid can be configured in a number of ways. See Configuring the
Grid.
Elements are edited using the grid. See Editing Elements.
Above the grid is a toolbar. This is used to create, duplicate and delete elements. See
Creating Elements, Duplicating Elements and Deleting Elements.
The data grid may be exported to an Excel spreadsheet and printed. See Exporting the Grid
to an Excel Spreadsheet and Printing the Grid.
15:2
12.0
15.1
15.1.1
Grouping Elements
Filtering Elements
Sorting Elements
Refreshing Data
15:3
12.0
The dialog lists the columns in the grid. The Position field lists the position of each column
in the grid from left-to-right, with position 1 being the first (left-most) column. The
Expression field lists the identifier of each column. The Heading field lists the title text of
each column in the grid heading.
To add a column, select the Add Column option. A new, blank row of each fields is
added to grid. Enter the column details in the Expression and Heading fields as
required.
To edit a column, click on the Expression or Heading field that is to be edited and type
in the new value.
To change to order in which columns are displayed in the grid, select a column and
press the up or down arrow buttons to move it up the list (i.e. leftward in the grid), or
down the list (i.e. rightward in the grid).
To delete columns, select them (multiple columns may be selected) and press the
Delete Selected Columns option.
The width of columns may be changed in the grid. Place the cursor at the edge of a column
heading, hold down the left-mouse button and drag it out or in to the required width.
15:4
12.0
15.1.2
The Order column is then added to the left-hand side of the grid.
15.1.3
Grouping Elements
The format of the display of elements can be changed so that records with values in
common are grouped together. For example, element records can be grouped according to
their type.
The facility uses a grouping area which is displayed above the grid. If this is not displayed,
right-click on the grid and select the Enable Group Sorting option. The grouping area is
then displayed.
To group elements, drag and drop the column heading of the attribute they are to be
grouped by into the grouping area:
The grid then changes to display the name of each group in the following format:
<Attribute Name>: <Attribute Value> <(Number of records in the group)>.
15:5
12.0
The name of the column that elements are grouped by is displayed in the grouping area
To view the elements within a group, click on the + button next to the group name. The
elements are then listed under the name. Press the - button to close the list.
Note that the fields within a group can be fixed, sorted, and filtered in the normal way.
Ungrouping Data
To "ungroup" data, drag and drop the column heading or heading from the grouping area
back to the column heading row.
To remove the grouping area, select the Enable Group Sorting menu option.
15:6
12.0
15.1.4
Filtering Elements
There are two facilities for filtering elements, item type filtering and attribute value filtering.
From the menu that is then displayed, select the item type. To display elements of all types,
select the No filter option.
The list of element types on the menu is restricted to those that may exist under the current
element in the database hierarchy.
If this is not displayed, right-click on the grid and select the Enable Filtering option. The
filtering row is then displayed.
The filtering row includes two buttons. One is used to display a list of values from which an
operator can be displayed, for example Equals, Starts with, Contains, Less Than etc.
15:7
12.0
The symbol for the selected operator is displayed on the button. The default operator
("Starts with") is indicated with a capital "A".
The other button displays a list of values which contains every value displayed in the
column, plus Blanks and NonBlanks.
To set up a filter:
1. Select an operator from the Operator list in the heading of the column that contains the
attribute that element data is to be filtered by. The symbol on the list button displays the
selected operator.
2. From the value list, select a value that the operator is to be applied to in order to filter
the data. The selected value is displayed in the field between the two buttons.
3. If (Blanks) is selected, the operator will be applied to fields in the column which are
blank, e.g. the filter may restrict the data displayed to those records that do not have a
value in the selected column.
4. If (NonBlanks) is selected, the operator will be applied to fields in the column which are
not blank.
5. Alternatively, type the value in the field between the two list buttons. A partial value
may be typed into the field.
6. Once an operator and value has been selected, the filter is immediately applied.
Multiple filters of this sort may be applied.
To remove all filters of this sort, select this button at the start of the filter row:
To remove the filter row, select the Enable Filtering menu option.
15.1.5
Sorting Elements
To sort elements in the grid by a specific attribute, first activate this facility by right-clicking
on the grid and selecting the Enable Column Sort option.
Click on the heading of the column that elements are to be sorted by. For example, to sort
the items by Type, click on the Type heading at the top of the Type column. The items will
then be sorted alphanumerically by Type (from lowest to highest).
15:8
12.0
The column by which elements are currently sorted is indicated by a downwards or upwards
pointing arrow in the column heading. The direction of the arrow indicates the order in which
the records are sorted. Click on the column heading to reverse the sort order.
15.1.6
A pinned column is moved so that it is the first column on the left. A pinned row is moved so
that is the top row.
To un-pin a column or row, press the button again. The column or row is no longer pinned,
but will remain in the far-left or top position.
15.1.7
15:9
12.0
15.1.8
To change the colours used to indicate these conditions, right-click on the grid and select
the Feedback Colours option from the menu. From the Feedback Colours sub-menu,
select the option for the feedback colour to be changed:
Select the required colour from the dialog that is then displayed, and press the Dismiss
button.
15:10
12.0
15.1.9
Refreshing Data
On occasion, changes to the data in the Schematic database may not immediately be
reflected in the element data displayed in the grid.
To force the displayed data to refresh, right-click on the grid and select the Refresh option
from the menu.
The data displayed in the grid is then refreshed with the current content of the database.
A Save As dialog is then displayed. Save the configuration file (an .xml file) in the following
folder in the local settings area for the user:
..\applicationdata\Aveva\SchematicModelManagerSettings\.
15.2
Editing Elements
Before data in the grid can be edited, the required interaction mode must be selected.
There are three interaction modes:
To select the required mode, right-click on the grid and select the Interaction Mode option
from the menu. From the Interaction Mode sub-menu select the required mode.
In Single Cell Edit mode, only one cell at a time may be selected, and only the that cell may
be edited. Single-click on a cell to edit its contents, and enter the new value as required.
15:11
12.0
In Bulk Cell Edit mode, double clicking on a cell places that cell in edit mode, so that it can
edited in the same way as in Single Cell Edit mode.
To select multiple cells in Bulk Cell Edit mode, single click on a cell and use standard
Windows selection methods (e.g. left mouse click plus Ctrl and Shift keys). A left-mouse
drag operation can also be used.
Once multiple cells have been selected they can be edited at the same time using Fill Down,
Fill Up and Copy/Paste operations.
15.2.1
The cell is read-only, and cannot be edited regardless of the current interaction mode.
An unsuccessful attempt has been made to edit the contents of the cell because the
new value was invalid.
These are known as cell feedback colours. The default colours may be changed is required
(see 15.1.8: Setting Cell Feedback Colours).
In the example below, the Type fields are read-only, the first Description field has been
successfully edited, and an unsuccessful attempt to update the first Area field has been
made.
The reason for the failure of an edit is displayed on a tool-tip when the mouse is hovered
over the cell in question.
To clear all cells in the grid of successful edit and unsuccessful edit feedback colours, rightclick and select the Reset Cell Feedback option from the menu.
15:12
12.0
15.3
Creating Elements
To create new elements:
1. Select the type of new element(s) to create from this dropdown list in the toolbar:
The lists includes only those types of element that may be created under the current
element.
2. Select where the new element or elements are to be created in the list of existing
elements.
To place the new element(s) at the top the list, select this toolbar button:
.
To place the new element(s) directly above the currently selected element in the list,
select this toolbar button:
and
To place the new element(s) at the bottom the list, select this toolbar button:
3. Select the number of new elements to be created from this dropdown list in the toolbar:
15:13
12.0
15.4
Duplicating Elements
To duplicate an element:
1. Select the element to be duplicated.
To select an element either click its row, or use the
down the list of items.
and
2. Select where the duplicate or duplicates are to be created in the list of existing
elements.
To place the duplicate(s) at the top the list, select this toolbar button:
.
To place the duplicate(s) directly above the currently selected element (the element to
be duplicated) in the list, select this toolbar button:
To place the duplicate(s) at the bottom the list, select this toolbar button:
3. Select the number of duplicates to be created from this dropdown list in the toolbar:
15:14
12.0
15.5
Deleting Elements
To delete an element, select it from the grid and then select this button from the toolbar:
Note: If an element is deleted, all elements beneath it in the element hierarchy are also
deleted.
Press the OK button to complete the deletion.
When deleting a diagram, the Delete Diagram dialog is then displayed instead of the
Confirm Delete dialog.
15.6
15:15
12.0
15.7
15:16
12.0
16
16:1
12.0
The dialog displays an explorer style view of the selected element and its child elements.
Elements are grouped together according to type. For example, Equipment and Instruments
are grouped together, separately from Pipelines.
The dialog displays the name of each element and its current release status. For elements
that have been released and are of types that have 3D model counterparts, the date that the
release took place, and the identity of the user that performed the release is displayed.
16:2
12.0
Each displayed element has a checkbox next to its name. If the checkbox is checked, this
indicates that the element has been released.
In the case of parent elements, if the checkbox is checked this indicates that the parent
element and all of its child elements have been released. If the checkbox is filled (i.e. with
square) rather then checked, this indicates that some of the child elements have been
released, but not all.
Uncheck the checkboxes of those child elements that are not to be released.
To un-release a previously released element, uncheck its checkbox. The checkboxes of its
child elements (if any) are not automatically unchecked.
In the Comment field, enter release/un-release comments as required.
If the comment is only to be applied to those elements that have had their release status
changed rather then all displayed elements, ensure that the Apply comment only for
changed elements checkbox is checked.
Press the Set Status button to complete the changes to the release status of the selected
elements and close the dialog.
To close the dialog without implementing any changes, press the Cancel button.
16:3
12.0
16:4
12.0
17
17.1
Standard Searches
The standard Schematic Model searches are accessed from the Saved Searches section of
the Search utility. The screen shots below include the list of available searches at the time of
writing. Additional ones may be added during this, or future, versions.
To access the Search utility, if not already open, select Search from the View menu.
17:1
12.0
In the Search utility, the Schematic Model Manager searches can be accessed by opening
the Saved Searches section at the bottom of the Search utility, then selecting the Schematic
Model Manager option from the Select dropdown list:
You can then load one of the searches using the next dropdown list and selecting the
Search button:
At this point the search has been run and the results shown in the Search Results window.
You will see the Search utility has also been populated with the criteria used which can now
be modified and adjusted to further refine the search. It should be noted however that the
searches cannot be over written. If you wish to save a modified search you must do this by
saving it under a different name.
17.1.1
Search Toolbar
The search toolbar, below, can also be used to run a standard search. Selecting Schematic
Model Manager from the Locations dropdown will enable you to then select the search you
require.
17:2
12.0
17.2
Catalogue Search
Schematic Model Manager includes a search facility which provides direct access to the
Plant or Marine catalogue.
This facility is accessed by selecting the Catalog Search option from the View menu.
The specification reference of the current schematic element may be set via the Catalogue
Search, by using the Select button.
For further information regarding the operation and use of the Catalogue Search feature,
please see the AVEVA Diagrams user guide.
17:3
12.0
17:4
12.0
18
Report Content
SMMEquipmentList.tmp
Equipment List
SMMInstrumentIndex.tmp
Instrument Index
SMMLineList.tmp
Line List
SMMLineListSCBRAN.tmp
SMMLineListSCPLIN.tmp
SMMNotReleasedItems.tmp
SMMOffPageConnectors.tmp
SMMReleasedItems.tmp
SMMUnconnectedOffPageConnectors.tmp
SMMValveList.tmp
Valve List
To run a report:
Select Utilities > Reports > Run from the Tools menu.
To view or modify a template:
Select Utilities > Modify > Report.
To create a new template:
Select Utilities > Reports > Create.
For further details:
Refer to the Reporting Using PDMS manual.
18:1
12.0
18:2
12.0
19
19.1
specify which User Defined Attributes (UDAs) are available in each schematic
database with which Schematic Model Manager operates,
map UDA and other database attributes to attributes from the diagram data source
files.
To prevent this message from being displayed again, check the Dont show this again
checkbox.
To configure UDAs, press the OK button. Continue at Configuring UDAs. Otherwise press
Cancel.
19.2
Configuring UDAs
The UDA Catalogue dialog is used to specify which User Defined Attributes (UDAs) are
available in each schematic database with which Schematic Model Manager operates.
This dialog can be opened automatically when LEXICON is started (see above), or from the
UDA Catalogue option on the Schematic Model Manager menu.
Before this dialog is opened, the system checks the number of schematic databases that
the user can write to.
19:1
12.0
If the user has write access to more than one database, the following dialog is displayed,
listing these databases:
Select the dictionary database to store the UDA definitions and press OK. The UDA
Catalogue dialog then opens with information on the Schematic Model Manager UDAs.
If the user has write access to a single dictionary database, the UDA Catalogue dialog will
open with information on the Schematic Model Manager UDAs, and configures them in the
dictionary database that it has access to.
If the user does not have write access to any databases, UDA Catalogue dialog opens but
a message is displayed indicating that either there are no writeable databases, or that the
user does not have permission to write to them.
19:2
12.0
19.2.1
19:3
12.0
If there are no writeable databases, or the user does not have write access to them, the
UDA catalogue is displayed, but the user can make no changes - all buttons and
checkboxes are disabled.
If the user does have write access to a dictionary database, the dialog lists the UDA
catalogue and indicates whether or not each UDA is in that database, and whether or not
attribute mapping has been set up for it.
The name and description of each UDA is displayed.
If a UDA is present in the schematic database, the following icon is displayed in the UDA
row: .
If a UDA is present in the schematic database and attribute mapping has been set up for it,
the following icon is also displayed in the UDA row:
.
To add a UDA to the database, check the checkbox at the end of the row. To remove it,
uncheck the checkbox.
To check the checkboxes for all UDAs, press the Select All button.
To uncheck the checkboxes for all optional UDAs, press the Deselect All button.
To open the attributes dialog for a UDA, either double-click on it, or right-click and select the
Attributes option from the menu that is then displayed. See Viewing and Editing UDA
Attributes.
To view the attribute mapping that is associated with a UDA right click on the UDA in the list
and select the Attribute Mapping option. (see Viewing/Editing Attribute Mappings).
To make a UDA the current element, right-click and select the Set as CE option from the
menu that is then displayed.
Press the Undo button to undo any changes made since the dialog was opened.
Press the Apply button to save changes.
If any UDAs have been removed from the database, a message is displayed requesting that
the deletion of these UDAs and associated attribute mappings be confirmed:
19:4
12.0
19.2.2
The dialog displays the attributes of the UDA currently selected in the UDA Catalogue
dialog. If the UDA is present in the dictionary database, the attributes displayed are those of
the UDA in that database, rather than the default catalogue attributes for the UDA.
Edit the attributes as required. Those attributes with values displayed in grey instead of
black text cannot be edited.
19:5
12.0
19.3
19:6
12.0
20
Appendices
20.1
20.1.1
Alternation
A vertical bar is used to separates alternatives. For example, CHECK|CHK will match both
CHECK and CHK.
20.1.2
Grouping
Parentheses are used to define the scope and precedence of the operators. For example:
analog|analogue
and
analo(g|(gue))
These are equivalent, and would return positive matches on both analog and analogue.
Parentheses have other uses in Regular Expression construction which are beyond the
scope of this guide.
20:1
12.0
20.1.3
? The question mark indicates there is zero or one of the preceding element. For
example, too? matches both to and too.
* The asterisk indicates there are zero or more of the preceding element. For example,
ab*c matches ac, abc, abbc, abbbc, and so on.
+ The plus sign indicates that there is one or more of the preceding element. For
example, ab+c matches abc, abbc, abbbc, and so on, but not ac.
The following table contains explanations of the meaning of some commonly used Regular
Expression metacharacters, and provides some simple examples of their use, to define how
Schematic Model Manager may automatically determine the GTYPE and optionally the
SCSTYPE that should be applied to an ISO15926 component class when executing the
'Auto Complete' option.
Metacharacter
Description
Example
Example:
(3.*(WAY VALVE))
3 WAY VALVE
Example:
((BLI..).(SP...))
( )
20:2
12.0
Metacharacter
Description
Example
Example:
(CLOSED.4?)
{M,N}
[...]
20:3
12.0
Metacharacter
Description
Example
Example:
[1-3]
[n1-n2]
Matches a range of
characters (alpha and
numeric), where n1 is the
start of the range and n2
the end.
Separates alternate
possibilities.
\b
\W
20:4
12.0
Metacharacter
Description
Example
Example:
3\s
\s
\S
\d
\D
Matches a non-digit.
20:5
12.0
Metacharacter
Description
Example
Example:
(FILTER)$
20.1.4
\A
\Z
[^...]
Matching
To match a group of characters, surround the characters with parenthesis. For example:
(PINCH VALVE)
20:6
12.0
Will find a match wherever PINCH VALVE appears in a Component Class, such as:
PISTON ACTUATED PINCH VALVE
PINCH VALVE
To exactly match a literal in a regular expression ensure that the expression begins with the
^ character and ends with the $ character. For example:
^(PINCH VALVE)$
This will match PINCH VALVE but will not match PISTON ACTUATED PINCH VALVE.
Escape Sequence
An escape sequence is a way of using a metacharacter as part of the search criteria of a
regular expression. This is done by placing the \ (backslash) character in front of the
quantifier.
For example the regular expression \* will find the * character in the component class name
BAG*FILTER.
20:7
12.0
20.2
SCOINS
SCEQUI
SCSEG
Other element types are not displayed by the AVEVA Schematic 3D Integrator.
In addition, if the descendents of a schematic element may be of one or more of the above
types, then release related actions may be initiated from the parent (such as a Release or
Un-Release). In these cases release related actions will operate on the children (that can
be released) of the parent.
Schematic elements which may be parents are:
Schematic WORL*
SCGROU
SCPLIN
In addition to these elements, release related actions may also be initiated from SCDIAG
elements. This carries out the release action on all elements (that can be released)
contained on the diagram which corresponds to the SCDIAG element.
Release related information about elements of the types SCOINS, SCEQUI and SCSEG is
stored in the following attributes of those elements:
RECOMM
REDATE
RESTAT
REUSER
The PDMS user name of the user who carried out the last release related
activity
20:8
12.0
20.3
XML element names are represented in their simplest form as the tag name, e.g.
<MyElement> is represented as MyElement.
XML attribute names in their simplest form are prefixed with the @ character, e.g. the
attribute MyAttribute=value is represented as @MyAttribute
Long form
Short Form
Description
child::MyElement
MyElement
attribute::MyAttribute
@MyAttribute
child::*
attribute::*
parent::*
..
ancestor::MyElement
self ::*
/descendants::*
//*
self::*//
//
following-sibling::*
preceding-sibling::*
MyElement[@MyAttribute = Motor]
20:9
12.0
MyElement[1]
MyElement[last()]
translate(MyElement/@Tag,-,_)
concat(MyElement[1],MyElement[2])
count(MyElement)
name(.)
local-name(.)
A Boolean expression is one that returns a value of True or False. This is usually
achieved using an equivalence or existence test such as:
@MyAttribute = SomeValue
@MyAttribute
Count(MyElement) = 1
20:10
12.0
20.4
20.4.1
20:11
12.0
Attribute
Description
Example
File
FileName
File
FilePath
Fully qualified:
C:\Data
Relative to the diagram
set:
.\Data
File
DiagramName
MatchedSCDIAG
=16388/64238
The database
reference of the
diagram already
loaded into the
database that this
file is to be matched.
ImportFileSet
Name
ImportFileSet
ReleaseComment
20:12
12.0
For example:
20.4.2
A line that starts with '//' will be treated as a comment and ignored.
All other lines are interpreted as a fully qualified or relative file path. If the text cannot
be interpreted as a file path the .txt file is considered invalid. File paths may be
enclosed in "" characters
Note: All P&ID files listed in a text file are expected to have a file extension.
Note: The user interface expects text files for diagram sets to have the file extension '.txt'
For example:
// -------------------//
// Date : 24/04/2009
// Time : 11:39::24
// System : Handwritten
//
// --------------------
20:13
12.0
.\P&ID Data\905680.xml
// end of file
20:14
12.0
20.5
20.5.1
20:15
12.0
PARENTMDB. The SCHE DB PIDDATA was created here. In this example, this DB is
intended for use by AVEVA Schematic 3D Integrator, and for project reporting purposes.
This will be the static Schematic database and can be viewed as an Issued schematic data
repository. No direct imports or manual updates of schematic data will take place here. This
is the issued schematic database. Data will only be propagated to this DB from the extract.
EXTRACTMDB - The DB PIDDATAEXTRACT was created and added to this MDB. This DB
is an extract DB taken from DB PIDDATA. In this example, this DB is intended to be the
main DB for importing and updating schematic data. Data may be examined here and any
necessary data cleansing and editing tasks can be carried out. Additional schematic
20:16
12.0
elements may be manually created; equipment can be imported from a CSV or MS Excel
file. This is the working DB for schematic data.
Only when this data is considered to be at a state where it may be used by other members
of the project team (for example at a particular project milestone, such as Approved for
Design), or for use in 3D, can it then be propagated to the DB PIDDATA in PARENTMDB.
20:17
12.0
20.5.2
20:18
12.0
This data can now be checked, validated using the Report or Search features, and if
necessary, manually edited. Additional schematic elements may be imported from external
systems via CSV or MS Excel imports.
At this point the DB PIDDATA in PARENTMDB contains no schematic data.
20.5.3
20:19
12.0
20:20
12.0
The schematic data will now have been propagated to DB PIDDATA in PARENTMDB.
Login to PARENTMDB.
20:21
12.0
The schematic data from the PIDDATAEXTRACT DB in the EXTRACTMDB has now been
propagated to PARENTDB.
20.5.4
20:22
12.0
Login to Schematic Model Manager using EXTRACTMDB and import the two new P&IDs.
20:23
12.0
Validation and checking tasks can now be carried out using the Diagram Viewer, off page
connection tools, reporting and search facilities.
When these P&ID have been validated they can be propagated to DB PIDDATA in
PARENTMDB for general use and for use by AVEVA Schematic 3D Integrator.
Before initiating an issue from the extract, carry out a save work.
The Extract Data Control dialog now indicates, by the use of prefix letters, the state of
elements in the extract schematic database.
20:24
12.0
For an explanation of the meaning of the prefix letters click the Prefix Info button.
Clicking on a parent element in the Elements window shows extract status information
about the parent's child elements. In the example below, we can see that SCDIAG elements
905681 and 905680 have been modified in the extract.
Click the Issue button. The modified data will be propagated to DB PIDDATA in
PARENTMDB for general use and for use by AVEVA Schematic 3D Integrator.
20:25
12.0
20:26
12.0
20.6
20.6.1
At this point the P&ID will be issued for review and comment.
Check that client and engineers comments made at Revision A have been included.
Check that line numbers are completed and that insulation and tracing specs are
completed.
Check that all tags are completed for equipment, instruments, manual valves and
piping.
20:27
12.0
20.6.2
Give the Status World a meaningful name and description in the Current Element Editor.
20:28
12.0
Right-click on the new Status World in the Explorer and select New Status Definition can
(Status Groups to contain Status Definitions can also be created). Enter a Name and
Description in the Editor (these will typically be similar, but the description can include
spaces and will be used in the Status Controller if it is set).
20:29
12.0
Select the controllable element that status definitions are to be applied to. In this example
the P&ID status will be managed, so the corresponding schematic element is SCDIAG.
20:30
12.0
Now right-click on the Status Definition in the Explorer and select New Status Value. Enter a
Name, Description and Numerical value in the Current Element Editor (entry of a
numerical value is optional and may be a percentage or a simple value).
The valid transition for each Status Value may now be set. Click on the selection button to
show the Select valid status transitions dialog.
20:31
12.0
From Rev A a P&ID may only transition to Rev B. Set the transition accordingly.
Rev A is the start of the P&ID Management process so may only be moved up through this
process from Rev A to Rev B. Set the Promote value to Rev B, and leave the Demote
value blank.
20:32
12.0
For Rev B the valid transitions promotion to Rev 0 and demotion to Rev A. Set the
transitions accordingly.
The final step in this simplified example P&ID status control lifecycle is Rev 0. All changes to
the P&ID from that point must be tracked and documented and for the purposes of this
simplified example it is assumed that the status control example ends here. There are
therefore no transitions from Rev 0.
20:33
12.0
20.6.3
To use the new status definitions a new status layout must be configured.
20:34
12.0
The schematic elements to which the status definitions apply will be displayed, along with
their status values.
The P&ID which have already been imported into the database have not yet had their status
values set are displayed.
These P&ID have now ready to be issued for review and comment.
20:35
12.0
20:36
12.0
At this point in the P&ID development process further tasks take place. In this simplified
example the P&IDs are Issued to engineers for checking and commenting and:
To ensure that major equipment items are at relevant positions on drawings Equipment
numbers align with Process Flow Diagrams and the layout of each P&ID is a
representation of the process flow.
Each of these is supported by Schematic Model Manager. The following two sections
explain how these activities are supported.
20:37
12.0
The diagram will be made the current element. If the schematic explorer is open the
diagram element will be highlighted.
20:38
12.0
20:39
12.0
The element will be highlighted on the diagram. The corresponding SCEQUI element in the
schematic database will be highlighted.
Clicking on the Off Page Connector will make the corresponding schematic element the
current element, and highlight it in the Schematic Explorer, if it is open.
Right-click on the Off Page Connector on the diagram and select Go to Connected OPC.
The diagram containing the connected OPC will be opened and the relevant OPC
highlighted.
20:40
12.0
Once the diagrams have been checked, drafting errors corrected and the diagrams reimported, the diagrams are ready to be moved to Rev B using the status controller.
Using the status history we can view the diagrams transition so far through the status control
process which has been defined. This history is based on session data, so some transitions
which occurred during one session will not be shown.
20:41
12.0
Using the status controller, the status of this diagram is changed. The valid status transitions
defined in the status definitions are shown to prevent an inappropriate status transition from
being selected.
After revision and re-import, the diagram may now be promoted back to a status of Rev B.
This must be done before it can make the transition to Rev 0.
All diagrams are now validated and Approved for Design.
20:42
12.0
Again using the status controller the status of the diagrams is changed.
20:43
12.0
20.7
20.7.1
Introduction
To support the generation of line-related project deliverables, such as line lists with
configurable content, several pseudo attributes have been added to line and branch
elements in the schematic database.
These pseudo attributes are:
Element
Pseudo
Attribute
Type
Purpose
SCPLIN
LLDIAGRAMS
Text
LLENTRY
Bool
LLFROM
Text
SCBRAN
SCPLIN
SCBRAN
SCPLIN
SCBRAN
SCBRAN
LLTBRANCH
SCPLIN
LLTO
SCBRAN
These pseudo attributes are configured using the Line List Configuration tool.
The line list related pseudo attributes are provided to allow users to:
Define text values to describe the start and end values of pipelines and branches.
These values may be populated using rule criteria.
Determine the SCBRAN element at the point where the main flow of a SCPLIN
terminates, so that attributes of this SCBRAN may be accessed for reporting purposes.
The pseudo attributes are required because, due to the structure of the schematic database,
line list related data is held by different elements at different levels in the schematic
hierarchy.
20:44
12.0
20.7.2
A basic set of configurations is included for some rule types. Using this dialog, users can
configure rules additional rules to meet their line list requirements.
Note: For a detailed description of the dialog and its use, see 9: Line List Configuration.
20:45
12.0
20.7.3
20:46
12.0
Value
Meaning
Attribute
End Condition
Valid HREF/TREF
Item Types
DbElementType[]Array
Name
PML Expression
'But
Cap'
Welded
Rule Filters
--
Once configured, the line list related pseudo attributes will be populated each time they are
queried.
20:47
12.0
20.7.4
20:48
12.0
Right-click on a column heading, and from the right click menu that is then displayed, select
Column Setup
20:49
12.0
The Column Setup dialog is then displayed. Enter the following columns:
Select the Create "Saved Search" Based on Current Search Criteria option. Give the
search a meaningful name, in this example "Example Line List" is used.
20:50
12.0
These will include the LLFROM and LLTO derived values, including "Butt Welded Pipe Cap"
where appropriate.
20:51
12.0
To export the example line list to Microsoft Excel, right-click on a column heading, and from
the right-click menu that is then displayed, select Export to Excel...
A Save As dialog will then be displayed. Enter meaningful name for the exported line list, in
this example "Line List" is used.
20:52
12.0
The saved search results will then be exported to an Excel spreadsheet file.
The file will contain your line list data, including your defined column headings, and some
default formatting.
20:53
12.0
20:54
12.0
Index
A
Abort Diagram Import . . . . . . . . . . . . . . . 3:4
Accessing the Configuration Options . . . 8:2
Accessing the Schematic Model Manager Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:2
Add Date/Timestamp to Release Comment 3:5
Alternation . . . . . . . . . . . . . . . . . . . . . . . 20:1
Attribute Mapping . . . . . . . . . . 6:1, 6:6, 19:6
Attribute Mapping Groups . . . . . . . . . . . . 6:4
Attribute Unit . . . . . . . . . . . . . . . . . . . . . . 6:8
Attributes
Derivation Rules . . . . . . . . . 2:5, 5:1, 6:1
Filter . . . . . . . . . . . . . . . . . . . . . . . . . 5:6
Mapping . . . . . . . . . . . . . . . . . . . . . . 2:2
Viewing Element Attributes . . . . . . 13:8
Auto Complete . . . . . . . . . . . . . . . . . . . . 7:7
Automatic Completion of ISO 15926 Mappings
7:6, 7:7
Automatic Matching of Off-Page Connectors
11:16
C
Catalogue Search . . . . . . . . . . . . . . . . . 17:3
Closing Diagrams and the Viewer . . . . . 10:5
Condition . . . . . . . . . . . . . . . . . . . . . 6:5, 6:7
Configuration of Line Lists using Pseudo Attributes . . . . . . . . . . . . . . . . . . . . . . . . 20:44
Configure Auto Complete . . . . . . . . . . . . 7:6
Configuring the Source Data Dictionary . 8:1
Configuring UDAs . . . . . . . . . . . . . . . . . 19:1
Conflict Resolution . . . . . . . . . . . . . . . . . 7:4
Copy from Project . . . . . . . . . . . . . . . . . . 3:6
Copying Elements . . . . . . . . . . . . . . . . 13:11
D
Database Configuration . . . . . . . . . . . . . 2:1
Date/Timestamp . . . . . . . . . . . . . . . . . . . 3:5
DB Expression . . . . . . . . . . . . . . . . . . . . 5:8
DB Match . . . . . . . . . . . . . . . . . . . . . . 11:10
Deleting
Diagrams . . . . . . . . . . . . . . . . . . . 13:11
Elements . . . . . . . . . . . . . . 13:10, 15:15
Rule Groups . . . . . . . . . . . . . . . . . . 5:10
Rules . . . . . . . . . . . . . . . . . . . . . . . 5:10
Deleting Elements . . . . . . . . . . . . . . . 15:15
Deleting Mapping Groups and Mappings 6:25
DESIGN . . . . . . . . . . . . . . . . . . . . . . . . 1:10
Diagram Connectors . . . . . . . . . . . . . . 14:6
Diagram Set 11:4, 11:5, 11:8, 11:9, 11:12, 11:18
Creating a Diagram Set . . . . . . . . . 11:5
Editing . . . . . . . . . . . . . . . . . . . . . . 11:9
Importing . . . . . . . . . . . . . . 11:12, 11:18
Opening . . . . . . . . . . . . . . . . . . . . . 11:8
Diagram Set Editor . . . . . . . . . . . . . . . . 11:5
Diagram Set File Formats . . . . . . . . . 20:11
Diagram Sets . . . . . . . . . . . . . . . 11:4, 20:11
Diagram Viewer
Index page i
12.0
E
Editing
Elements . . . . . . . . . . 13:9, 15:1, 15:11
Rule Groups . . . . . . . . . . . . . . . . . . . 5:4
Rules . . . . . . . . . . . . . . . . . . . . . . . . 5:5
Editing Diagram Sets . . . . . . . . . . . . . . 11:9
Editing Elements . . . . . . . . . . . . 13:9, 15:11
Editing Mapping Groups and Mappings 6:24
Editing, Adding and Deleting Line List Configuration Rules . . . . . . . . . . . . . . . . . . . . . . . . 9:3
Element
Attributes . . . . . . . . . . . . . . . . . . . . 13:8
Filter . . . . . . . . . . . . . . . . . . . . . . . . 13:7
Hierarchy . . . . . . . . . . . . . . . . . . . . 13:2
Right-Click Menus . . . . . . . . . . . . . 13:6
Types . . . . . . . . . . . . . . . . . . . . . . . . 5:9
Element Release Tab . . . . . . . . . . . . . . . 3:3
Display Comments Dialog on Release to 3D
3:5
Set Release Behaviour of Elements on Import . . . . . . . . . . . . . . . . . . . 3:3
Element types . . . . . . . . . . . . . . . . . 6:4, 6:7
Enable Release Comments . . . . . . . . . . 3:5
End Condition . . . . . . . . . . . . . . . . 9:6, 9:10
Explorer . . . . . . . . . . . . . . . . . . . . . . . . . 13:1
Element Hierarchy . . . . . . . . . . . . . 13:2
Opening the Schematic Explorer . . 13:1
Using the Explorer . . . . . . . . . . . . . 13:6
Export
Location . . . . . . . . . . . . . . . . . . . . . . 4:3
Options . . . . . . . . . . . . . . . . . . . . . . . 3:7
Exporting Schematic Model Manager Options
3:7
F
File Format . . . . . . . . . . . . . . . . . . . 6:5, 6:8
File Format Version . . . . . . . . . . . . . 6:6, 6:8
File Locations Tab
Set Default Export Location . . . . . . . 4:3
Set Default Import Location . . . . . . . 4:2
Filter
Attribute . . . . . . . . . . . . . . . . . . . . . . 5:6
Element . . . . . . . . . . . . . . . . . . . . . 13:7
Line List Configuration Rule . . . . . . . 9:3
G
General Tab . . . . . . . . . . . . . . . . . . . . . . 3:5
Copying Schematic Model Manager Options
from another Project . . . . . . 3:6
Exporting Schematic Model Manager Options . . . . . . . . . . . . . . . . . . 3:7
Importing Schematic Model Manager Options . . . . . . . . . . . . . . . . . . 3:7
Restore Default Options . . . . . . . . . 3:7
Grouping . . . . . . . . . . . . . . . . . . . . . . . 20:1
GTYPE . . . . . . . . . . . . . . . . . . . . . . . 2:2, 7:1
GTYPE Mappings . . . . . . . . . . . . . . . . . 2:2
H
Highlighting . . . . . . . . . . . . . . . . . . . . . 14:5
HREF . . . . . . . . . . . . . . . . . . . . . . . 9:6, 9:10
I
Import
Designations from File . . . . . . . . . . . 7:3
Designations from other Databases 7:9
Destination Groups . . . . . . . . . . . . . 3:9
Diagram Sets . . . . . . . . . . . . . . . . . 11:4
Diagrams . . . . . . . . . . 11:1, 11:2, 11:17
ISO 15926 Designations . . . . . . 7:3, 7:9
Location . . . . . . . . . . . . . . . . . . . . . . 4:2
Options . . . . . . . . . . . . . . . . . . . . . . 3:7
Progress . . . . . . . . . . . . . . . . . . . 11:14
Schematic Model Manager Options . 3:7
Starting . . . . . . . . . . . . . . . . . . . . 11:12
Import and keep existing status (OFF) . . 3:4
Import and keep existing status (ON) . . . 3:4
Import and set release status to OFF . . . 3:4
Import and set release status to ON . . . 3:4
Import Configuration Tab . . . . . . . . . . . . 3:8
Specifying whether or not Drawings are to be
Imported in Colour . . . . . . 3:11
Viewing/Editing Equipment and Off Line Instrument Positions . . . . . . 3:10
Viewing/Editing Import Destination SCGROUP Elements . . . . . . . . 3:8
Import Diagrams Facility . . . . . . . . . . . 11:2
Import diagrams in colour . . . . . . . . . . . 3:11
Importing Diagram Sets . . . . . . 11:12, 11:18
Importing using PML . . . . . . . . . . . . . 11:16
Installation . . . . . . . . . . . . . . . . . . . . . . . 1:1
Installation and Pre-Configuration . . . . . 1:1
Introduction . . . . . . . . . . . . . . . . . . . . . . 1:1
ISO 15926 . . . . . . . . . . . . . . . . . . . . 1:1, 7:1
ISO 15926 Designation . . . . . . . . . . 7:2, 7:9
ISO 15926 Mappings . . . . . . . . . . . . 7:6, 7:7
Index page ii
12.0
K
Keyboard Commands . . . . . . . . . . . . . . 10:5
L
LEXICON . . . . . . . . . . . . . . . . . . . 2:1, 19:1
Line List Configuration . . . . . . . . . . . . . . 9:1
LLDIAGRAMS Configuration . . . . . 9:11
LLENTRY Configuration . . . . . . . . . . 9:4
LLFROM/TO Configuration . . . . . . . 9:7
Line List Configuration Rules
Editing, Adding and Deleting . . . . . . 9:3
LLDIAGRAMS Configuration . . . . . . . . 9:11
LLENTRY Configuration . . . . . . . . . . . . . 9:4
LLFROM/TO Configuration . . . . . . . . . . . 9:7
M
Mapping Groups and Mappings
Deleting . . . . . . . . . . . . . . . . . . . . . 6:25
Editing . . . . . . . . . . . . . . . . . . . . . . 6:24
Moving . . . . . . . . . . . . . . . . . . . . . . 6:24
Mapping Set-Up . . . . . . . . . . . . . . . . . . . 2:1
Attribute Mapping . . . . . . . . . . . . . . . 2:2
GTYPE Mapping . . . . . . . . . . . . . . . 2:2
Page Matching . . . . . . . . . . . . . . . . . 2:4
Matching Off-Page Connectors . 11:16, 12:1
Module Definition Configuration . . . . . . . 2:1
Moving Elements . . . . . . . . . . . . . . . . 13:11
Moving Mapping Groups and Mappings 6:24
Moving Rules and Rule Groups . . . . . . 5:10
N
NameClashRule . . . . . . . . . . . . . . . . . . . 5:7
O
Off Line Equipment and Instrument Default Position . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:10
Off-Page Connectors . . . . . . . . . . . . . . 12:1
OPCs . . . . . . . . . . . . . . . . . . . . 11:16, 12:1
Opening an Existing Diagram Set . . . . . 11:8
Opening the Schematic Explorer . . . . . 13:1
Overwrite Mappings in Databases with Current
Mappings . . . . . . . . . . . . . . . . . . . . . . . 7:10
P
P&ID Status Control in Schematic Data Model
Management . . . . . . . . . . . . . . . . . . . . 20:27
Q
Quantification using Metacharacters . . 20:2
R
Re-apply to databases(s) . . . . . . . . . . . 7:10
Regular Expressions . . . . . . . . . . . . . . 20:1
Alternation . . . . . . . . . . . . . . . . . . . 20:1
Grouping . . . . . . . . . . . . . . . . . . . . 20:1
Guidelines . . . . . . . . . . . . . . . . . . . 20:6
Quantification using Metacharacters 20:2
Releasing Data . . . . . . . . . . . . . . . . 3:3, 20:8
Release Behaviour . . . . . . . . . 3:3, 20:8
Existing Elements - Not Released 3:4
Existing Elements - Released . . 3:4
New Elements . . . . . . . . . . . . . . 3:4
Release Comments . . 3:5, 11:11, 11:17
Releasing Data and Unreleasing Data . 16:1
Renaming Elements . . . . . . . . . . . . . . 13:10
Reports . . . . . . . . . . . . . . . . . . . . . . . . . 18:1
Reset Defaults . . . . . . . . . . . . . . . . . . . . 3:7
Resetting the Dictionary . . . . . . . . . . . . . 8:3
Restore Default Options . . . . . . . . . . . . . 3:7
Rule Groups . . . . . . . . . . . . . . . . . . . . . . 5:1
Rule Names . . . . . . . . . . . . . . . . . . . . . . 5:9
Rules . . . . . . . . . . . . . . . . . . . . . . . . 5:1, 5:3
S
Saving Changes . . . . . . . . . . . . . . . . . 13:12
Saving Imported Data . . . . . . . . . . . . 11:18
SCBRANCH Separators . . . . . . . . . . . . 9:8
SCDIAG . . . . . . . . . . . . . . . . . . . . . . . . 13:6
12.0
UDA . . . . . . . . . . . . . . . . . . . . . . . . . . . 19:1
UDA Attributes . . . . . . . . . . . . . . . . . . . 19:5
UDA Catalogue . . . . . . . . . . . . . . . . . . . 19:3
UDA Creation . . . . . . . . . . . . . . . . . . . . . 2:1
Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:8
Units Tab . . . . . . . . . . . . . . . . . . . . . . . . 3:11
User Defined Attributes . . . . . . . . . . . . . 19:1
Index page iv
12.0