Professional Documents
Culture Documents
User Guide
AVEVA Solutions Limited
Disclaimer
1.1 AVEVA does not warrant that the use of the AVEVA software will be uninterrupted, error-free or free from
viruses.
1.2 AVEVA shall not be liable for: loss of profits; loss of business; depletion of goodwill and/or similar losses; loss of
anticipated savings; loss of goods; loss of contract; loss of use; loss or corruption of data or information; any
special, indirect, consequential or pure economic loss, costs, damages, charges or expenses which may be
suffered by the user, including any loss suffered by the user resulting from the inaccuracy or invalidity of any data
created by the AVEVA software, irrespective of whether such losses are suffered directly or indirectly, or arise in
contract, tort (including negligence) or otherwise.
1.3 AVEVA's total liability in contract, tort (including negligence), or otherwise, arising in connection with the
performance of the AVEVA software shall be limited to 100% of the licence fees paid in the year in which the user's
claim is brought.
1.4 Clauses 1.1 to 1.3 shall apply to the fullest extent permissible at law.
1.5 In the event of any conflict between the above clauses and the analogous clauses in the software licence under
which the AVEVA software was purchased, the clauses in the software licence shall take precedence.
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, or is validly licensed by, AVEVA Solutions Limited or its subsidiaries.
All rights are reserved to AVEVA Solutions Limited 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 Limited. Where such permission is granted, it expressly requires
that this copyright notice, and the above disclaimer, 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 Limited. The user may not reverse
engineer, decompile, copy, or adapt the software. Neither the whole, nor part of the software described in this
publication may be incorporated into any third-party software, product, machine, or system without the prior written
permission of AVEVA Solutions Limited, save as permitted by law. Any such unauthorised action is strictly
prohibited, and may give rise to civil liabilities and criminal prosecution.
The AVEVA software described in this guide is to be installed and operated strictly in accordance with the terms
and conditions of the respective software licences, and in accordance with the relevant User Documentation.
Unauthorised or unlicensed use of the software is strictly prohibited.
Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved. AVEVA shall
not be liable for any breach or infringement of a third party's intellectual property rights where such breach results
from a user's modification of the AVEVA software or associated documentation
AVEVA Solutions Limited, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom
Trademark
AVEVA and Tribon are registered trademarks of AVEVA Solutions Limited or its subsidiaries. Unauthorised use of
the AVEVA or Tribon trademarks is strictly forbidden.
AVEVA product/software names are trademarks or registered trademarks of AVEVA Solutions Limited or its
subsidiaries, registered in the UK, Europe and other countries (worldwide).
The copyright, trademark rights, or other intellectual property rights in any other product or software, its name or
logo belongs to its respective owner.
Schematic Model Manager User Guide
Revision Sheet
Contents Page
Pre-configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18:1
Schematic Model Manager in LEXICON . . . . . . . . . . . . . . . . . . . . . 19:1
Open the LEXICON Module with Schematic Model Manager Installed . . . . . . 19:1
Configure UDAs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19:1
UDA Catalogue Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19:3
View and Edit UDA Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19:5
View/Edit Attribute Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19:5
Appendices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:1
Appendix A: Regular Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:1
Alternation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:1
Grouping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:1
Quantification using Metacharacters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:2
Regular Expression Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:6
Appendix B: Release to 3D and the Schematic Database . . . . . . . . . . . . . . . . 20:8
Appendix C: XPath Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:9
Appendix D: Diagram Set File Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:11
XML File Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:11
Text File Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:13
Appendix E: Use Extracts to Manage Work and Issued Schematic Data . . . 20:15
MDB and Database Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:15
Manage Extract DB - PIDDATAEXTRACT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:18
Issue Schematic Data to DB PIDDATA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:19
Manage and Propagate Updates and Edits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20:21
1 Introduction
AVEVA Schematic Model Manager is used to import P&ID data into Schematic databases,
and to view and manage this data. P&ID data (which conforms to the ISO 15926 format)
may be exported from the AVEVA Schematic Model Manager Gateway, AVEVA P&ID and
from other supported P&ID systems.
AVEVA are committed to the use of open standards for the interchange of plant data
between AVEVA and 3rd-party products. ISO 15926 is an open standard for the
representation of process plant life-cycle information. This representation is specified by a
generic, conceptual data model designed to be used in conjunction with reference data:
standard instances that represent information common to a number of users, process
plants, or both. For further information and for details of which P&ID systems can feed data
into the Schematic model through Schematic Model Manager, contact your local AVEVA
sales office.
Once imported, P&ID data in the schematic database can be viewed and managed via a
hierarchical data explorer (the Schematic Explorer). This explorer includes facilities for
releasing selected schematic elements to the AVEVA Schematic 3D Integrator, for
integration with the 3D Design Model database. Facilities are also provided to view P&IDs,
both before and after import. A set of standard PDMS report templates for the schematic
database are also included.
Note: Only functionality specific to the Schematic Model Manager module is described in
the manual.
Many of the facilities of the Schematic Model Manager module are the same as those
in the Plant DESIGN module and Marine Hull and Outfitting module. Such facilities
are not described in this guide. Refer to the appropriate module documentation for
details of these.
1.4 Menus
Many of the Schematic Model Manager menu options are standard within the Engineering
product. Only the options specific to Schematic Model Manager are described.
1.4.1 File
View Accesses facility for previewing drawings before they are imported. Refer to Preview
Diagrams before Import.
Import:
The Import sub-menu access facilities for importing drawings and data.
Diagrams: Used to import a single diagram. Refer to Import Diagrams Facility.
Diagram Set: Used to import a diagram set. Refer to Import Diagram Sets.
Diagram Set Editor: Used to create and edit diagram sets. Refer to Create Diagram
Sets.
Excel Export: Displays the Excel Interface Wizard - Export utility used to export
data to Excel files. Refer to the Excel Import and Export section of Design Common
Functionality User Guide for further information.
Excel Import: Displays the Excel Interface Wizard - Import utility used to import
data from Excel files. Refer to the Excel Import and Export section of the Design
Common Functionality User Guide for further information.
1.4.2 Edit
Edit Members: Accesses the Edit Members dialog, used to create and editing elements.
Refer to Create and Edit Elements.
1.4.3 View
Catalog Search: This search facility provides direct access to the Plant or Marine
catalogue. Refer to Catalogue Search.
Diagrams: This option is used to view imported diagrams. Refer to View Imported
Diagrams.
Explorers:
The Schematic Explorer option is used to access the Schematic Explorer. Refer to
Schematic Explorer.
1.4.4 Tools
Diagram Connector: Accesses the Diagram Connector, which is used to manually connect
page connectors between imported diagrams. Refer to 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. Refer to Release and Un-Release Data.
Attribute Derivation Rules: Accesses facilities to set up rules that will be used to
automatically set the values of attributes during an import. Refer to View/Edit Attribute
Derivation Rules.
Attribute Mapping: Accesses facilities to map system/project specific attributes from the
source files to schematic or user-defined database attributes. Refer to View/Edit Attribute
Mappings.
GTYPE Mappings: Accesses facilities to edit the mappings between ISO15926
designations and corresponding GTYPE/SCSTYPE combinations. Refer to View/Edit
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. Refer to Configure the Source Data Dictionary.
Line List Options: Accesses facilities for specifying the settings which define how line lists
will be generated. Refer to Line List Configuration.
1.5 Toolbars
Many of the Schematic Model Manager toolbar options are standard within the Engineering
product. Only the options specific to Schematic Model Manager are described.
Used to create and edit diagram sets. Refer to Create Diagram Sets.
Used to set the release status of the current element, i.e. to release it to or un-release it
from the 3D model. Refer to Release and Un-Release Data.
Accesses the Diagram Connector, which is used to manually connect page connectors
between imported diagrams. Refer to Diagram Connector.
Access to the Excel Import and Export Tool is provided from the Import/Export Toolbar.
Import from Toolbar. Import is also available by selecting File > Import > Excel Import
from the main menu.
Export from Toolbar. Export is also available by selecting File > Import > Excel Export
from the main menu.
For further details on the use of this feature and for a worked example, refer to Design
Common Functionality User Guide for further information.
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.
For details, refer to Schematic Model Manager in LEXICON.
2 Pre-configuration
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 cross-
page 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:
6. The correct source data attribute must now be mapped to the UDA :Pmgdfltmatch, to
ensure that page matching occurs.
To do this, click the ellipsis option 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.
New Elements
3.2 General
The dialog lists all of the projects on the current PDMS installation for which Schematic
Model Manager options have been saved.
Click OK. The options are then copied from the selected project. A message is displayed
when the copy is complete.
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.
For example:
To view or edit the groups into which diagrams, off-line equipment, equipment and pipelines
are imported into, select the View/Edit option 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.
To select a different group for an element type, select the ... option at the end of the row. The
Select Group dialog is then displayed:
Browse for the required group and select the OK option. Click Cancel to close the dialog
without making any changes.
Repeat as required for each of the four element types.
Click the OK option to close the Import Destination Groups dialog and save any changes
that have been made. Click Cancel to close the dialog without saving changes.
For details of the format in which the coordinates must be entered, refer to PDMS or Marine
documentation.
4 User Options
User Options is used to set user specific Schematic Model Manager options. Select Tools
> User Options from the main menu to display the User Options window.
To change the default folder, select the Data Import row, and click the Modify option. The
Browse for Folder window is then displayed.
Browse for the required folder and select the OK option. The new location is then displayed
in the Default Location field.
When diagrams are imported, the values of attributes may be automatically set according to
user-defined rules, known as Attribute Derivation Rules. There are no default rules shipped
with Schematic Model Manager.
To view or edit Attribute Derivation Rules, select Tools > Attribute Derivation Rules from
the main menu to display the Attribute Derivation Rules window.
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.
Select OK to close the dialog and save any changes that have been made. Click the Cancel
option to close the dialog without saving changes.
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.
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:
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 ... option at the end of the Attribute filters field.
The Attribute Filters dialog is then displayed.
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, click OK to close the dialog. To close the
dialog without saving any changes, select the Cancel option.
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".
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 ... option at the end of the DB Expression field. The Edit
DB Expression dialog is then displayed.
Note: If the DB Expression field is left blank, or an invalid DB Expression is provided, the
rule will be shown in red in the Attribute Derivation Rules explorer, and the rule will
not be active.
10. To select an element type or types to which the rule is to be applied, select the ... option
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 click the > option to
transfer it to the Selected Values list.
To de-select an Element Type, select it in the Selected Values list and click the < option
to transfer it back to the Available Values list.
Use the >> option to move all Element Types to the Selected Values list. Use the <<
option to move all Element Types to the Available Values list.
Elements may also be selected/deselected by double clicking.
Click the OK option 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.
Click Cancel to close the dialog without saving any selections that have been made.
Attribute: NAME
Rule Name: (not defined)
...will be called:
SCEQUI/NAME
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.
To map system/project specific attributes from the source files to schematic or user-defined
database attributes, or to view existing mappings, use the Attribute Mappings dialog.
Select Tools > Attribute Mapping from the main menu in the Schematic Model Manager
module or the Attribute Mapping option from the Schematic Model Manager menu in the
LEXICON module to display the Attributes Mappings window.
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, click OK. To close the
dialog without saving changes, click Cancel.
Note: Changes made in the LEXICON module are not committed to the database until a
Save Work takes place.
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.
To select the SCTYPEs, click the ... option 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 click the > option to
transfer it to the Selected Values list.
To de-select an SCTYPE, select it in the Selected Values list and click the < option to
transfer it back to the Available Values list.
Use the >> option to move all SCTYPEs to the Selected Values list. Use the << option
to move all SCTYPEs to the Available Values list.
Click the OK option once the required SCTYPEs have been selected. The selected
SCTYPEs are then displayed in the Element Types field.
Click Cancel 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, select the ... option 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.
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, click the ... option at the end of the field. The Select Values
dialog is then displayed.
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.
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, click the ... option at the end of the Condition field and enter an XPath
Expression using the XPath Expression Builder dialog. Refer to 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.
5. In the Attribute Value field, either enter the name of the source file attribute.
Alternatively, click the ... option at the end of the field and enter an XPath Expression
using the XPath Expression Builder dialog. Refer to 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, select the ... option at the end of the field and enter an XPath Expression
using the XPath Expression Builder dialog. Refer to 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. Refer to Automatic
Setting of Attribute Units and Types.
7. 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.
8. 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, click the ... option at the end of the field. The Select Values dialog is
then displayed.
For more information on XPath expressions, refer to 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 (refer to Set up Mappings Using the XPath
Expression Builder Dialog - Examples).
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. Refer to Access
the Source Data Dictionary.
Each of the attribute nodes can be expanded to display the following nodes, which display
attribute metadata.
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.
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.
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. Refer to Set up
Mappings Using the XPath Expression Builder Dialog - Examples for details.
The XPath Expression Builder dialog is then displayed, with the SCDIAGRAM
element listed in the Source Dictionary pane.
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.
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 option then 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.
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.
4. Place the cursor in the Expression pane in front of the Tag attribute:
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 option then 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.
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.
The existing unit value in the Source Attribute Unit field is different from the default
value (or this field is blank).
If the Yes option is selected, the user may also be asked if the attribute type should be
automatically set.
If the Yes option is chosen, 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.
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.
GTYPEs identify the generic component types of the items that may be created in the 3D
database from the imported schematic items.
SCSTYPEs (not to be confused with SCTYPEs) are GTYPE sub-types, used to further
identify GTYPEs.
GTYPEs/SCSTYPEs are associated with schematic items by mapping them to the
ISO15926 designations of schematic items in the import files. Each ISO15926 designation
represents a component type in the schematic source.
The GTYPE value also affects the schematic database element created. If the GTYPE is set
to 'VALV', 'VTWA' or 'VFWA' then an SCVALV schematic element is created. In the absence
of a GTYPE value of 'VALV', 'VTWA' or 'VFWA' only SCINST, SCTUB and SCFITT
schematic database elements will be created inside SCSEGMENT elements.
To view or edit the mappings between ISO15926 designations and corresponding GTYPE/
SCSTYPE combinations, select Tools > GTYPE Mappings from the main menu to display
the Schematic Model Manager GTYPE Mapping window.
Note: 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.
Note: Lists of designations can be imported into these fields from a file, or from data
previously loaded into the current mdb (see below).
Browse for the XML file that contains the designations. Once the file is selected, click Open.
This option will not be active until an XML file has been selected.
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 click OK.
If the Yes option 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
option 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 selecting the Help option.
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.
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 refer to 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.
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 option 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 click Delete Selected
Row(s).
To delete all rules, click Delete All.
To close the dialog and save any changes, select the OK option.
To close the dialog without saving changes, select the Cancel option.
7.3.1 Example
The list of designators is as displayed below:
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, click OK. The import then takes place.
Select the Cancel option 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.
The dialog lists all the Schematic databases on the MDB. Select the required databases as
described above, and click OK.
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 Data Dictionary consists of attribute and element metadata. This data is
extracted from the import files (the same files from diagram data is imported - refer to Import
Diagrams).
This information is made available when configuring the attribute mappings using the XPath
Expression Builder dialog (refer to XPath Expression Builder Dialog), in order to reduce
the need for a user to understand the source file format and XPath syntax.
The dictionary is populated automatically when diagram data is imported with attribute and
element metadata relating to the component classes in the diagram data import files. The
dictionary may also be populated manually if required.
During a project life cycle, the Source Data Dictionary may need to be populated or updated
manually at the following times:
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.
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.
Using the standard PDMS/Marine Search facility, users may retrieve and view the line list of
the project, derived from the imported schematic data. For practical examples of line list
configuration and generation, see 20.7: Appendix G: Configuration of Line Lists using
Pseudo Attributes.
In addition simple schematic line and 3D line data, which does not conform to the schematic
connectivity model (does not contain a member hierarchy), and which may have for
example been imported from an Excel spreadsheet, can be compared based on derived
connectivity configured using this feature.
Before this can be done, additional configuration is required to specify which elements are
to be included in the line list/line list compare and to add rules for generating the text
displayed in the line list for the From and To attributes. In addition rules may be defined for
specifying how diagram names are displayed in the line list. For an example of the use of
Line List pseudo attributes with AVEVA Schematic 3D Integrator to compare a simplified 2D
connectivity model against a 3D model please see the Schematic 3D Integrator User Guide.
This configuration is carried out using the Line List Configuration dialog. Select Tools >
Line List Options from the main menu to display the Line List Configuration window.
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, and LLTO are pseudo attributes of the Schematic SCPLINE and
SCBRANCH elements, and of the Design PIPE and BRANCH elements. These pseudo
attributes can be used to configure output for inclusion in a line list. In addition they can be
used in conjunction with Schematic 3D Integrator to compare a simple Schematic Pipe and
Branch structure (for example one which has been imported from a spreadsheet, and which
does not use the Schematic connectivity model) against a 3D piping network.
LLDIAGRAMS is a pseudo attribute of the SCPLINE and SCBRANCH elements and is 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, click OK. To close the
dialog without saving changes, select the Cancel option.
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.
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.
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.
Supplied Rule
The ALL PIPEs rule (see the example above) is supplied with the product. It calculates the
LLFROM and LLTO attributes for all PIPEs using BRANCH attributes.
The selected SCTYPEs and TYPEs 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
or BRANCH 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, BRANCH or EndComponent.
If the rule is only to be applied to SCBRANCHs or BRANCHs with specific attribute values, a
filter can be set up in the Rule Filters section.
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 or PIPE, then the name of the SCPLINE or PIPE 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.
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.
Note: For the procedure for viewing diagrams once they have been imported, refer to View
Imported Diagrams.
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 click Open. The default location is specified on the
User Options dialog (refer to 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 option on the Diagram Viewer
toolbar:
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.
If multiple diagrams are being displayed, their tabs may not all fit in the viewer window. If this
is the case, next > and previous < options 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. Refer to 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.
View Diagram - used to view diagrams that have been imported. Refer to View
Imported Diagrams for details. Not used to preview un-imported diagrams.
The arrow to the right of the option is used to display a list of recently opened
diagrams. The maximum number of diagrams in this list is specified using the
Settings dialog. Refer to Diagram Viewer Settings.
Zoom In
Zoom Out
Zoom to Selection - zooms to a selected area of the diagram. Select this option
then select the area by left-clicking on one corner of the area and then dragging the
cursor to the opposite corner of the area.
Zoom to Window - zooms out so that the entire diagram is visible.
This option is also available from the menu that is displayed by right-clicking on a
diagram.
Auto Zoom On External Selection - toggles the mode for auto-zoom.
Set Bookmark - saves the current view - saved views are known as bookmarks
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
Settings - opens the Settings dialog for the Diagram Viewer. Refer to Diagram
Viewer Settings.
If the cursor is hovered over this option, a tooltip displaying information on keyboard
commands is displayed. See below.
Note: Bookmarks are not saved when the Diagram Viewer is closed.
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 option.
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.
11 Import Diagrams
There are two import facilities available in the Schematic Model Manager module, the
Import Diagrams facility (refer to Import Diagrams Facility) and the Import Diagram Set
facility (refer to Import Diagram Set).
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 Import
using PML).
Whichever method is used, after data has been imported, it must be saved to the database
(see Save 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
option on the SMM toolbar. Refer to the Plant DESIGN module or Marine Hull and
Outfitting module documentation for detailed information of this facility.
Browse for and select the XML file or files of the diagrams to import, and click Open. The
default import file location is specified on the User Options dialog (refer to Set Default
Import Location).
As part of the import procedure, depending on the settings specified on the Project Options
dialog (refer to 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 click OK. To terminate the import, click Cancel.
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. Refer to Release and
Un-Release Data.
The Import Progress dialog is then displayed. Refer to Import Progress Dialog.
Note: For guidance on creating or editing Diagram Sets using third party software, refer to
20.4: Appendix D: Diagram Set File Formats.
The Diagram Set Editor can also be used to initiate the import of Diagram Sets. Existing
Diagram Sets can also be selected for import via the File menu. See Import Diagram Sets.
Select either the option from the SMM toolbar or File > Import > Diagram Set Editor
from the main menu to display the Diagram Set Editor.
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 option:
Browse for and select the XML file or files of the diagrams to add to the Diagram Set, and
click Open. The default import file location is specified on the File Locations tab of the User
Options dialog (refer to 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 option:
A folder browser is then displayed. Browse for the required folder and click 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.
When all the required files have been selected, save the new Diagram Set by selecting the
Save Diagram Set option:
A save dialog is then displayed. Specify the name and location of the Diagram Set and click
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 click Open. The
contents of the selected Diagram Set are then displayed in the diagram list section of the
Diagram Set Editor.
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.
Select the Dismiss option 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.
Save changes to the Diagram Set by using the Save Diagram Set option:
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, click the option at the end of the field.
Whether or not this field is enabled is also specified on the Project Options dialog.
Alternatively, select either the option from the SMM toolbar or File > Import > Diagram
Set from the main menu to display the Open window.
Enter the comments and click OK. If the Cancel option is selected, 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.
Ready:
Cancelled: z
Running:
Completed: 3
Failed:
The Remaining column displays how many steps within task remain to be completed.
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 Save Imported
Data.
For example, the OPCs with the following data would be matched automatically (assuming
the connection is unique):
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.
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: Import Diagram
Set.
Note: Once diagrams have been imported, a Save Work must take place to save changes
to the database. See 11.5: Save Imported Data.
!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.
To save changes to the database using the user interface, either select the option from
the Standard toolbar, or the Save Work option from the File menu.
To save changes to the database using the command line, enter 'save work' at the
command prompt.
12 Diagram Connector
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.
Select the OPC on a diagram in the Diagram Viewer (see Diagram Connectors).
To select the required off-page connector from a list, select the ... option next to the Source
OPC field. The OPC Browser dialog is then displayed.
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.
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 then click OK.
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, select the Connect option.
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 OK to set up the connection anyway, or Cancel to abort the operation.
Once a connection is saved the Target OPC field is greyed out, the adjacent option is
disabled and the Connect option is replaced by a Disconnect option.
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.
The SCPLINEs 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 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.
The Match attributes 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 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.
See Automatic Matching of Off-Page Connectors for an explanation of match attributes.
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.
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.
Note: Groups may also contain other groups, which may in turn contain any of the
elements a higher level SCGROU may contain.
SCPLIN: Pipelines.
SCEQUI: Equipment.
SCSUBE: Sub-equipment.
SCNOZZ: Equipment nozzles.
SCELCO: Electrical connections.
SCOINS: Offline instruments.
SCTEMP: Templates.
SCPAGE: Schematic page.
SCIND: Schematic index.
SCSTEN: Stencils.
SCLOOP: Schematic instrument loop.
SCILIN: Schematic instrument line.
SCACTU: Schematic actuator.
The Highlight Changes option allows the user to highlight changes made. The user
can choose to either display the Latest changes or choosing to highlight the changes
between two sessions.
The Set Release Status option displays the Set Release Status window.
The Attributes option is used to view the attributes of the current element. Refer to
View 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. Refer to Diagram Connector.
If the current element is a diagram, the Show Diagram option is used to open that
diagram in the Diagram Viewer. Refer to View 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. Refer to View Imported Diagrams.
The New option displays a sub-menu from which elements can be created. Refer to
Create and Edit Elements.
The Edit Members options displays a sub-menu from which multiple elements can be
created and edited. See Create and Edit 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. Refer to
Rename Elements.
The Delete option is used to delete the current element and elements beneath it in the
element hierarchy. Refer to Delete Elements.
The Cut, Copy and Paste options are used to move and copy elements. Refer to Move
and Copy Elements.
Note: The attributes of the current element can also be viewed by selecting either the
Attributes or Attribute Utilities options from the View menu.
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.
Enter the new name of the element and click Apply. 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.
Note: If an element is deleted, all elements beneath it in the element hierarchy are also
deleted.
Delete 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.
Move Elements
Elements can be moved to different locations in the element hierarchy.
o move an element, right-click on the element and select the Cut 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 moved to the selected
location.
Copy 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 Rename 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.
Note: When an item on an imported diagram is selected, it becomes the current element
(i.e. is selected) in the Schematic Explorer.
Note: Changes made in the explorer are not saved into the database until a Save Work
takes place.
Note: For the procedure for previewing diagrams before they are imported, refer to Preview
Diagrams before Import.
1. Select the View Diagram option from the Diagram Viewer toolbar: .
2. The View Diagram dialog is then displayed:
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 option. 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.
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 0 or more characters
+ - matches 1 or more characters
? - matches only 1 character
# - matches a digit
[..] - matches 1 character against the given character set
7. To open a diagram, select it from the list and click OK.
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.
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.
Schematic Database elements can be created and edited using the Edit Members dialog.
This dialog can be used to efficiently create and edit multiple elements. Elements may also
be deleted using this dialog.
Note: Individual elements can be created, deleted and renamed from the Schematic
Explorer. See Create and Edit Elements, Rename Elements and Delete Elements.
Before accessing the dialog, set as the current element the element in the hierarchy which
is above those elements that are to edited or created, i.e. their parent or owner element.
To access the dialog, either select the Edit Members option from the Edit menu:
Or right-click on an element in the Schematic Explorer and select the Edit Members option.
Element data is displayed in a grid. The parent of the elements is displayed in the title bar.
If the current element is changed, the list of displayed elements may change to reflect this,
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. The Visible column allows the user to choose which
columns to display or hide. Check the required checkboxes to display the columns in the
grid.
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.
Clicking Add Standard Attributes allows the user to add all the standard attributes for
the current element.
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 options 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.
Using the arrows the user can change the database order of selected elements.
To change an order position, click to highlight the element and then click either Move
Selection Up or Move Selection Down .
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)>.
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 + option next to the group name. The
elements are then listed under the name. Select the - option to close the list.
Note that the fields within a group can be fixed, sorted, and filtered in the normal way.
Ungroup 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.
The list of element types on the menu is restricted to those that 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 options. 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.
The symbol for the selected operator is displayed on the option. The default operator
("Starts with") is indicated with a capital "A".
The other option 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 option 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 options.
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 options. 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 option at the start of the filter row: .
To remove the filter row, select the Enable Filtering menu option.
When a column is pinned, it is moved to the left-hand edge of the grid and remains fixed in
that position and visible when the grid is scrolled to the right.
When a row is pinned, it is moved to the top of the grid, and remains fixed in that position
and visible when the grid is scrolled to down.
Columns are pinned using the pin options in column headings.
Rows are pinned using the pin options in the row selection column to the left of the grid.
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, click the option again. The column or row is no longer pinned, but
will remain in the far-left or top position.
Note: This symbol: in a cell, which indicates that the element does not contain an
attribute or expression of this type, is not affected by these options.
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 click Dismiss.
To save the current grid configuration, select this option from the toolbar .
A dialog box will then open which lists the current set of element types to which the
configuration will relate. The user has the option of adding a comment.
Click the following option from the toolbar in order to view all the saved configurations for the
current user:
The following dialog box will open:
Note: That the layout files can be deleted from this dialog.
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.
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.
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, right-
click and select the Reset Cell Feedback option from the menu.
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 option: .
To place the new element(s) directly above the currently selected element in the list,
To place the new element(s) at the bottom of the list, select this toolbar option: .
3. Select the number of new elements to be created from this dropdown list in the toolbar:
To place the duplicate(s) at the top the list, select this toolbar option: .
To place the duplicate(s) directly above the currently selected element (the element to
To place the duplicate(s) at the bottom of the list, select this toolbar option: .
3. Select the number of duplicates to be created from this dropdown list in the toolbar:
Therefore, if the original element from which a duplicate is made originates from a
P&ID import, in order for a duplicate to be retained after an import from that P&ID,
such attribute values must be amended before an import takes place, e.g. the
XMP_ID value of the duplicate must be changed.
Note: If an element is deleted, all elements beneath it in the element hierarchy are also
deleted.
When an element is released (Release status set to ON) it is made available to the AVEVA
Schematic 3D Integrator i.e. the element in the Schematic database is made accessible to
the AVEVA Schematic 3D Integrator for integration with the 3D Design Model database.
If a simplified schematic piping structure is to be compared to a 3D model using Line List
Pseudo attributes then this comparison may be done without a release to 3D taking place.
For further details refer to Line List Configuration, and the Schematic 3D Integrator User
Guide.
The following types of element can be released:
SCDIAG
SCEQUI
SCOINS
SCSEG
When an element is released, all its child elements (i.e. the elements beneath it in the
database, such as the nozzles of an equipment item) are released as well. Such elements
cannot be released independently of their parent elements.
Elements can be automatically released when they are imported, depending on the settings
specified on the Project Options dialog (see Set Release Behaviour of Elements on
Import).
If they are not released during an import, elements can be instead be released using the
procedure described in this section. Previously released elements can also be un-released
using this procedure.
To release or un-release an element, or simply to view its release status, select it (i.e. make
it the current element) and either select the Set Release Status... option from the Tools
menu or click the option on the SMM toolbar.
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.
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.
Click the Set Status option to complete the changes to the release status of the selected
elements and close the dialog.
To close the dialog without implementing any changes, click Cancel.
The Schematic Model Manager Module includes the standard database Search utility. Refer
to the Plant DESIGN Module or Marine Hull and Outfitting Module documentation for details.
The Search utility in the Schematic Model Manager module includes a series of standard
Schematic Model searches. See Standard Searches.
The Catalogue search facility is also available. See Catalogue Search.
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 drop-down list:
You can then load one of the searches using the next drop-down list and selecting the
Search option:
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.
Selecting the Search option will then display the search results in a results window.
The specification reference of the current schematic element may be set via the Catalogue
Search, by using the Select option.
For further information regarding the operation and use of the Catalogue Search feature,
please see the AVEVA Diagrams user guide.
18 Reports
Reports can be run on the Schematic database. The following report templates are provided
for this purpose:
To run a report:
Select Tools > Reporting > Reports > Run from the main menu.
To view or modify a template:
Select Tools > Reporting > Reports > Modify from the main menu.
To create a new template:
Select Tools > Reporting > Reports > Create from the main menu.
To delete a report:
Select Tools > Reporting > Reports > Delete from the main menu.
Refer to the Reporting Reference Manual for further information.
The Schematic Model Manager facilities in the LEXICON Module are used to:
specify which User Defined Attributes (UDAs) are available in each schematic
database with which Schematic Model Manager operates,
configure UDA properties,
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, select the OK option. Continue at Configure UDAs. Otherwise click
Cancel.
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 click 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.
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 options 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, click the Select All option.
To uncheck the checkboxes for all optional UDAs, click the Deselect All option.
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 View and Edit 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 View/Edit 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.
Click the Undo option to undo any changes made since the dialog was opened.
Click Apply 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:
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.
20 Appendices
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.
Case
Regular Expressions are case sensitive, and capitalised metacharacters often have different
meanings to their lowercase equivalents.
By default regular expression matching is also case sensitive.
Component class names in an ISO15926 format import file are in Camel case. Camel case
is the practice of writing compound words or phrases, in which the words are joined without
spaces and are capitalised within the compound. For example:
BallValve
On importing an ISO15926 file, Schematic Model Manager converts component class
names from Camel case to upper proper case. The above example would be converted to:
BALL VALVE
All ISO 15926 Designator references made within Schematic Model Manager should be in
upper proper case.
All references made to ISO 15926 designators in auto complete rules, either in full, as in:
BALL VALVE
...or as part of a regular expression:
^BALL
Matching
To match a group of characters, surround the characters with parenthesis. For example:
(PINCH VALVE)
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.
For example:
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
//
// --------------------
.\P&ID Data\905680.xml
// end of file
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
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.
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.
The schematic data will now have been propagated to DB PIDDATA in PARENTMDB.
Login to PARENTMDB.
The schematic data from the PIDDATAEXTRACT DB in the EXTRACTMDB has now been
propagated to PARENTDB.
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.
For an explanation of the meaning of the prefix letters click the Prefix Info option.
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 option. The modified data will be propagated to DB PIDDATA in
PARENTMDB for general use and for use by AVEVA Schematic 3D Integrator.
Give the Status World a meaningful name and description in the Current Element Editor.
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).
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.
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 option to
show the Select valid status transitions dialog.
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.
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.
To use the new status definitions a new status layout must be configured.
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.
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.
To check the connectivity from P&ID to P&ID.
Each of these is supported by Schematic Model Manager. The following two sections
explain how these activities are supported.
The diagram will be made the current element. If the schematic explorer is open the
diagram element will be highlighted.
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.
Once the diagrams have been checked, drafting errors corrected and the diagrams re-
imported, 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.
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.
Again using the status controller the status of the diagrams is changed.
These pseudo attributes are configured using the Line List Configuration tool.
The line list related pseudo attributes are provided to allow users to:
Decide which piping-related elements are to be included on a line list report.
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.
The pipeline related hierarchy in the schematic database is:
SCPLIN
SCBRAN
SCSEG
Pipeline connectivity attributes exist at the SCBRAN and SCSEG level, but not at the
SCPLIN level. In order to produce a line list report based on SCPLIN or SCBRAN elements,
it is therefore necessary to determine the start and end of lines by examining the attributes
of the component SCBRAN and SCSEG elements.
This appendix describes how the pseudo attributes may be used in conjunction with the
Search Grid the and Excel Export functionality to produce a line list.
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 Line List Configuration.
Once configured, the line list related pseudo attributes will be populated each time they are
queried.
Right-click on a column heading, and from the right click menu that is then displayed, select
Column Setup
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.
These will include the LLFROM and LLTO derived values, including "Butt Welded Pipe Cap"
where appropriate.
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.
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.
The following example illustrates how a SCPLINE LLFROM and LLTO prefix value may be
conditionally set where that element has been sourced from an Excel import containing a
simplified piping connectivity model analogous to a line list.
The value of the UDA :Pmgdesc is used both to identify SCPLINE elements which have
been sourced from such an import, and to derive the LLFROM and LLTO prefix value. This
allows the LLFROM and LLTO attributes to be included in a simple line list based 2D/3D
comparison using Schematic 3D Integrator, to be identified.
The above rule will set the prefix of LLFROM and LLTO pseudo attributes for a SCPLINE to
LINELIST, where the element pseudo attribute :Pmgdesc is equal to the text value
LINELIST.
The Attribute Mappings for the project will be used to generate a list of attributes (UDAs and
Core) that had an Attribute Type associated with them. For each of these attributes the unit
that was used for the value during import will be determined using the units UDAs
(Pmguntsangle, Pmguntsarea, Pmguntsdist, Pmguntpres, Pmguntstemp, Pmguntvolm,
Pmguntweig), the project options units and the value of :pmgmodtime (time of import). In
12.1 units are managed centrally in the application and so there are units specified for all of
the possible Attribute Types. Any attribute on an element which was imported using a
different unit to this centrally managed unit will be reported as an upgrade candidate.
The message box will be shown if the units UDAs, which were mandatory in 12.0 SP6,
(Pmguntsangle, Pmguntsarea, Pmguntsdist, Pmguntpres, Pmguntstemp, Pmguntvolm,
Pmguntweig) are present on SCDIAGRAM elements in the project and have a value other
than "unset". It adds the Units Upgrade menu options to the Schematic Model Manager
Tools menu and the Lexicon Schematic Model Manager Menu.
If the user decides that the Units Upgrade is not required they can select the check box for
"Don't show this again" and the warning will no longer be shown and the Units Upgrade
Menu options will no longer be available. This information is stored in the Project Options
file.
On successful completion of Step 1 the user will see a message box which will give details
of the location of both the XML file and the log file produced and will also list the Dictionary
databases which have been identified. The foreign Dictionary databases will list separately
as these will need to be upgraded where they are mastered, it is suggested that the user
makes a note of all the Dictionary databases which are reported so that they can make sure
that Step 2 is run for each of them.
This step should be run for all Schematic Databases, using a particular Dictionary database,
before the Dictionary database is upgraded in step 2.
The user will be asked to select a file produced by Step 1 to use and will be shown a file
open dialog.
On successful completion of Step 2 the user will see a message box which will ask if they
have other Step 1 file which they want to use. Selecting Yes will show the file open dialog to
choose another file. Selecting No will take them to a summary message box which will list
all the files they have run for Step 2 and the Dictionary databases that have been
processed.
At the completion of Step 2 all the UDAs on Elements in the Schematic Databases will have
a unit associated with the value. For example a Temperature may now have the value
32degC when previously it just read 32. At this point none of the values for the attributes
identified in Step 1 have been converted so if your data was imported using degF and the
value was 78 the value would now be set to 78degC and is therefore incorrect. Step 3 will
convert the values so that the data is correct.
On completion of Step 3 all data has been upgraded to use the new units functionality in
12.1. The units UDAs which were mandatory in Schematic Model Manager (Pmguntsangle,
Pmguntsarea, Pmguntsdist, Pmguntpres, Pmguntstemp, Pmguntvolm, Pmguntweig) at 12.0
SP6 will be set to "unset" and the project options will be updated to show that the Upgrade
has been completed. The units UDAs will still be available but will no longer be maintained
or used by Schematic Model Manager. They are not included in the Schematic Model
Manager UDAs defaults at 12.1.
Index
U X
UDA . . . . . . . . . . . . . . . . . . . . . . . . . . . 19:1 XPath Expression Builder Dialog . . . . . . 6:7
UDA Attributes . . . . . . . . . . . . . . . . . . . 19:5 XPath Expressions . . . . . . . . . . . . . . . . 20:9
UDA Catalogue . . . . . . . . . . . . . . . . . . . 19:3
UDA Creation . . . . . . . . . . . . . . . . . . . . . 2:1
Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:7
Use Extracts to Manage Work and Issued Sche-
matic Data . . . . . . . . . . . . . . . . . . . . . . 20:15
Use the Explorer . . . . . . . . . . . . . . . . . . 13:6
Applying a Filter . . . . . . . . . . . . . . . 13:8