Lexicon User Guide
Lexicon User Guide
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.
LEXICON User Guide
Revision Sheet
Contents Page
User Guide
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Assumptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Guide Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
DBVWWL : Database View World . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
DSTWLD : Datasheet Template Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2
DSXWLD : Bound Attribute World . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2
REVCWL : Revision Configuration World . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2
STAWLD : Status World. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2
UDETWLD: User Defined Element World . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2
UWRLD : User Defined Attribute World . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2
Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
Lexicon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
Edit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2
Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2
Modify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:3
Pipe Stress Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:3
Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:3
Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1
Dictionary Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1
Edit Members . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:2
Current Element Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:3
Database Views Editor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:4
Graphical View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:5
Nodes and Links. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:6
Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:8
Command Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:8
Datasheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:1
Datasheet Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:1
Datasheet Template World. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:1
Datasheet Template Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:2
Datasheet Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:3
Revision Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:6
REVCWL: Revision Configuration World . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:6
REVCGP: Revision Configuration Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:7
1 Introduction
LEXICON is supplied as a module within the AVEVA suite of products and allows the system
administrator to:
Create and modify User Defined Attributes and User Defined Element Types.
Group similar elements for administrative ease.
Delete elements.
View all available elements in a Explorer window.
Create and modify Database Views.
Create and modify the schema for distributed attributes.
1.1 Assumptions
The LEXICON User Guide has been written for System Administrators.
It is assumed that:
Users are familiar with the software at a System Administrator level.
Access to the LEXICON GUI is normally restricted to FREE users only.
The commands underlying the interface are described in the LEXICON Command
Reference Manual.
Toolbar gives quick access to all the tasks associated with the
creation and modification of the module
User Defined Attributes describes the creation and attributes of the User Defined
Attributes elements.
User Defined Element describes the creation and attributes of the User Defined
Types Element Types elements.
User System Defined describes the creation and attributes of the User System
Attributes Defined Attributes elements.
2 Overview
The LEXICON module can also be launched from the main AVEVA PDMS Login window.
To enter the LEXICON Module in the Design Module, from the main menu bar, click Design
> Modules > Lexicon.
To enter the LEXICON Module in the Engineering Module, click AVEVA Plant > Engineer
> Diagrams SP XX.XX > Lexicon.
2.1 Features
The LEXICON Module allows the system administrator complete control of the
administration of the Dictionary (DICT) database of a project.
Before a project can use any of the resources covered in this guide a DICTIONARY (DICT)
database must be created as part of a Multiple Database (MDB), which is done with the
use of the ADMIN module in the same way as for any other type of database. For more
information, refer to Administrator User Guide.
Elements within the LEXICON module can be changed or deleted during the course of a
project. The dictionary contains all the definitions for a project and if data is to be transferred
between projects the dictionary must be transferred as well. The data output and project re-
configuration functions can be used to do this. A user may create elements within other
databases such as DESIGN from definitions within the LEXICON database, however if the
LEXICON database is removed then these elements will become unrecognised in the
DESIGN database.
Note: A familiarity of common navigation practices within the software is recommended but
not essential.
2.2 Hierarchy
As with all elements in the software, all the LEXICON module elements are owned by other
elements, therefore elements must be created in strict order. The hierarchy for the
LEXICON module is displayed in the Dictionary Explorer.
Below the Dictionary world level in the LEXICON module, the LEXICON specific elements
are:
present and allow the edit of selective data from several elements allowing the information
displayed to be configured for a users working practices.
3 Toolbar
The toolbar gives quick access to all the tasks associated with the creation and modification
of the LEXICON module.
Depending on the selections made from the toolbar, the user will be presented with further
windows prompting for user input and options allowing the workflow to continue.
In this section, the user is introduced to the toolbar, specific tasks are described in later
sections, refer to Guide Structure.
The toolbar for the LEXICON module is automatically displayed in the top left hand corner of
the screen, once the module has been entered.
3.1 Lexicon
Quick access to the Save or Get Work options, open another module or exit the LEXICON
module.
3.2 Display
Allows the user to open or close the application windows in the LEXICON module, from the
main menu bar, select Display, the Display menu is displayed:
Search Results Opens the results of any search in the generic Search
Results window. for more information refer to Schematic
Model Manager User Guide.
3.3 Edit
On a typical project, it may be necessary for a system administrator to edit the elements in
the Dictionary Explorer window. From the main menu bar, select Edit the Edit menu is
displayed:
Note: Dependent upon the actions carried out, several unavailable commands will be
displayed on the Edit menu.
Paste Paste an element into the hierarchy below the current element. (The
element is named as Copy(1) of XXX).
Validate Compiles the dictionary definitions which update the application and
display messages about the success or failure. The validate
functionality is particularly relevant to UDA definitions and must be
carried out to display up to date information about UDAs within the
application windows.
3.4 Create
Displays a drop-down menu listing all the Create options available for the selected element.
The elements available for selection are dependant upon the Current Element (CE).
3.5 Modify
Displays a drop-down menu listing all the Modify options available for the selected element.
From the main menu bar, select Modify the Modify menu is displayed. Dependent upon the
actions carried out, several unavailable commands are displayed on the Modify menu:
Lock All Locks the current element and all of its members.
Unlock All Unlocks the current element and all of its members.
Note: It is important for users upgrading from older versions of PSI to run this upgrade on
existing data.
3.7 Help
Displays a drop-down menu listing all the Help options.
3.9 Datasheets
Displays the Settings window, which allows the user to create and control datasheet
templates. Refer to Datasheets for more information.
4 Window
All of the tasks that a system administrator is required to do, can be carried out within the
LEXICON window.
By default, the LEXICON window is split into two window panes. To the left is the Dictionary
Explorer and to the right the Current Element Editor. An empty work area provides space
for additional application windows available from the application menus.
Depending on the type of element currently selected, a different set of options will be
available for selection.
To display additional Dictionary Explorers, click to highlight the element in the hierarchy.
Right click and from the drop-down menu displayed, select New Explorer. An additional
Dictionary Explorer is displayed to the right of the Current Element Editor window,
displaying the selected element.
Elements can be created and edited with the Edit Members functionality. For more
information refer to Schematic Model Manager User Guide.
To display the Database Views Editor, from the main menu bar select Display > Database
Views Editor, for more information, refer to Database Views Editor.
If no specific graphical views have been opened during the current LEXICON session then
the Graphical View pane remains empty. If one or more views have been previously open
during the current LEXICON session, then these views will be restored when the Graphical
View pane is re-opened. Views are not maintained across LEXICON sessions. Individual
view tabs can be closed, to close the current view, select close tab at right on the tab
header.
A progression is shown from left to right, where the chevrons are used to progressively
expand the node to show more detail. At right a node is shown with many compartment
items, each having an associated value. In this case they are the attributes and values of
the PID UDA type.
Selection of single items can be achieved with a left-click in the Graphical View window.
Multiple selections can be achieved by using bounding outline, selected nodes and links are
shown with handles. Selected items in a node compartment are shown by a change in the
item's background colour.
Nodes and links can be modified by dragging selection handles. The width of a node can be
adjusted by dragging the left and right handles. Node height cannot be adjusted. Likewise
the route of a node can be modified by dragging a node's selection handle. The node's
attachment points to a node are fixed, however, modifications to nodes and links are
temporary.
Selected items can be copied to the clipboard in the usual manner. The view's graphics can
therefore be pasted into another application, such as an image or document editor. For
example: press Ctrl-A to select all the items then press Ctrl-C to copy the graph to the
clipboard. The selected items can then be pasted into the application of choice.
A selected node or compartment item can be used to open a new Graphical View window,
right-click on the selected node or compartment item, select Navigate to a new Graphical
View window for the selected node or compartment item is displayed.
4.4.2 Layout
The arrangement of nodes and links in a graphical view (the layout) is determined
automatically when the view is opened. The layout can be modified by dragging selected
items, layout modifications are temporary. Either individually selected nodes can be moved,
or groups of nodes can be moved together by dragging a multiple selection. When the
dragged nodes are released, the path of the affected links is recalculated automatically.
To return to the initial automatic layout, right-click on the graphical view background and
from the displayed menu, select Layout.
For a detailed explanation of the LEXICON command line refer to the LEXICON Command
Reference Manual.
The Database Views Editor gives the user quick access to all the tasks associated with
Database View definitions. All Database Views Editor functionality is provided through
selections made by the system administrator in the LEXICON window.
To display the Database Views Editor window, select Display > Database Views Editor
from the main menu bar.
By default the Database Views Editor is populated with the Project Views which are the
Database Views defined in the Dictionary databases.
Project Views All of the Database Views that exist in the LEXICON
hierarchy.
User Views The Database Views for the current project as defined for
this user, these views are stored in %PDMSUSER%.
Additional Definition Sets can be created or added into the list with the use of the toolbar
provided.
5.1.1 Toolbar
The View Definition Set toolbar provides the ability to manage the Definition Sets
available for selection from the drop-down list. The user has the ability to create, load or
delete any file based definitions.
Close Closes the currently selected file based Definition Set, the
default Definitions Sets cannot be closed.
New Displays the Create Definition Set window which allows the
user to create a new Definition Set.
Delete Deletes the currently selected Definition Set from the file
system and removes it from the list.
The user can select from the drop-down menu which View Definition Set to use.
The user must now input a Name and Description for the new Definition Set.
The location of the definition file must now be identified. Click the icon next to the Filename
field to display the Save Definition File As window.
Navigate to the required location, name the file and click Save, or click Cancel to return the
user back to the Create Definition Set window without saving the file.
The Filename field in the Create Definition Set window is automatically populated.
Click OK to create the new Definition Set or Cancel to discard any inputs and close the
Create Definition Sets window.
5.2 Views
The Views pane of the Database View Editor window displays the Database Views and
Database View Sets in the selected Definition Set, subject to the criteria selected from the
Database Types Filter. The filter allows the user to restricts the information that is displayed
in the Views tab, for example: only the information relevant for the selected database types
are displayed.
When a Database View or Database View Set is selected from the View tab, the View
Properties, Data Sources, Columns and a Preview are displayed in the View Detail pane
on the right hand side of the Database Views Editor. Each time a new Database Views or
Database View Sets is selected, the information displayed in the View Detail pane is
automatically updated to reflect the change.
The user can manage the Database Views and Database View Sets with the use of the
right click menu in the View tab:
New > View Creates a new Database View in the current context
New > View Set Creates a new Database View Set in the current context
Rename Allows the user to change the display name for the
Database View or Database View Set, this is not the name
of the definition in the Dictionary database.
Navigate to Sets the Current Element (CE) to the definition element for
the selected item, this is only enabled when the Project
Views Definition Set is selected. The item is then selected
in the Dictionary Explorer if it is displayed.
Cut Places the selected item on the Database Views Editor clip
board ready for a Paste operation. The item is moved when
the Paste operation is selected. Items on the Database
Views Editor clip board are not available in other contexts
such as the Dictionary Explorer. An item can be Cut from
one Definition Set and Pasted into another.
Copy Copies the selected item onto the Database Views Editor
clip board ready for a Paste operation. An Item can be
copied from one Definition Set into another
A Database View Set is a set of Database Views that have been defined for a related
purpose and can be used to group Database Views for easy navigation. A Database View
belongs to a Database View Set if it is a member of the Database View Set definition or if
its DBVWSTREF attribute refers to the Database View Set.
Note: The DBVWSTREF attribute is not editable when the Database Views Editor is
being used.
The user can now modify the display name and the description of the Database View Set.
User-defined name The display name for the Database View Set, the name
needs to be unique. The display name is displayed at the
top of the View Set Detail pane by the padlock for easy
reference.
View Properties
Supports modification of the primary attributes of a Database View to define the display
name and the elements that the Database View rows are based on.
Data Sources
Defines rules for database element creation and navigation steps to additional information
elements such as an items catalogue specification.
Columns
The columns displayed to the user for each Data Source, these can be attribute values or
expressions evaluated on the selected Data Source.
Preview
A grid showing column data defined by the Database View. The grid only shows data that
the current user has access to. By default data access is restricted in LEXICON so this will
appear as an empty grid for most element types.
The user can now modify the primary attributes of a Database View and the elements that
the Database View rows are based on.
User-defined name The display name for the Database View, the name needs
to be unique or the Database View will be listed with a
derived name of the form Tablen. The display name is
displayed at the top of the View Detail pane by the padlock
for easy reference
Element types The types of the elements to include in the Database View.
Attribute Filters
Attribute filters restrict the contents displayed in the Database View to only the elements
that meet the stated criteria. For a filter to be active it must have the Attribute Operator and
Value columns completed.
To display the Attribute filters, from the Attribute filters part of the View Properties tab,
click Expand. All the elements that meet the criteria of the Attribute filters are displayed.
Pseudo attributes and hidden attributes are not displayed in the right click drop-down menu
on the Attribute column but can be entered in the Attribute cell.
Expression Filters
Expression filters restrict the contents displayed in the Database Views to only the
elements that meet the stated criteria. For an expression filter to be active it must have a
valid expression that evaluates to a Boolean/LOGICAL result.
From the Expression filters part of the View Properties tab,click Expand. All the elements
that meet the criteria of the Expression filters are displayed.
For the purposes of this user guide, an example Data Sources hierarchy is described:
If a Database View is created that has the Element Types (ELEL) attribute set to UDA
then the node at the top of the Data Sources tree represents the collection of UDA
elements.
If a SRCELEMENT node is created below this with its Expression set to OWNER, then
the Source Element represents UGROs, the OWNER elements of the selected UDAs
Since SRCELEMENTs are allowed to contain SRCELEMENTs navigation steps are
incremental. Another node with its Expression set to OWNER represents UWRLs, the
OWNERs of the OWNERs of the selected UDAs.
The NAME attribute is present on UDAs, UGRO and UWRLs. Creating an Attribute
column for the NAME attribute and selecting different Data Sources changes the
element the NAME attribute is being displayed/edited on.
From the explorer displayed in the Data Sources tab, the user can create a new Data
Source, delete, navigate to, cut, copy or paste a Data Source from the right click menu.
Navigate To Sets the Current Element (CE) to the definition element for
the Data Source, this expands the Dictionary Explorer if
displayed
Cut Places the selected item on the Database Views Editor clip
board ready for a Paste operation. Pasting the item moves
it.
Paste Pastes the item on the Database Views Editor clip board
into the current context
Properties
The Properties part of the Data Sources tab displays the significant properties of the
selected Data Source. If a DBVW is selected then only its description can be modified on
the Data Sources tab. The Expression field must be filled out with a valid expression for
SRCELE Data Sources to define the element navigation.
From the Expression drop-down list, select an expression from the list of available
expressions.
Creation Rules
The creation rules define the information to create an element when requested and set up
the initial state of the element created by setting attribute values and assigning status. The
user must populate the Creation Rules part of the Data Sources tab to make sure
additional information is not required during the element creation.
Auto assign or create owner - To create the new element in the first available owner or an
ownership hierarchy if one isn't present, click to select the Auto assign or create owner
checkbox.
Note: As ownership is usually significant for an element, this must be used with caution.
Owner Expression - In the Owner Expression field, enter the OWNER for the element
being created, if left unset then the user is prompted for the OWNER. The expression can
be that returns either the element such as id /Equipment or a string expression that
returns the name or identity of the element such as /SITE_' + $!Param2. For more
information on the expressions, refer to Create Parameters.
Type Expression - In the Type Expression field, enter a string expression returning the
type of the element to create such as ';MyUdet'. If this isn't set then the user is prompted for
the type of element to create.
Additional rules can be used to request information from the user (Parameters), set attribute
values at the time of creation and assign status to the newly created element.
Create Parameters
Parameters are user defined variables that can be used in the create rule expressions. A
parameter can either be a value derived from an expression or information requested from
the user. If the Expression field is left unset then the user is prompted at the time of
creation. When using a parameter it should be treated as if the value is being substituted
into the expression before execution rather than as a PML variable.
The Create Parameters part of the Data Sources tab is populated with the following
attributes:
UDA Type The data type for the parameter, this affects user entry for
the parameter and not the parameter use.
If a parameter is used to request the fluid from a user, the attributes in the Create
Parameters part of the Data Sources tab must be populated as follows:
Expression
Required True
The value entered by the user at the time of creation can be used in the Owner Expression
and in attribute rule as follows:
Owner Expression '/Equipment_' + '$!Fluid'
Attribute Rule
Attribute :Fluid
Expression $!Fluid
Note: The example expressions contains $!Fluid in '' characters since the value is
substituted into the expression before the expression is evaluated. The parameter is
not a PML variable.
Attribute Rules
The Attribute Rules define the initial values of attributes when the element is created.
These can be fixed by specifying expressions to derive the value or the user can be forced
to enter a value at the time of element creation.
The Attributes Rules part of the Data Sources tab is populated with the following
attributes:
Status Rules
The Status Rules assign the identified status definition to the element on creation or
prompts the user for a status definition to apply if the status definition is not defined.
The Create Status part of the Data Sources tab is populated with the following attributes:
Status Definition Ref The status to assign to the created element, if left unset
then the user is prompted.
5.3.3 Columns
The Columns tab displays the columns definitions for the Database View. A column can be
based on a database attribute or expression. Attribute columns are editable in the Database
View by the user unless the Readonly property is set. Columns based on expressions are
not editable by the user when accessed in the data grid. It may be helpful when managing
the columns to drag the Data Source field onto the grouping section in order to quickly see
what columns are defined from the different Data Sources.
From the View Detail pane of the Database Views Editor window, select the Columns tab.
The columns definitions for the Database View are displayed.
The drop-down list at the top of the Columns tab control contains the all the Data Sources
defined in the grid. The functionality of the toolbar which contains the New, Add Standard
Attributes and Add Status Column options are affected by which Data Source is selected
from drop-down list.
Add Standard Attributes Adds all of the common attributes for the elements of the
selected data source. Add Standard Attributes is enabled
if columns don't already exist for all of the common
attributes and the element type for the selected Data
Source can be identified.
Add Status Column Adds a column to display the status for the selected Data
Source. The Qualifier must then be set for the column to the
status definition to present to the user.
The fields in the grid are enabled/disabled depending on whether the column is based on an
attribute or an expression. The field shave the following meaning:
Column Name The default display name for the column, if unset then the
display name is derived from the attribute or the expression
used to get the column value. If duplicate names are
entered then the first column will have the requested name,
subsequent columns will have an index added (for example:
'Name (2)')
Description The data type of the column, this is known for the columns
based on attributes but must be set for columns based on
expressions. If set to the wrong type then errors will be
shown when the data is accessed.
Type The data type of the column, this is known for the columns
based on attributes but must be set for the columns based
on expressions. If set to the wrong type then errors are
shown when the data is accessed.
Read Only If set the user is not able to modify the values in the column
5.3.4 Preview
The Preview tab displays the data defined in the selected Database View definition. The
preview can only display the data for elements the user has access to. In LEXICON, the
contents of the grid may be significantly limited since LEXICON only has access to elements
in Dictionary Databases.
It is advised that a user configuring their Database Views must define the Database View
in their User Views in the module that they wish to use the view. Once the Database View
is defined and tested it can be copied or moved from the User Views to the Project Views
from within the LEXICON module. The Database Views Editor is available in LEXICON
and Tags (for TAGS ADMIN users) and can be added using the customisation menus to all
other modules.
From the View Detail pane of the Database Views Editor window, select the Preview tab.
The preview of the data for the elements the user has access are displayed.
User Defined Attributes (UDAs) enables the system administrator to add new attributes to
any element in the databases of a project. These UDAs are created as elements in the
LEXICON database inside the project. Because LEXICON databases are project specific, it
is possible to define attributes to suit individual project requirements.
Once defined, UDAs may be accessed in much the same way as normal attributes,
including setting values, querying and reporting upon these values. Utilities such as the
Data Output and Project Reconfiguration functions treat UDAs as they would other
attributes. UDAs can also be used in expressions.
For a full explanation of the structure of a Dictionary database refer to the LEXICON
Command Reference Manual.
Note: When a new element is created in the database hierarchy using the Dictionary
Explorer the Current Element Editor will automatically update to display the
attributes for that element, these will initially be empty.
After the creation of a new UDA World, the following attributes in the Current Element
Editor must be populated:
Name Enter a valid name for the UDA World in the text box. Special
characters are not allowed.
Description Enter a brief description of the UDA World (can contain up to 120
characters of text).
The Dictionary Explorer will automatically update to show the specified name for the
element.
Note: When a new element is created in the database hierarchy using the Dictionary
Explorer the Current Element Editor will automatically update to display the
attributes for that element, these will initially be empty.
After the creation of a new UGRO Group, the following attributes in the Current Element
Editor must be populated:
Name Enter a valid name for the UDA Group in the text box. Special
characters are not allowed.
The Dictionary Explorer will automatically update to show the specified name for the
element.
Note: When a new element is created in the database hierarchy using the Dictionary
Explorer the Current Element Editor will automatically update to display the
attributes for that element, these will initially be empty.
After the creation of a new UDA, the following attributes in the Current Element Editor
must be populated. Dependent on the attribute chosen, other related attributes are enabled
or disabled accordingly.
Name Enter a valid name for the UDA in the text box. Special characters
are not allowed.
Lock From the drop-down menu, select True to lock the UDAs attributes.
Abbreviation Specifies the minimum number of characters that the attribute name
Length can be shortened to when used in commands and attribute entry
fields. The abbreviation must be less than or equal to the number of
characters in 'User Defined Name' (UDNA). The shortened name
must still define a unique name for the attribute.
UDA type From the drop-down menu, select a UDA type. Dependant on the
type chosen, other related fields will be disabled accordingly. The
type options are:
integer
real
text
logical
reference
word
position
orientation
direction
datetime
UDA Length For attributes with a 'UDA Type' of 'Text' or 'Word', this specifies the
maximum number of characters that are permitted in the attribute.
For attributes with a UDA Type of 'Position', 'Direction', 'Orientation'
or 'Datetime', this must have a value of 1, For other attribute types
this specifies the number of values in an array.
Element types The list of element types that the attribute is available on. Up to 100
element types can be set. Enter a value directly in the Element
types field or click the icon to display the Select element types
window which can be used to make a list of Element types.
UDA Default Specifies the default value for the UDA to be used if the attribute
hasn't been set. All UDA definitions must provide a default value to
avoid errors being displayed in the event that the attribute is used in
expressions before being set by the user.
Pseudo attribute Indicates whether the attribute is a stored value or whether its value
is to be derived by software. If set to true software must be written
to calculate the value of the attribute. For information on how to
write software for Pseudo attributes, refer to NET Customisation
User Guide
Indexed UDA If set to true this creates an index of the UDA values to enable the
efficient retrieval of elements. The index must be set to help
performance if an attribute is used extensively for attribute filters in
searches, database views or collections. The index must not be set
on all attribute since it will increase database size and management
overheads.
User Defined Enter a name for the UDA that will be displayed in the modules.
Name Special characters are not allowed. To know more about Names
and UDA Names, please refer to the LEXICON Command
Reference Manual.
Reporter Text Specifies the name used for the attribute when presented to the
user. The name must be set so that the user is presented with a
meaningful attribute names instead of the colon prefixed attribute
name (UDNA).
UDA Category Enter a value to allow the UDA to be grouped together on the
attributes form within other modules.
Hidden Holds a logical value, setting this to true will indicate that the UDA
will be hidden from the Q ATT command and from the attribute
form within other Modules. Querying of the individual UDA will not
be effected by this setting.
Hyperlink Holds a logical value, setting this to true will allow the text value of a
UDA to contain a path to the external file.
Connection Holds a logical value, setting the value to true will signal that the
UDA is a connection in the reference list.
Protected Holds a logical value, setting to True will not allow the attribute in a
protected database to be viewed. Access to protected UDAs will be
granted to appware encrypted with a suitable password.
Units Specifies the Dimension for the attribute, if the attribute has a UDA
Type of Real. If the units are set then the attribute becomes unit
qualified with appropriate units for the selected dimension.
Length An integer value from 1 to 120 can be set in this field to denote UDA
Length. The length option is applicable only for UDA types REAL,
INTEGER, TEXT, WORD and REFERENCE.
Valid values Depending on the type of element selected enter a valid numeric
value, value range or text strings.
For numeric ranges separate minimum from maximum value with a
single dash (-).
Multi-word strings must be enclosed in either single quotes (') or
apostrophes (`) or vertical bars (|).
Single-word strings do not have to be enclosed.
All items must be separated by commas or white space.
For example: if the UDA Type is set to real or integer then enter a
numeric range such as 5-9.
To simplify editing valid values click the icon to open the Select
Element Types window.
Limits or Valid This attribute holds an optional flag, setting the attribute to true
values indicates that the attribute can have a value outside the valid values
or range.
To choose an element type from the Available element types: pane of the Select element
types window, click an entry to highlight the required element, click Add to list.
The element types are automatically displayed in the Chosen element types: pane of the
Select element types window. To remove an element type, click to highlight the required
element, click Remove selected.
Click OK to close the window and pass the selected element types back to the Current
Element Editor or Cancel to discard any inputs.
If a valid value has already been set this will be displayed in the input area allowing the user
to edit the value, alternatively input a new set of values. Values can be removed by simply
deleting the text.
Click OK to close the Edit valid values window and populate the Valid Values field of the
Current Element Editor window or click Cancel to discard any inputs and close the Edit
valid values window.
List Views
For this example, the selected UDA element has only one dependent element. The
PMGHeight node represents the UDA element, the SCNOZZLE node has a link to the UDA
element.
The link (shown as a open head arrow) represents a dependency of the source node on the
target node. In this case the dependency is that the SCNOZZLE element has a UDA
attribute of the type PMGHeight.
In this example: when the UDA element can be applied to more than 20 elements then the
relationships between the elements are displayed as follows in the graphical view.
The UDA node is shown at the top and the dependent element nodes are shown in a
vertical list below. The view only displays the first 4 dependent elements, use the scroll bar
to view the other dependent element nodes in the graphical view.
Spider View
In this example: when the UDA is applied to less than 20 elements, the UDA is shown where
11 elements are dependent on the UDA. The relationships are displayed as follows in the
graphical view.
The UDA node is at the centre and is surrounded by the dependent element nodes, this is
known as a spider layout.
Within the software the standard set of elements are often used for a variety of purposes. A
User Defined Element Type (UDET) allows an element to be created with a more
meaningful name, for example an administrator could create clearly defined sub types such
as Pipe Lagging, Pipe Painted and Pipe Heated.
For a full explanation of the structure of a Dictionary database refer to the LEXICON
Command Reference Manual.
Note: When a new element is created in the database hierarchy using the Dictionary
Explorer the Current Element Editor will automatically update to display the
attributes for that element, these will initially be empty.
After the creation of a new UDET World the following attributes in the Current Element
Editor must be populated.
Name Enter a valid name for the UDET World in the text box. Special
characters are not allowed.
Description Enter a brief description of the UDET World (can contain up to 120
characters).
The Dictionary Explorer will automatically update to show the specified name for the
element.
Note: When a new element is created in the database hierarchy using the Dictionary
Explorer the Current Element Editor will automatically update to display the
attributes for that element, these will initially be empty.
After creating a new UDET Group the following attributes in the Current Element Editor
must be populated.
Name Enter a valid name for the UDET Group in the text box. Special
characters are not allowed.
The Dictionary Explorer will automatically update to show the specified name for the
element.
After the creation of a new UDET, the following attributes fields in the Current Element
Editor must be populated. Some attributes are enabled or disabled when the values of
related attributes are set
Name Enter a valid name for the UDET in this text box. Special characters
are not allowed.
User-defined Enter a name for the UDET. This is the name that will be displayed
name in the other modules. Special characters are not allowed.
To know more about Names and UDET Names, refer to the
LEXICON Command Reference Manual.
Owner types The Owner types list is automatically populated with the list of valid
owners when the Base Type is selected.
To remove owners from the list, click the icon to display the Select
Owner Types.
Member types The UDET Members list is automatically populated when the Base
Type is selected.
To remove members from the list, click the icon to display the
Select Member Types.
Hidden The Hidden Attributes list is automatically populated when the Base
Attributes Type is selected.
The user can selectively hide attributes from the list and/or re-add
them if required and also hide attributes from the list by clicking to
display the Select Hidden Attributes.
To choose a base type, click an entry to highlight the required element type.
Click OK to close the window and pass the selected base type back to the Current Element
Editor or Cancel to discard any inputs.
The Select Owner Type window allows the system administrator to select which base types
are owners of the UDET.
To associate or disassociate an owner check or uncheck the relevant box to the left of the
base type.
To associate or disassociate all owners, click Select/Deselect All.
Click OK to close the window and return the values to the appropriate field in the Current
Element Editor or Cancel to discard any inputs.
To associate or disassociate a member check or uncheck the relevant box to the left of the
base type which you do not want to be an member of the UDET.
To associate or disassociate all members, click Select/Deselect All.
Click OK to close the window and return the values to the appropriate field in the Current
Element Editor or Cancel to discard any inputs.
To hide an attribute check the relevant check box to the left of the attribute which you do not
want to be visible when using the UDET.
Click OK to close the window and return the values to the appropriate field in the Current
Element Editor or Cancel to discard any inputs.
For this example: the relationships displayed are a node for the selected
UDET,:VALVCHAR and a link from it to another node, which is its base element type
XPITEM.
The link (shown as a filled head arrow) represents a parent-child relationship and begins on
the child and points to the parent.
Other UDETs that have the same base element as the selected element are also shown in
the view. The layout of the nodes is intended to show an inheritance hierarchy. The base
element is shown at the top, the UDET elements based on it are aligned below.
When the UDET has Distributed Attributes the Distributed Attributes Graphical View can
be displayed by right-clicking the UDET and selecting Navigate to from the displayed
menu. The Distributed Attributes View is displayed in a new tab, for more information on
the Distributed Attributes View, refer to Distributed Attributes Graphical View.
A User System Defined Attribute (USDA) allows the administrator to change the behaviour
of system defined attributes for selected element types. For example limits may be applied
to attributes of top level elements within the software.
A USDA allows the administrator to add the following behaviour to system attributes:
Set valid values
Define limits
Hide attributes on forms
Category
The valid values and limits may be varied with element type. For a full explanation of the
structure of a Dictionary database refer to the LEXICON Command Reference Manual.
After the creation of a new USDA, the following attributes in the Current Element Editor
must be populated. Dependent upon the attribute chosen, determines which other related
attributes are enabled or disabled accordingly.
Name Enter a valid name for the USDA in the text box, (special
characters are not allowed).
System attribute Enter the underlining system attribute to which the USDA is to
be applied. To select from a list of system attributes click the
icon to open the Select System Attribute window. For more
information refer to Select System Attribute.
Element types Contains the list of element types for which the USDA is valid,
up to 100 element types may be set.
To set the Element types, click the icon to open the Select
Element Types window. For more information, refer to Select
Element Types.
Hidden This attribute holds a logical value, setting this to true will
indicate that the UDA will be hidden from the Q ATT command
and from the attribute form within other Modules. Querying of
the individual UDA will not be effected by this setting.
To filter the list enter a text value in the Filter field. The list will refresh to display all system
attributes that contain all or part of the text value entered in the Filter field.
To choose a System Attribute, click an entry to highlight it.
Click OK to close the window and pass the selected system attribute back to the Current
Element Editor or Cancel to discard any inputs and return to the LEXICON window.
9 Status Definitions
Status Control is the ability to control and report on the status of individual model objects as
they progress their lifecycles. It can be applied to any model objects, for example tagged
items, catalogue components, drawings etc.
The desired project configuration is created by administrators as Status Definitions in
LEXICON with the use of a hierarchy of Status World, Status Definition and Status Value
elements.
These elements can then be applied to model objects in any of the constructor modules -
Design, PARAGON, SPOOLER, Diagrams, DRAFT. For more information on the creation of
the hierarchy, refer to Status Control.
The nodes represent the state of individual model objects, the links (arrows) represents
transitions between states of the individual model objects as they progress through their
lifecycle. The arrow direction indicates the direction of the allowed transition. The source
state is the initial state of the individual model objects and the target state is the final state of
the individual model objects.
The graphical view shows all the states and transitions that belong to the status definition or
STADEF element. This is either the selected STADEF or the STADEF owning the selected
STAVAL, unconnected node representing the STADEF can also be displayed.
The transitions are colour coded. A green transition indicates a promote state transition, a
red transition indicates a demote state transition. Black transitions are valid state transitions
that have not been marked as either promote or demote.
An alternative to using coloured transitions can be used as shown in the following graphical
view:
In this graphical view promote transitions are indicated by dashed arrows, while demote
transitions are indicated by a dotted arrow. Switching between the alternate styles for state
transitions can be achieved by right-clicking on the graphical view background and selecting
from the displayed menu, Coloured links or Dashed links.
10 Distributed Attributes
New functionality features called Bound elements and Binding elements have been
introduced to the database system. The basic principle of bound and binding attributes is to
enable elements to have groups of attributes distributed across other hierarchies and
different databases. These attributes are called Distributed Attributes.
For example, a engineering equipment Tag can be created by the process discipline with a
set of process condition attributes directly onto the tag. Other sets of attributes (for example
the mechanical and electrical attributes) can then be distributed across the mechanical and
electrical databases.
As a result, team members of the three teams irrespective of their location will have write
access to the attributes under their control and read only access to those not under there
control concurrently.
Engineering tags are created in the Tags module, for more information on Tags, refer to the
Tags User Guide. Data modelling is managed in the LEXICON module, for more information
on distributed attributes, refer to Define Distributed Attributes. The disciplines and locations
are identified and the databases and distributed hierarchy are created in the Admin module,
for more information refer to Administrator User Guide.
For more information on the attributes, configuration and details, refer to Database
Management Reference Manual.
For more information on the attributes, configuration and details, refer to Database
Management Reference Manual.
For more information on the attributes, configuration and details, refer to Database
Management Reference Manual.
For more information on the attributes, configuration and details, refer to Database
Management Reference Manual.
For more information on the attributes, configuration and details, refer to Database
Management Reference Manual.
For more information on the attributes, configuration and details, refer to Database
Management Reference Manual.
The central node is the Binding Element, the list in this node shows the elements to which
the distributed attributes can be bound. The list is populated with the element types form the
ELEL attribute of the DSXOWN element (:VALVTAG in this case).
The bound element types (based on XPITEM) are shown as nodes that depend on the
binding element. The arrangement of nodes in the distributed attributes view window follows
the same rules as the UDA graphical view window, when there are less than 20 bound
nodes, the view is arranged in spider layout, otherwise the list layout is displayed.
11 Database Views
The Database Views functionality available in the LEXICON module provides the System
Administrator with the ability to map element data into sets of related tables (Database View
Sets). The database view sets are populated with rows that exists in a table for each
element that meets specified criteria. The columns are derived from attributes, PML 1 or
XPath1.0 expressions. Attributes and expressions for the columns are specified from the
elements defined in the view definition (that is from multiple elements not just the row
element).
Database Views are managed in Definition Sets, these include:
Element View - Database views defined automatically to represent the database
hierarchy.
Project Views - Database views defined in the dictionary data bases for a project.
User Views - Database views defined as a file in the users project settings.
It is advised to create Database Views as User Views with the Database Views Editor in the
relevant module. For more information on the Database Views Editor, refer to Database
Views Editor.
If the editor is not available it can be added with the customisation command Aveva.Pdms.
Database View Editor. The customisation command allows a user, the opportunity to
test the view as a user view with full data access.
Once a view is stable, it is easily copied with the editor from the User Views to the Project
Views which adds it to the Dictionary database definitions.
Note: Database Views can also be created and edited in the Current Editor Element, for
more information, refer to Current Element Editor.
Make sure that the correct element in the dictionary hierarchy is selected, right click and
from the displayed menu select Create then select EXPCOLUMN : Expression Column
from the displayed list.
Create number of PBS text and PBS object nodes (PBSTXN and PBSOBN) defining
set of result nodes on particular level in PBS tree hierarchy. To put the result nodes
below appropriate parent nodes, PBS criteria (PBSCRT) should be used.
The PBS object node should be used if nodes in result tree are supposed to represent
existing database elements, e.g. equipment, systems and so on. The PBSOBN has
following attributes that can be used to configure generated nodes:
PBS formula type (PBSFMT) - this attribute specifies what method should be used to
generate result nodes. Possible values are:
PML expression
PML function
External method
From owners attribute
PBS formula (PBSFML) - it is a text attribute and its content is interpreted depending
on what formula type has been selected:
For "PML expression" it is supposed to be valid PML expression returning array of
database elements. It could be for example "collect all SYSGRP" which will return
all systems existing in current MDB. Then a node will be created for each system in
result tree
For "PML function" it is supposed to be "function call string", than means function
name together with function argument if required, e.g. !!GetAll('SYSGRP'). It should
be in the same format as the function call in command window. The PML function
could be any existing function returning array of database elements.
For "External method" the string should contain name of external class to be used
and also name of the dll where the class is defined. All available classes can be
picked up from Formula Edition dialogue.
There are a number of external classes provided in StandardPBSLibrary.dll and it is
possible to implement custom classes as well. There is required that custom class
supposed to be used as external method should implement IPBSCollection
interface provided by PBSCore.dll. Name of the dll containing the class should end
with "PBSLibrary".
For "From owners attribute" the string should contain name of attribute that should
be used to generate resulting nodes. The attribute should be valid for element
generated from owning PBSOBN. E.g. if the owning PBS object node has
generated set of schematic equipment and the member node specifies DIAREF as
"From owner attribute" formula, then resulting child nodes will be generated by
evaluating DIAREF attribute on each schematic equipment represented by
appropriate node.
It is possible to use "From owners attribute" even for nodes that are not owned by
PBSOBN. In this case system will search up the hierarchy until PBS object node is
found. All text nodes will be skipped as database attribute can't be evaluated on
them.
PBS text (PBSTXT) - this attribute specifies what text should be displayed on nodes
generated by the PBSOBN. By default it is full element name, but it can be specified as
any PML1 expression (including simple attribute name) returning string value.
PBS icon (PBSICO) - specifies icon to be displayed on result nodes. The icon can be
assigned statically by giving icon name or can be dynamically generated from PML1
expression. If no icon is specified, then the icon representing the object type will be
displayer, for example EQUI:
Note: The icon must exist in the in Shared.resouces file. These can be viewed in the UI
Customize window:
PBS group by (PBSGRB) - the attribute provide possibility to define formula for
dynamically generating parent nodes. It could be simple attribute name or PML1
expression returning string. The attribute or expression will be evaluated on database
element got from PBSFML and a parent node will be automatically created for each
value. For example if PBSGRB is "FUNC" and PMSFML returned set of equipment,
then FUNC will be evaluated on every equipment and the equipment will be grouped
below appropriate parent nodes automatically created for each distinct value of FUNC.
PBS recurrent node (PBSRCR) - for use in future enhancements. This is currently not
used.
The PBS text node should be used if nodes in result tree are not going to represent existing
database elements, so they are only labelled appropriately. The PBSTXN has following
attributes that can be used to configure generated nodes:
PBS formula type (PBSFMT) - this attribute specifies what method should be used to
generate result nodes. Possible values are:
PML expression
PML function
External method
Static text
PBS formula (PBSFML) - it is a text attribute and its content is interpreted depending
on what formula type has been selected:
!classes = ARRAY()
!texts = ARRAY()
!classes.append('SCEQUI')
!texts.append('Schematic equipment')
!classes.append('SCNOZZ')
!texts.append('Schematic nozzles')
!classes.append('SCPLIN')
!texts.append('Schematic pipelines')
!result = ARRAY()
!result.append(!classes)
!result.append(!texts)
return !result
endfunction
For "External method" the string should contain name of external class to be used
and also name of the dll where the class is defined. All available classes can be
picked up from Formula Edition dialogue. This is working similar to PBSOBN
elements.
For "From owners attribute" the string should contain name of attribute that should
be used to generate resulting nodes. This is working similar to PBSOBN elements.
PBS icon (PBSICO) - specifies icon to be displayed on result nodes. As nodes
generated by the PBS text node don't have database representation, the icon can
be assigned only statically by giving icon either directly by writing it her, or by
specifying a PML expression that will return the name. If icon name is given, then
the icon should exist in Shared.resources.
PBS recurrent node (PBSRCR) - for use in future enhancements. This is currently not
used.
After the nodes for each level of result PBS tree are generated, they need to be organised
under the appropriate parent nodes. The PBS criteria (PBSCRT) element is defining a way
to determine if given node fits to specific parent hierarchy. The criteria should be owned by a
node representing the nodes for "sorting" and then it should refer to owner node the check
should be performed for. For example, if we have a PBSOBN named "GetEngItems"
generating set of equipment and we would like to place the equipment below appropriate
nodes representing systems, then PBSCRT should be created below "GetEngItems" and
should point to the node generating systems.
After this is done, appropriate attributes on PBSCRT should be filled in for defining a way of
checking if equipment fits given systems. All attributes possible to set in PBSCRT are as
follows:
PBS query node (PBSQNO) - reference to node we want to match the element against.
It could be any PBSTXN or PBSOBN in hierarchy below node owning the PBSCRT.
"PBS formula type (PBSFTY) and PBS formula (PBSFML) - determine a way the check
is performed. The methods can be as follows:
PML expression - if PBSFTY is set to this value, then PBSFML is supposed to
contain valid PML1 expression which is going to be evaluated on node being
checked. The result value is compared with value of parent referenced by PBSQNO
and if matched, then the new node is placed below the parent.
PML function - if PBSFTY is set to this value, then PBSFML is supposed to contain
valid PML1 expression which is going to be evaluated on node being checked. The
Note: All PML functions and external method used in example are delivered as part of
installation.
And will result in following in PBS explorer. The root node text displayed comes from the
PBS Text attribute in the PBSTPL object:
So far there is only root of the PBS hierarchy defined in Lexicon. Now definition generating
system nodes is needed. To achieve this PBS object node should be created below PBS
template. In the example, PML expression is used for getting all available SYSGRP
elements:
And in PBS Explorer the tree contains nodes for systems. Text of the nodes is generated
according to PBS text defined in Lexicon:
Now systems should expand to show engineering classes and engineering items below
them. To generate engineering classes PBS text node will be used and the classes will be
got from PML function:
And every system node can be expanded to show list of engineering classes returned by
the !!GetEngineeringClasses() function. Additionally, the icon is set to "SCGROU" available
in Shared.resources:
The !!GetEngineeringClasses() function is creating two arrays: first containing text values to
be used by PBS criteria and the second contains corresponding presentation strings that
should be displayed on appropriate nodes. The two arrays are organised in another array as
the PBS standard requires. The function is available in %PMLLIB%\PBS\functions.
When the class nodes are available, it is needed to generate engineering items and put
them below appropriate systems and classes. The items should be also grouped by
description. To achieve this PBSOBN should be created and formula collecting engineering
elements should be specified. In example below, external method is used - the
"CollectEngItems" class from StandardPBSLibrary.dll. It has been selected from list
available from PBS Formula Editor dialogue. In addition the PBS group by is set to "DESC".
As a result nodes for all engineering items are created and they are grouped into parent
nodes generated for each distinct value of item description. For current definition the nodes
will appear below every System/Class hierarchy, so additional criteria needs to be defined
for placing the new nodes below appropriate parents only. Because of this one criteria
referring to /GetAllSystems and another referring to /GetEngClasses node should be
created. The first PBSCRT definition resolving if engineering item can be placed in hierarchy
below given system looks like below:
And the second one, determining which class the engineering item belongs to has following
attribute values:
The tree defined for such structure is shown below. Engineering items are placed below the
appropriate parent nodes, according to their SCSYSF and ACTTYP attributes. They are
grouped in nodes generated from the DESC values:
After engineering items are displayed and organised as designed, there is a need to show
following elements for every engineering item:
1. Drawings containing the item
2. Available datasheets
Definitions of content for every label node are needed now. Again, PBS object nodes should
be used as the members are going to represent existing database elements. At first node
generating drawings containing given engineering item will be described. This goes via the
DIAREF array on the connected Schematic element, provided by the PML function
"GetPIDs.pmlfnc, using the Engineering Item as a parameter. (See the Using parameters in
PBS expressions section for more information on parameters.)
For every engineering item, child nodes will be displayed by running the "GetPIDs" function.
The child nodes will be placed below the node generated by /PandID_label:
Next is definition for generating datasheet nodes. In the example, to illustrate different
options, a list of available datasheets is provided by a PML function:
endfunction
It is collecting all database elements with given type and returns the collection as an array of
database references.
Now, when all datasheet instance are got, criteria is needed to put datasheet nodes below
right places in the PBS hierarchy. The criteria shown below is based on DSIAST attribute of
datasheet and is matching its value against engineering items:
Now definitions for associated schematic and design items are needed. They are created
using PBS object nodes with "From owners attribute" formula type just like it was done for
getting diagrams containing given engineering item. In definition generating linked
schematic item SCHLNK attribute is used. That means that for every engineering item in
tree child nodes will be taken by evaluating their SCHLNK attribute and will be placed below
node generated by /SchematicItem_label:
PBS object node generating nodes for associated design items is defined in the same way
using DESLNK attribute:
The last needed definition is supposed to generate nodes for engineering item members. It
also could be done using "From owners attribute" formula type and MEMB attribute.
However to show different possibilities in the example it will be defined using PML
expression with parameter. The expression is in format "collect members of #PARAM(/
GetEngItems)" and that means that it will be called for every engineering item and the
"#PARAM(/GetEngItems)" will be replaced with the item reference number. Then generated
nodes will be placed under appropriate owner in hierarchy (the engineering item
>Members). The parameter string can be inserted using standard PBS dialogue:
After all definitions are created, the result PBS tree structure shows data like it was
specified:
13 Datasheets
The Datasheets functionality available in the LEXICON module provides the System
Administrator with the ability to create, modify, view or exchange datasheets with third
parties. These datasheets are stand-alone documents which can be created for tagged
items.
After the creation of a new DSTWLD, the attributes in the Current Element Editor can be
populated. Dependent on the attribute chosen, other related attributes are enabled or
disabled accordingly.
Note: When a new element is created in the database hierarchy using the Dictionary
Explorer the Current Element Editor automatically updates to display the attributes
for that element, these will initially be empty.
After the creation of a new DSTGRO, the attributes in the Current Element Editor can be
populated. Dependent on the attribute chosen, other related attributes are enabled or
disabled accordingly.
Alternatively the datasheet hierarchy can be created in the following way:
From the Dictionary Explorer, select the required DSTWLD element as CE, then from the
main menu bar, select Create > DSTGRO: Datasheet Template Group. The Datasheet
Template Group element is displayed in the Dictionary Explorer.
From the Dictionary Explorer, select the required DSTGRO element as CE, then from the
main menu bar, select Create > DSTMPL: Datasheet Template. The Datasheet Template
element is displayed in the Dictionary Explorer.
To display the New Template window, right click the new DSTMPL element in the
Dictionary Explorer.
Enter a valid name for the new DSTMPL element in the Name field, (special characters or
spaces are not allowed).
Enter a brief description of the new DSTMPL element to be created.
The Data Source defines the rules for database element creation and the navigation steps
required to additional information elements such as an items catalogue specification. The
data source is linked to the database views editor, refer to Database Views Editor for further
information.
Note: The only Definition Set available for selection is Project Views.
Click Ok to create a new datasheet template. A new DSTMPL element is created and
displayed in the Dictionary Explorer.
Or
After the creation of a new REVCWL, the attributes in the Current Element Editor can be
populated. Dependent on the attribute chosen, other related attributes are enabled or
disabled accordingly.
After the creation of a new REVCGP, the attributes in the Current Element Editor can be
populated. Dependent on the attribute chosen, other related attributes are enabled or
disabled accordingly.
Each definition and configuration of the Revision Block and Revision Number are
independent and can be linked to other configurations. Block definition and configuration are
dependent upon the status definition.
There is no specific order in which the REVBLD, REVCON, REVNOD elements can be
created in the dictionary hierarchy. To create any of these elements, right click the required
REVGRP element in the Dictionary Explorer, the following menu is displayed.
Number of parts Select the number of parts to the revision (for example: A1
is 2 parts).
Part name Enter a name for the part (for example: Major).
Reset to blank Select the Reset to blank check box to reset the part to a
blank value when a higher order part is incremented.
Cancel Click Cancel to discard any inputs and close the Revision
Number Definition window.
Status definition Allows the use to tie the revision block definition to a
particular status definition.
Limit the number of Allows the user to limit the number of revisions displayed.
revisions displayed to
Display latest revision Displays the latest revision first in the revision block,
first otherwise displays the latest last.
From the Attributes part of the Revision Block Definition window, the user can add the
attributes to be displayed in the Revision Block.
Select Add attribute, choose an attribute from the displayed list, type the name of the
attribute to be displayed in the header of the revision block. Repeat as required.
To remove an attribute from the revision block, select Remove attribute. Repeat as
required.
Click OK to save the changes.
Or
Click Cancel to discard any inputs and close the Revision Block Definition window.
REVCON: Revision Configuration
A Revision Configuration (REVCON) element ties all of the configuration (REVBLD and
REVNOD) elements together.
Right click the required REVCON element in the Dictionary Explorer, select Edit Revision
Configuration from the displayed menu, the Revision Configuration window is displayed.
Status definition Allows the use to tie the revision configuration to a particular
status definition. (The status definitions displayed are linked
to the element type selected).
Create working revision Allows the user to specify when a working revision is
at created.
Revision number Allows the user to select the format of the revision number,
definition refer to REVNOD: Revision Number Definition for further
information,
Revision block Allows the user to select how the revision block is displayed
definition in the datasheet. Refer to REVBLD: Revision Block
Definition for further information. The block definitions
displayed are linked to the status definition selected.
Cancel Click Cancel to discard any inputs and close the Revision
Configuration window.
UDA Settings
Owner Allows the user to select the User Defined Attribute Group
(UGRP), under which the newly created UDAs are stored in
the hierarchy as a result of auto mapping. Refer to User
Defined Attributes for more information.
Default Data Type Allows the user to specify the default data type for the newly
created UDAs.
Colour Settings
Bound Cell Colour Allows the user to choose what colour is displayed in a cell
of a datasheet when a attribute is mapped to it.
Free Text Cell Colour Allows the user to choose what colour is displayed in a cell
of a datasheet when the free text attribute is mapped to it.
Revision Control
From the Configuration drop down list, select a configuration from the list of available
configurations. Refer to Revision Configuration for further information.
Name Enter a name for the new unit set, the unit set is displayed in
the Unit sets pane of the Unit Sets Configuration window.
Click OK to save any changes and close the Unit Sets Configuration window.
Or
Click Cancel to discard any inputs and close the Unit Sets Configuration window.
The user can select what content is displayed in the Template Explorer:
Search by
The Search by functionality allows the user to filter the list of database views displayed in
the Template Explorer.
Properties
The Properties part of the Datasheet Template Editor window is populated with the
appearance, binding, design, function and misc properties.
Auto-map Attributes
The Auto-map functionality searches for the attribute with the same name as the boiler plate
text in the data source of the datasheet template. If an attribute cannot be located in the data
source, the dictionary database for the UDA is searched.
Once the searches have been completed, the Create and Map window is populated with
the results. The results can be accepted to continue with the mapping process.
From the Datasheet Template Editor window, select the cell to be mapped, then from the
main menu toolbar, select Auto-map Attributes.
The Create and Map window is displayed populated with the results of the searches:
Matched - Multiple data The Boiler Plate Text matches more than one attribute in the
source data source (database views and dictionary database. From
the Data Source column, select the required data source,
then select the Accept check box to map the templates cell
to the attribute.
Not Matched The Boiler Plate Text does not match an attribute, a new
attribute need to be created or the data source modified.
if an error occurs it is highlighted in the Create and Map window along with a message
describing the error.
Manual map
If require the attribute from the data source can be mapped to a cell(s) in the datasheet
template.
From the Template Explorer, select the required attribute, drag and drop the attribute into
the cell adjacent to the matching boiler plate text in the datasheet template.
Or
From the Datasheet Template Editor window, select the cell adjacent to the required boiler
plate text, then double click on the required attribute in the Template Explorer.
13.5.4 Toolbox
The Toolbox functionality allows the user to add standard controls to the datasheet template.
From the Toolbox, select the required control, drag and drop the attribute into the cell
adjacent to the matching boiler plate text in the datasheet template.
Or
From the Datasheet Template Editor window, select the cell adjacent to the required boiler
plate text, then double click on the required control in the Toolbox.
Parent attributes:
Child attributes:
When a continuation area has been added to the datasheet template, a border is displayed
this border is not visible in the datasheet.
Once an attribute from the nozzle data source (child) has been mapped on to the first row
within the continuous area, the mapping is then repeated horizontally for each nozzle
associated with the datasheet tag.
If the nozzles outnumber the number of rows selected in the continuous area then a new
sheet is generated until all the nozzles are displayed.
From the Template Explorer, select the element beneath the revision block (in this case:
generic pump), drag and drop the attribute into the in the datasheet template.
Or
From the Datasheet Template Editor window, select the cell then double click on the
required attribute in the Template Explorer.
Note: The selected cell in the datasheet template requires enough area to the right and
bottom to accommodate the revision block. For example: the number of revisions
displayed (rows) and the number of attributes added (columns). Refer to Revision
Configuration for more information.
Index
A Template
New . . . . . . . . . . . . . . . . . . . . . 13:3
Attribute Mapping . . . . . . . . . . . . . . . . 13:18 Template Group
Auto . . . . . . . . . . . . . . . . . . . . . . . 13:19 New . . . . . . . . . . . . . . . . . . . . . 13:2
Manual . . . . . . . . . . . . . . . . . . . . . 13:20 Datasheet Template Editor
Toolbox . . . . . . . . . . . . . . . . . . . . 13:20
C Datasheet Template Settings . . . . . . . 13:13
Colour Settings . . . . . . . . . . . . . . 13:13
Command Line . . . . . . . . . . . . . . . . . . . . 4:8 Revision Control . . . . . . . . . . . . . 13:14
Continuation Area . . . . . . . . . . . . . . . . 13:21 UDA Settings . . . . . . . . . . . . . . . . 13:13
Current Element Editor . . . . . . . . . . . . . . 4:3 Datasheets . . . . . . . . . . . . . . . . . . . . . . 13:1
Dictionary Explorer . . . . . . . . . . . . . . . . . 4:1
D Edit Members . . . . . . . . . . . . . . . . . . 4:2
Distributed Attributes . . . . . . . . . . . . . . 10:1
Database View . . . . . . . . . . . . . . . . . . . 11:2 Attributes
Database Views . . . . . . . . . . . . . . . . . . 11:1 Bound Elements . . . . . . . . . . . 10:2
Administrative Elements Binding Items
Create . . . . . . . . . . . . . . . . . . . 11:1 Create . . . . . . . . . . . . . . . . . . . 10:2
Attribute Column (ATTCOLUMN) Element Bound Elements
11:4 Create . . . . . . . . . . . . . . . . . . . 10:1
Attribute Filter Element . . . . . . . . . . 11:2 Define . . . . . . . . . . . . . . . . . . . . . . 10:1
CRERULES Element . . . . . . . . . . . 11:5
Graphical View . . . . . . . . . . . . . . . . 10:5
Expression Column (EXPCOLUMN) Ele- Hierarchy . . . . . . . . . . . . . . . . . . . . 10:2
ment . . . . . . . . . . . . . . . . . 11:4
Schema . . . . . . . . . . . . . . . . . . . . . 10:2
Expression Filter (EXPFILTER) Element DSXDST . . . . . . . . . . . . . . . . . 10:5
11:3 DSXHOM . . . . . . . . . . . . . . . . 10:4
Set Attribute (SETATTRIBUTE) Element
DSXMBR . . . . . . . . . . . . . . . . . 10:3
11:6 DSXOWN . . . . . . . . . . . . . . . . 10:3
Set Parameter (SETPARAMETER) Element
DSXSCH . . . . . . . . . . . . . . . . . 10:2
11:6 DSXTST . . . . . . . . . . . . . . . . . 10:4
Set Status (SETSTATUS) Element 11:7
Source Element (SCRELEMENT) . 11:3
Database Views Editor . . . . . . . . . . 4:4, 5:1 F
Datasheet Features . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
Hierarchy . . . . . . . . . . . . . . . . . . . . 13:1
G Template Explorer
Properties . . . . . . . . . . . . . . . . . . 13:18
Graphical View . . . . . . . . . . . . . . . . . . . . 4:5 Search by . . . . . . . . . . . . . . . . . . . 13:18
Layout . . . . . . . . . . . . . . . . . . . . . . . . 4:8 Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
Nodes and Links . . . . . . . . . . . . . . . . 4:6
U
H
UDA . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:1
Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . 2:1 Element types
DBVWWL . . . . . . . . . . . . . . . . . . . . . 2:1 Select . . . . . . . . . . . . . . . . . . . . 6:7
DSTWLD . . . . . . . . . . . . . . . . 2:2, 13:1 Graphical View . . . . . . . . . . . . . . . . . 6:9
DSXWLD . . . . . . . . . . . . . . . . . . . . . 2:2 New . . . . . . . . . . . . . . . . . . . . . . . . . 6:4
REVCWL . . . . . . . . . . . . . . . . 2:2, 13:6 Valid Values
REVCWL Group . . . . . . . . . . . . . . . 13:7 Edit . . . . . . . . . . . . . . . . . . . . . . 6:8
REVNOD UDA Group
Revision Number Definition . . . 13:8 New . . . . . . . . . . . . . . . . . . . . . . . . . 6:2
STAWLD . . . . . . . . . . . . . . . . . . . . . 2:2 UDA World
UDETWL . . . . . . . . . . . . . . . . . . . . . 2:2 New . . . . . . . . . . . . . . . . . . . . . . . . . 6:1
URWL . . . . . . . . . . . . . . . . . . . . . . . . 2:2 UDET
Base Type
L Select . . . . . . . . . . . . . . . . . . . . 7:5
Graphical View . . . . . . . . . . . . . . . . . 7:8
LEXICON Toolbar Hidden Types
Create . . . . . . . . . . . . . . . . . . . . . . . . 3:2 Select . . . . . . . . . . . . . . . . . . . . 7:7
Datasheets . . . . . . . . . . . . . . . . . . . . 3:4 Member Types
Display . . . . . . . . . . . . . . . . . . . . . . . 3:1 Select . . . . . . . . . . . . . . . . . . . . 7:6
Edit . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2 New . . . . . . . . . . . . . . . . . . . . . . . . . 7:3
Help . . . . . . . . . . . . . . . . . . . . . . . . . 3:3 Owner Types
LEXICON . . . . . . . . . . . . . . . . . . . . . 3:1 Select . . . . . . . . . . . . . . . . . . . . 7:5
Modify . . . . . . . . . . . . . . . . . . . . . . . . 3:3 UDET Group
Pipe Stress Interface . . . . . . . . . . . . 3:3 New . . . . . . . . . . . . . . . . . . . . . . . . . 7:2
Schematic Model Manager . . . . . . . . 3:3 UDET World
Unit Setsd . . . . . . . . . . . . . . . . . . . . . 3:4 New . . . . . . . . . . . . . . . . . . . . . . . . . 7:1
LEXICON Window . . . . . . . . . . . . . . . . . 4:1 Unit Sets Configuration . . . . . . . . . . . 13:14
USDA
O Element Types
Select . . . . . . . . . . . . . . . . . . . . 8:4
Overview . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
New . . . . . . . . . . . . . . . . . . . . . . . . . 8:1
System Attribute
R Select . . . . . . . . . . . . . . . . . . . . 8:3
User Defined Element Types . . . . . . . . . 7:1
Revision Block
User System Defined Attributes . . . . . . . 8:1
Addition . . . . . . . . . . . . . . . . . . . . 13:23
Revision Configuration . . . . . . . . . . . . . 13:6
V
S View Definition Sets . . . . . . . . . . . . . . . . 5:2
Definition Set
Status Definitions . . . . . . . . . . . . . . . . . . 9:1
Create . . . . . . . . . . . . . . . . . . . . 5:2
Graphical View . . . . . . . . . . . . . . . . . 9:1
Toolbar . . . . . . . . . . . . . . . . . . . . . . . 5:2
Views . . . . . . . . . . . . . . . . . . . . . . . . 5:3
T Columns . . . . . . . . . . . . . . . . . 5:13
Data Sources . . . . . . . . . . . . . . 5:8
Template Editor . . . . . . . . . . . . 13:15, 13:17
Toolbar . . . . . . . . . . . . . . . . . . . . . 13:15 Preview . . . . . . . . . . . . . . . . . . 5:15
View Detail . . . . . . . . . . . . . . . . 5:6