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.
The AVEVA Tags user interface is based on the Microsoft® Office Fluent™ user interface.
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.
Tags User Guide
Revision Sheet
Contents Page
Tags
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Guide Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:2
Accessing the Tags Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:2
Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
Set Default Units of Measure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
Other Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2
Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:1
Running Quick Reports on the Current List . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:1
Running Pre-Defined Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:3
Reporting Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:5
Datasheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:1
Datasheet Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:1
Datasheet Instance World . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:1
Datasheet Instance Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:1
Datasheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:2
Datasheet Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:13
1 Introduction
The AVEVA Tags User Guide describes the features of the Tags module and how to use
them.
The Tags module can be used to:
• Create, manage and view user-defined lists of elements from a AVEVA PDMS or
AVEVA Marine project database.
• Use these lists to add, edit and delete elements.
• Navigate the hierarchical structure of a database using an explorer. Use the explorer to
view, add, edit and delete elements.
• View and change the lifecycle status of elements.
• Highlight changes to elements between selected database sessions.
• Manage local and extract claims of elements and attributes.
• Compare attributes in other AVEVA product databases and update and link them if
required.
• Export and import data to and from Excel spreadsheets.
• Publish data to AVEVA NET.
• View the schematic diagrams, schematic models and the files, URLs and e-mail
addresses associated with elements.
• Produce reports from list data.
Continue at:
• Guide Structure
• Prerequisites
• Accessing the Tags Module
Create and Manage How to create and edit lists of tags and other data.
Lists
Explore the Database How to explore the hierarchy of elements in a project database.
Data Management Describes the data management facilities if the Tags Module.
Import and Export How to import and export data from and to other applications.
View Diagrams, How to view the schematic diagrams, schematic models, and
Models and Linked documents associations with elements.
Documents
1.2 Prerequisites
To set up a project in order to use the Tags Module and an Engineering database, a number
of procedures must first be completed. For example, the required UDET’s, UDA’s,
Distributed Attributes, DB Views, Status definitions and Lists-of-Values must be setup.
Refer to the Administration User Guide and the LEXICON User Guide for further
information.
Refer to the Getting Started with AVEVA Marine for further information
2 User Interface
Save Work Used to save any changes made to data made using the Tags
module. This facility is also available on the Quick Access
Toolbar by default.
Get Work Used to refresh data in any opened lists with any changes that
other users may have made to the data since the lists were
opened. See Refresh Data for further information.
This facility is also available on the Quick Access Toolbar by
default.
Note: The Admin tab is only displayed if the user is a member of the TAGSADMIN team.
Refer to the Administration User Guide for further information.
A further tab may be displayed which contains options specific to the window which is
currently displayed (for example, the Database Explorer). If no window with such options is
open, the tab will not be displayed.
If required, the tabs, apart from their titles, can be hidden to save space.
To hide the tabs, right-click on them and select the Minimise the Ribbon option from the
menu that is then displayed, double-click on a tab title, or click this button to the far right of
the tabs: (the button then changes so that the arrow points downwards: ).
Repeat the above procedure to “un-hide” the tabs.
Continue at:
• Home Tab
• Manage Tab
• View Tab
• Admin Tab
• Windows Specific Options Tabs
Database Group
PBS Explore Used to explore the project breakdown structure of the
database and view the equipment tags. Refer to Project
Breakdown Structure for further information.
Open Used to open the list selected in the adjacent lists. Refer to
Use Lists. for further information
Clipboard Group
Cut Used to cut data from a cell in a list. Refer to Copy, Cut and
Paste Commands for further information.
Copy Used to copy data from a cell in a list. Refer to Copy, Cut and
Paste Commands for further information.
Paste Used to paste data to a cell in a list. Refer to Copy, Cut and
Paste Commands for further information.
Records Group
New Used to create a new record in a list. Refer to Create New
Records for further information.
The arrow button under this option accesses a sub-menu with the following options:
Auto Rename Used to apply auto naming rules to selected records. Refer to
Apply Autonaming Rules to existing Records for further
information.
The arrow button next to this option accesses a sub-menu with the following options:
Show Claim State Used to view the local claim state of elements in a list. Refer to
View Local Claim State of Elements for further information.
Delete Used to delete a record from a list. Refer to Delete Records for
further information.
Datasheets
New Used to create new datasheets, refer to Datasheets.
Select All Used to select every record in a list. Refer to Select Multiple
Rows for further information.
Vertical View Used to view lists in the Card View format. Refer to Display
Data in Vertical View for further information.
Auto Size Columns Used to adjust the width of all columns in a list to the width of
the data displayed in them. Refer to Auto Size Columns for
further information.
Clear Filters Used to clear all temporary filtering from a list. Refer to
Removing Filtering for further information.
Reset Cell Feedback Used to set cell feedback colours back to the default colours.
Refer to Feedback Colours for further information.
Quick Report Used to generate a report on the data in the current list. Refer
to Running Quick Reports on the Current List.
Reports Group
Reports This button accesses a sub-menu with the following options:
Report Designer Used to access the Report Designer in order to create user-
defined reports. Refer to Reporting Designer.
Run Report Used to run pre-defined reports supplied with Tags or created
by users in Report Designer. Refer to Running Pre-Defined
Reports.
The arrow button next to this option accesses a sub-menu with the following options:
Search in Headings Used to specify that values are to be searched for in headings.
Search in Data Values Used to specify that values are to be searched for in lists.
Find Used to open the Find window used to carry out more
advanced searches.
Replace Used to open the Replace window used to find and replace
values.
Status Values list Used to select the one of the Status in the selected lifecycle.
Refer to View and Change Status for further information
Select status values in Used to select all records in the current list at a specified
the grid status. Refer to Select Elements according to Status for
further information.
Changes Group
Highlight Used to highlight changes to data in a list between selected
sessions.
The arrow button under this option accesses a sub-menu with the following options:
Last Session Used to highlight changes to data in a list since the last
session.
The arrow button under this option accesses a sub-menu with the following options:
Column History Used to view the history of data in a selected column. Refer
to View History of Changes for further information.
Extracts Group
Claim Used to claim elements to extract claims. Refer to Claim
Elements to Extract Claims for further information.
The arrow button under this option accesses a sub-menu with the following options:
The arrow button under this option accesses a sub-menu with the following options:
From Parent Ancestors Used to refresh extracts from their parent extracts/
databases. Refer to Refresh Extracts for further information.
From All Ancestors Used to refresh extracted elements with current data from all
their ancestors from the parent extract up to the top of the
database hierarchy. Refer to Refresh Extracts for further
information.
Compare / Update / Used to compare the attribute values of Tags data against
Link data held in AVEVA Instrumentation, AVEVA Electrical and
Design databases, and to update the Tags data with values
from these databases. Refer to Compare / Update / Link
Attributes.
Excel Export Used to export data from the current list to an Excel
spreadsheet. Refer to Import from and Export to Excel for
further information.
The arrow button next to this option accesses a sub-menu with the following options:
Current List Used to export data from the current list to an Excel
spreadsheet. Refer to Import from and Export to Excel for
further information
Current Datasheet Used to export data from the current datasheet to an Excel
spreadsheet. Refer to Import from and Export to Excel for
further information
Select From Database Used to data selected from the database to an Excel
spreadsheet. Refer to Import from and Export to Excel for
further information
View Group
Datasheet Used to create new datasheets or view current or previous
versions of a datasheet. Refer to Datasheets for further
information.
The arrow button under this option accesses a sub-menu with the following options:
View Diagram Used to open a window from which diagrams can be searched
for, previewed, and opened for viewing. Refer to View
Schematic Diagrams for further information.
The arrow button under this option accesses a sub-menu with the following options:
View Selected Item in Displays the Select Equipment window. Refer to View
Schematic Model Schematic Models for further information.
Viewer
View Schematic Displays the Select Equipment window where the required
Model Viewer element can be selected and opened in the Schematic Model
Viewer.
Linked Documents Used to view the documents linked to elements, and to add
new links. Refer to View and Add Document Links for further
information.
Window Group
New Horizontal Tab Used to view lists one above the other. Refer to View Lists
One above the Other for further information.
New Vertical Tab Used to view lists side by side. Refer to View Lists One above
the Other for further information.
Move the Previous If the list view has been split using the New Horizontal Tab or
Tab New Vertical Tab option, used to move a list to the tab above
or to the left of the tab it is currently in. Refer to Move to
Previous Tab for further information.
Move to Next Tab If the list view has been split using the New Horizontal Tab or
New Vertical Tab option, used to move a list to the tab below
or to the right of the tab it is currently in. Refer to Move to Next
Tab for further information.
Tabbed view Used to toggle between displaying lists in the tabs (the default
format), or in windows. Refer to Display Lists in Windows for
further information.
Short Title Used to display only short title of lists in their titles tabs. Refer
to Display Short List Titles for further information.
Column Filtering Use to display or hide the filtering row in a list. Refer to The
Filter Row for further information.
Multi-select Filter Used to toggle the column filtering facilities of a list between
Style different styles of filtering. Refer to List Filters for further
information.
Grouping Panel Used to display or hide the grouping panel in a list. Refer to
Group Data in a List for further information.
Column Summaries Used to toggle on and off the column summaries facility in a
list. Refer to Column Summaries for further information.
Show Unset/Nulref Used to toggle on and off the display of unset and nulref
values in a list. Refer to Show/Hide Unset and Nulref Values
for further information.
Show leading slash Used to display or hide the slash that prefixes some values in
a list. Refer to Show/Hide Leading Slashes for further
information.
Feedback Colours Used to specify the cell feedback colours to be used in a list.
Refer to Feedback Colours for further information.
Database Explorer Used to explore the structure of the project database and view
the attributes of elements.
Db View Editor Used to edit database views. Refer to Database Views Editor
for further information.
Autonaming Setup Used to switch on autonaming rules for new records and to
define and select such rules. Refer to Autonaming for further
information.
Design Reuse Used to copy data between projects, refer to Design Reuse
User Guide for further information.
AVEVA NET Gateway Used to configure the interface with AVEVA NET. Refer to
Setup Export to AVEVA NET for further information.
Datasheet Group
Highlight colour Used to specify the highlighting colours
Save Work Used to save any changes made to data made using the Tags
module. This facility is also available on the Project Menu.
Get Work Used to refresh data in any opens lists with any changes the
other users may have made to this data since the lists were
opened. See Refresh Data for further information.
This facility is also available on the Project Menu
Session Comment Used to save any comments made during the work session.
Undo Undoes the last change made to the last row edit. Any
subsequent undo will roll back each row's edits on a row by
row basis.
Redo Reverses the last undo (see above) made to data in the grid.
To add a tab or menu option to the toolbar, right-click on it and select the Add to Quick
Access Toolbar option from the menu that is then displayed.
By default, the toolbar is located above the tabs. If required it can be moved below the tabs
by selecting the Show Quick Access Toolbar Below the Ribbon option from the right-click
menu shown above, or the Show Below the Ribbon option from the Customise Quick
Access Toolbar menu displayed by clicking the arrow at the end of the toolbar.
Once the toolbar is below the ribbon, the menu options become Show Quick Access
Toolbar Above the Ribbon and Show Above the Ribbon, and are used to move the
toolbar back to its original position.
The Customise Quick Access Toolbar menu also includes options for removing and
returning the default buttons from and to the toolbar.
The icon to the left of the message text indicates the type of message: information , error
or warning .
A message may be is too long to be displayed in the status bar. Hover the mouse cursor
over the message text to display the full text of the message in a tooltip. For example:
The date and time that a message was issued may optionally be displayed after the
message text. Right-on the message text and select the required options from the menu that
is then displayed:
Note: The Admin tab is only displayed if the user is a member of the TAGSADMIN team.
Refer to the Administration User Guide for further information.
3 Options
The Options window is used to view and edit application preferences. To open the Options
window, select Options from the Project Menu.
The Options window is then displayed:
Continue at:
• Set Default Units of Measure
• Other Options
In the left-hand pane, the window lists each dimension and their current default units of
measure.
To change the default unit of measure for a dimension, click on it in the list. A list of units of
measure is then displayed in the right-hand pane.
Click on the unit of measure to be used and then click Set <dimension> Unit. The default
unit as displayed in the left-hand pane is then changed to the selected dimension and an
example value is displayed in the Example field.
To change the default units back to the project defaults, click Project Defaults.
To save the current set of default units, click Save.
To apply the last saved set of default units, click Restore.
When a Save Work is carried out a window may optionally be displayed in which a comment
regarding the session can be entered. If this is required, check the Prompt for Session
Comment during Save Work checkbox. The checkbox is unchecked by default.
Project data in the Tags module is viewed and edited using a number of lists, each of which
displays a category of data in a grid format.
This section describes how to create and manage lists.
A list is created by selecting a project database view. The user may then specify which fields
from that view are to be included in the list when displayed in the Tags module, specify the
layout and sort order of these fields, and apply filtering.
All lists are grouped into user-defined categories. The category a list is to belong to must be
defined before the list.
Continue at:
• Categories
• Lists
See also:
• Database Views Editor
4.1 Categories
Lists of project data in the Tags module are grouped into user-defined categories. Refer to:
• Create a Category
• Edit a Category
• Delete a Category
Click Add Category. The Manage Lists Category window is then displayed:
The Manage Lists Category window is then displayed with the details of the selected
category displayed. Edit them as required and click OK.
To delete a category, select it from the Categories group of the Manage Lists window and
click Remove Category. The selected category is then deleted.
4.2 Lists
Project data in the Tags module is viewed and edited using user-defined lists, each of which
displays a category of data in a grid format. Refer to:
• Create a List
• Edit a List
• Delete a List
• Copy a List
From the Categories list, select the category to which the list is to belong. For details of how
to create a category, refer to Create a Category.
The Lists in Category list displays the lists currently in the selected category.
Click Add List. The List Manager window is then displayed:
3. The list of views in the selected set is then displayed in Views tab of the Views group
of the tab. View sets are listed in the View Sets tab.
Note: The lists of views and view sets in the User Views view definition set and in user
created definition sets can be edited, as can the properties of these views. Refer to
Database Views Editor for further information.
4. If required, filter the list of views by selecting a filter from the Database Types Filter
list.
5. Select the required view/view set from the tabs.
Note: The selected view cannot be changed once the list has been created.
Select Fields
On the Fields tab, select the view fields to be included in the list by checking the appropriate
checkboxes in the Select column.
All checkboxes are checked by default. To check or uncheck all checkboxes, check/uncheck
the checkbox in the Select column header.
From the Row ID column list, select which field is to be the first column in the displays
details of changes to cells and records (see View History of Changes).
Specify Layout
On the Layout tab, specify the order in which the columns of the list are to be displayed.
A column group heading is then added under the column name that was right-clicked on
with the default name of Group 1 (assuming it is the first group to be created). Enter a
different name if required.
For example:
Drag and drop the columns that are to be grouped under the new heading onto its entry in
the list. For example:
The new column group is displayed in the graphical representation of columns in the right-
hand section of the tab.
This will result in a list with the following layout:
Add further groups as required. Groups can be created under other groups.
To rename a group, right-click on it and click Rename Group.
To delete a group, right-click on it and click Delete Group. Columns and groups within the
deleted group are not deleted. They are moved up a level in the list of columns/groups.
If required, columns can be pinned by default. To a pin a column, either click on the pin icon
in the graphical representation, or with the Multi Level Headings checkbox unchecked,
right-click on the column name in the list of columns and select Pin Column from the menu
that is then displayed.
Options for unpinning the column and to remove the pinning icon from the column are also
available on this menu. For more information on pinning columns refer to Pin Columns.
Records with attribute values in common can be grouped together by default. For example,
records can be grouped according to their Description or Tag Number.
This is achieved by dragging column headings into the grouping bar above the column
headings. Refer to Group Data in a List for further information.
Note: Temporary sort orders can also be specified when a list is open (see General List
Functionality).
Sub-Lists
Lists may have sub-lists. If a sub-list is set up for a list, when an item is selected in this list,
the sub-list will display the details of items associated with the selected item.
For example, in the case of a list that displays equipment items, a sub-list may be set up that
displays details of associated motors. When an item such as a pump is selected, the sub-list
displays the details of the relevant pump.
Sub-lists are setup using the Sub-lists tab. For example:
The tab lists the allowable sub-lists for the current list (the sub-lists must be set up first). To
add a sub-list, check the appropriate checkbox.
Edit the list definition as required. Refer to Create a List for further information.
Note: When editing the details of a copied list, a different category may be selected from
the Category field.
Note: The Admin tab is only displayed if the user is a member of the TAGSADMIN team.
Refer to the Administration User Guide for further information.
5 Use Lists
Project data in the Tags module is viewed and edited using a number of lists, each of which
displays a category of data in a grid format.
This section describes how to open and work with lists.
Continue at:
• Open Lists
• Right-Click Menu
• General List Functionality
• Group Data in a List
• List Filters
• Add, Edit and Delete List Data
• Find and Replace Text in a List
• Print a List
Note: By default, the title tab of each list includes the list name, category type and category
name and the list name. If required, the category names and types can be hidden.
Refer to Display Short List Titles.
Note: By default, each list is displayed on a separate tab. If required, each can instead by
displayed in separate window. Refer to Display Lists in Windows.
5.1.1 Sub-Lists
If sub-lists have been set-up for a list, they are displayed under the list. For example:
When an item is selected in a list, the sub-list or lists display the items associated with that
item. For example, the motor associated with a pump.
Sub-list data can be viewed, formatted and edited in the same way as data in main lists.
If a record in a sub-list is selected, the title bar of the sub-list is highlighted in blue.
• Copy - refer to Copy, Cut and Paste Commands for further information
• Paste - refer to Copy, Cut and Paste Commands for further information
• Fill Up - not used
• Fill Down - not used
• Clear - refer to Clear Cells for further information
• Column Filtering - refer to The Filter Row for further information
• Column Sorting - refer to Sort a List for further information
• Column Summaries - refer to Column Summaries for further information
• Grouping Panel - refer to Group Data in a List for further information
• Multi-select Filter Style - refer to Multi-Select Filtering for further information
• Find and Replace - refer to Find and Replace Text in a List for further information
• Print Preview - refer to Print a List for further information
• Export to Excel - refer to Import from and Export to Excel for further information
• View Diagram - refer to Open a Schematic Diagram for further information
Select a pre-defined magnification level, or enter a custom level and click OK.
5.3.2 Windows
If all lists are moved from a list view section the tab is closed and the list display reverts to
the default layout.
The Move to previous tab group option can also be accessed from the menu that is
displayed by right-clicking on a list tab in the lower or right-hand part of a split list view.
Note: Lists can also be moved from one list view section to another by clicking on the list
title and dragging and dropping it into the other list view section.
Check the Tabbed view checkbox to display lists in the tabs again.
To display data in a vertical view, click Vertical View in the Grid Actions group of the Home
tab. The current list is then changed to the vertical view.
Click Vertical View again to return to the standard grid view.
Note that multi-level headings cannot be displayed in vertical view mode. Only the headings
of individual columns will be displayed. The headings of groups of columns will not be
displayed. A message to inform the user of this will be displayed when vertical view mode is
selected.
• Hold down the shift key (Shift) and select a row by clicking immediately to the left of the
first column. Then select another row. Both the selected rows, and all the rows listed
between the two rows are then selected.
• Press Ctrl-A on the keyboard or select Select All Rows on the Home tab. All rows in
the current list are then selected, excluding any rows filtered out.
5.3.4 Columns
Note: The default column layout and sort order is defined using the List Manager window.
Refer to Create and Manage Lists for further information.
Resize
To resize a column, click and hold on the line between columns and drag the line left or right
to make it wider or narrower. Double-clicking on the line will resize the column to fit the
largest string of text within that column.
Combine Columns
Data from multiple columns may be combined into a single column. Click and hold a column
header and drag it to on top of the header of the column with which it is to be combined. Two
horizontal arrows are displayed to assist the user in positioning the column.
Sort a List
The user can set the records in a list to be sorted according to the values in a selected
column by clicking the heading of that column. By default, the sort order is lowest value to
highest (e.g. A to Z, low number to high number). This can be reversed by clicking the
column heading again.
The selected column and the sort order is indicated by an arrow in the column heading. An
arrow pointing upwards indicates the sort order is lowest to highest. An arrow pointing
downwards indicates the sort order is highest to lowest.
To sort by multiple fields hold the <Shift> key while making selections. The list will be sorted
in the order in which each column is selected.
This facility is enabled by default for a list. To enable this facility if it has been disabled, right-
click on a column and select the Column Sorting option from the menu that is then
displayed.
Pin Columns
When a column is pinned, it automatically becomes the first (left-hand most) column of the
list, and remains displayed at the left-hand side of the list even when the list is scrolled to the
right, so that it is always in view.
Pin icons are displayed in headings of a list. To pin a column, click on its pin icon.
When a column is pinned, its pin icon changes orientation, so that its point is downwards.
Click the icon again to unpin the column.
Column Summaries
The total of values in a column containing numbers can be calculated and displayed
beneath the column.
Sum icons are then displayed in headings of a list if the summarise columns facility is turned
on for that list. If not, to activate the facility for the current list, either check the Column
Summaries checkbox in the Grid Options group of the View tab, or right-click on a column
and select the Column Summaries option from the menu that is then displayed.
Change Units
The units of measurement used to quantify values in a column may be changed if required.
To change the units for a column, click the button in the column heading, and select the
required units from the list that is then displayed.
The values in the column are then recalculated in accordance with the new unit of
measurement.
5.3.5 Cells
To select the value in a cell, double-click on it. The value is then highlighted.
Feedback Colours
The background colours of cells indicate if:
• they are read-only
• an unsuccessful attempt has been made to edit their contents (for example, if an invalid
entry was made), or a required data is missing (i.e. in the case of a blank cell that
should be completed)
• their contents have been edited successfully
• to highlight various conditions, for example that their contents have been claimed (refer
to Manage Claims for further information)
In the example below the cell with the blue background was edited successfully, the cell with
the pink background was not edited successfully, and the cells with a grey background are
read-only.
The colours used to indicate these conditions can be specified by the user for each list.
To edit cell feedback colours, click Feedback Colours in the Grid Options group of the
View tab and select the required option from the menu that is then displayed.
If not, to activate the facility, check the Grouping Panel checkbox in the Grid Options
group of the View tab, or right-click on the list and select the Grouping Panel option from
the menu that is then displayed.
To group data, drag and drop the column heading of the attribute in question into the
grouping panel.
The list 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 records are grouped by is displayed in the grouping panel.
To view the records within a group, click on the "+" button next to the group name. The
records are then listed under the name. Press the "-" button to close the list.
Note: The fields within a group can be fixed, sorted, moved and filtered in the normal way.
For example, each group of element records with the same Description will be sub-divided
into groups of records with the same Tag Number.
If the second heading is dropped to the left of the first heading, records will be grouped the
other way round.
The filter row is displayed by default. To add or remove it from a list, use the Column
Filtering checkbox in the Grid Options group of the View, or right-click on the list and
select the Column Filtering option from the menu that is then displayed.
The format of this row depends on the type of filtering selected for the list.
To apply filter using the multi-select style filtering facility, first activate it for the list by
checking the Multi-Select Filter Style checkbox in the Grid Options group of the View tab,
or right-clicking on the list and ticking the Multi-select Filter Style option on the menu that
is then displayed.
The window lists all the values in the column, plus ‘All’ and ‘Blanks’.
Next to each item in the list there is a checkbox. To filter out a value from the column,
uncheck its checkbox. To uncheck all values, uncheck the ‘All’ checkbox. Check the ‘All’
checkbox again to check all the checkboxes again.
If the ‘Blanks’ checkbox is checked, rows without a value in the column are displayed when
the filter is applied.
When the required filter conditions have been selected, click OK to close the window and
apply the filter.
The filter is then applied. The value that the column is being filtered by is displayed in the
filtering row field for the column. If the column is being filtered by multiple values or by and a
text filter (see below), ‘Custom’ is displayed.
To edit a Multi-select style filter, access the filter window again and change the filter criteria
as required. To clear the filter, click Clear Filter. See also Removing Filtering.
Text Filters
More advanced filters can be applied by clicking Text Filters. A list of text filtering criteria is
then display, plus ‘Custom Filter’.
Click on the required criterion. The Custom Filter window is then displayed.
The first field displays the name of the column that list is to be filtered by. This cannot be
changed.
The second field displays the criterion selected when the window was accessed. If the
‘Custom Filter’ option was selected, this field is blank. Select a different criterion from the list
of values if required.
In the third field, select the value to filter by. The list accessed from this field contains every
value in the column plus options for filtering out records that do not contain values.
If another filter condition is required, click the Add button. Another row of fields is then
displayed. Select a filter criterion and enter a value as described above.
To delete a filter condition, select the criteria row and click the Delete button.
If more than one filter condition has been specified, select ‘Any’ from the Filter based on list
if records meeting any of the conditions are to be displayed in the list when the filter is
applied.
If only records meeting all the conditions are to be displayed, select ‘All’.
Click OK to apply the filter.
If a value is selected without a criterion being selected, the ‘Contains’ criterion is applied by
default.
Then either enter a value in the field to the right of the criterion selection button, or click on
the button to the right of this field and select a value from the list that is then displayed.
The list contains every value in the column, plus ‘Blanks’ and ‘NonBlanks’.
If ‘Blanks’ is selected rows without a value in the column are displayed when the filter is
applied. If ‘NonBlanks’ is selected rows with a value in the column are displayed.
The selected value is displayed in the field between the two buttons.
The filter is then applied to the list.
To remove all filtering from the current list including custom filters, in the Grid Actions group
of the Home Tab click Clear Filters.
Successfully edited cells, unsuccessfully edited cells and read-only cells are indicated by
their background colour. Refer to Feedback Colours for further information.
A failed attempt at editing the data in a cell may also be indicated by a red background
colour. For example:
Hover the mouse cursor over the cell to view the text of the message in the Tool Tip. The
message will also be displayed in the status bar and recorded in the Message Log. Refer to
Messages and the Message Log for further information.
Clear Cells
To quickly delete the contents of a cell or of multiple cells, select the cells and then right-
click and select the Clear option from the menu that is then displayed.
Lists of Values
Lists of values are available for some fields, accessed from the arrow button which is
displayed when the mouse cursor is hovered over them. For example:
Reference Browser
Some fields are provided with the facility to select values from a reference browser.
To access the browser for a field, click the ellipsis button which is displayed when the mouse
cursor is hovered over it. The Reference Browser window is then displayed with the current
value selected. For example:
Use the Explorer tab to browse the database structure for the required value.
Click OK. The window is then closed and the selected value populates the field in the list.
Alternately, search for the required value using the Search tab.
Searches carried out using this facility search at and below the level in the database
structure currently selected on the Explorer tab, as indicated at the top of the tab (e.g.
“Search In: /PROCESS_SYSTEMS”).
The Item Type field displays the type of element currently being searched for.
To further restrict the search results, in the Name/Description field, enter a string. The
search results will include only elements with that string in their name or description.
Click Search to carry out the search. The results of the search are displayed beneath the
fields.
Select the required value from the search results and click OK. The window is then closed
and the selected value populates the field in the list.
Click Clear to exit the window and delete the current value from the field in the list.
Arrays of References
Some fields may be populated with arrays of references. For example:
To create or edit an array of references for a field, click on the ellipsis button which is
displayed when the mouse cursor is hovered over it. The Reference Picker window is then
displayed with the current values in the array displayed. For example:
To add a new reference to the array, click Add. The Reference Browser window (see
above) is then displayed. Select the required value from this window and click OK. The
selected value is then added to the list of values in the Reference Picker window.
The Up and Down buttons are used to set the order in which values are listed in the grid
fields. The first value listed in the Reference Picker window will be the first value in the
array displayed in the field and so on. To move a value up or down the list, select it and click
Up or Down as appropriate.
To delete a value from array, select it and click Remove.
Click OK to exit the window and save the changes made to the array.
Enter the required information in the fields provided, and as required the optional
information, and click OK. The new record is then added to the list.
Default values can be defined for a session using the Session Defaults window, as
described below. These default values will automatically populate the fields in the Create
element information window. They may be overwritten as required.
If Autonaming is in use, the name of the new record may be automatically completed. See
below for more information. In the case of lists based on views with creation rules setup, the
Create element information window will only be displayed if there are rules covering no-
name element attributes.
Note: New records can also be created using the explorer. Refer to Explore the Database
for further information.
In the Attribute field, select the attribute for which a default value is to be set up for. Enter or
select the default value in the Value field. Ensure that the Enabled checkbox if the default
value is to be used (it is checked by default). Otherwise uncheck it.
A new row of blank fields for defining a further default value is automatically added beneath
the existing rows whenever a default value is defined.
Click the Apply button to save the default values, or the Reject button to undo any changes
made since the window was accessed.
Autonaming
When a new record is created, the name of the new record may be automatically completed
in a format defined by an autonaming rule.
To switch on autonaming, click Autonaming Setup in the Admin Tools group of the Admin
tab.
Note: The Admin tab is only displayed if the user is a member of the TAGSADMIN team.
Refer to the Administration User Guide for further information.
Autonaming rules are defined and selected using facilities accessed from the Define
Naming Rules button.
To turn on autonaming, check the Auto Naming On/Off checkbox.
5.6.3 Renaming
To rename a record, select it and click the down-arrow button next to the Edit option in the
Records group of the Home tab. From the menu that is then displayed, click Rename:
Or right-click on the record and select the Rename option from the menu that is then
displayed.
The Rename option is disabled if more than one record is selected.
The Rename element window is then displayed:
Or right-click on the list and select the Auto Rename option from the menu that is then
displayed.
The selected records are then renamed according to the current autonaming rules for the
elements in question.
The window lists all the columns in the list. Click the Selected checkbox next to a column if
it is to be edited and enter the required value in the Value field.
Repeat this for every column that is to edited. Check the Select all checkbox to check all
Selected checkboxes.
Once all required columns have been selected and values entered for them, click OK. The
window closes all the selected records are updated.
For example, to set the description of every selected record to “Drum”, check the Selected
checkbox for the DESC column, and enter “Drum” in the Value field. When OK is clicked,
the value in the DESC fields for every selected record is set to “Drum”. Existing values are
overwritten.
Note: The “first record” does not necessarily mean the first (upper-most) record listed of
those selected, it means the first record that was selected when the selection of
multiple records was made.
The Value fields are then populated with the values of the first record.
Select columns to update with these values as described above, and click OK to apply
these values to the other selected records.
To delete records, select the records and either click Delete in the Records group of the
Home tab, or right-click and select Delete from the menu that is then displayed.
Multiple records can be deleted.
A message is then displayed requesting that the user confirm the deletion.
Note: Records can also be deleted using the explorer. Refer to Explore the Database for
further information.
Undo Undoes the last change made to data in a list, including the adding and
copying of records.
Note: Changes made prior to the last save (see Save Changes) cannot be
undone.
Multiple changes can be undone by using this facility, i.e. each time the button
is clicked the previous change is rolled back.
Redo Reverses the last undo (see above) made to data in a list.
Multiple undoes can be reversed
A progress bar is displayed while the list data is updated. The update can be cancelled if
required by clicking the Cancel button. When the update is complete, changes to the data
are highlighted in colour.
Difference highlight colours are used for difference types of changes. Modifications are
highlighted in yellow. New records are highlighted in green. Deleted records are highlighted
in red.
Details of the refresh process and its results are displayed in the status bar and recorded in
the Message Log (see Messages in the Status Bar and Message Log).
Enter a session comment as required and click OK to complete the save. Click Cancel to
cancel the save.
If the Prompt for Session Comment during Save Work checkbox is not checked, the
save will take place immediately.
Note: After changes have been saved, they cannot be undone using the Undo facility (see
Undo and Redo Changes).
Find Text
To find text within a list or column heading enter the string to be searched for in the Find
field in the Find Replace group of the Home Tab.
To specify whether the string should be searched for in a list and/or a column headings, click
the arrow to the right of button next to the Find field to access the following drop-down list:
Select the Search in Headings and/or Search in Data Values options as required. Both
may be selected at once. If only one option is selected, if that option is then de-selected, the
other option automatically becomes selected.
To start the search, click the button with the binoculars symbol next to the Find field.
If searching within column headings, the first heading that contains a match is then
highlighted.
If searching within data values, the first row that contains a match is then highlighted and the
cell that contains the match is selected.
Click Next or the button again the find the next match. Click Previous to select previous
matches for the current search.
If searching within both headings and data values, matches within column headings are
highlighted first, followed by matches within the list.
If no matches are found, a message is displayed to inform the user of this.
The drop-down list in the field lists all the strings searched for in the current sessions.
Alternatively, click Find in the drop-down list accessed from the arrow to the right of button
next to the Find field, or right-click on a list and select the Find and Replace option from the
menu that is then displayed. The Find and Replace window is then displayed:
Enter the string that is to be searched for in the Find what field. If the string has already
been searched for during this session, it can be selected from the drop down list accessible
from this field.
By default, the search is conducted down the list, column by column.
To change the search order, or to selected option to conduct a more refined search, click the
+ button. Additional fields are then displayed in the window:
If the search is to be conducted row by row instead of column by column, click the By Row
option.
If the search is to be conducted from the bottom of the list upwards instead of from the top of
the list downwards, click the Up option.
To refine the terms of the search, check the Match case, Match entire cell contents.
Match prefix and/or Match suffix checkboxes as required.
To proceed with the search, click Find Next.
The cell that contains the first match is then selected.
Click Find Next again to find the next match.
If no matches are found, a message is displayed to inform the user of this.
Click Close to exit the window.
Replace Text
To find and replace text either click Replace in the drop-down list accessed from the arrow
to the right of button next to the Find field, or if the Find and Replace window is already
open, click on the Replace tab.
The Replace tab of the Find and Replace window is then displayed:
The window displays a preview of the list. Click the Print toolbar button to print it, or select
the Print option from the File menu. The File menu also includes a Page Setup option,
which accesses the standard Windows Page Setup window.
Thumbnail images of each page are displayed in the left-hand pane of the window. The
section of the page currently being viewed in the main viewing pane is enclosed in the
thumbnail (see the example above).
To close and open the thumbnail pane, select the Thumbnails option from the View menu.
Toolbar buttons:
Hand Tool Used to drag the page view in any direction. Click on the page
with this tool activated, drag the page until the required view is
visible, then release the mouse button.
Also available on the Tools menu.
Dynamic Zoom When this tool is active, the page will be zoomed into when the
Tool cursor is dragged up the page or the mouse wheel rolled up, and
zoomed out when it the cursor is dragged down or the mouse
wheel rolled down.
Also available on the Tools menu.
Zoom In Tool When this tool is active, left-clicking the mouse on a page will
zoom into that page to the next standard zoom level.
Also available on the Tools menu.
Zoom Out Tool When this tool is active, left-clicking the mouse on a page will
zoom out from that page to the next standard zoom level.
Also available on the Tools menu.
Page Width Sets the view to same width as the current page.
Also available on the View menu.
Margin Width Sets the view to the width of the margins of the grid image on the
current page.
Also available on the View menu.
Whole Page Sets the view to display the entire current page.
Also available on the View menu.
Zoom In Zooms into the page to the next standard zoom level.
Also available on the View menu.
Zoom Used to change the zoom level the value selected from the list
accessed from this field, or typed into this field.
Also available on the View menu.
Zoom Out Zooms out from the page to the next standard zoom level.
Also available on the View menu.
Continuous Removes the gaps between the different pages of the preview in
the main view. Click this button again to replace the gaps.
Page Layout Opens a drop-down list from where various page layout options
can be selected.
The PBS (Project Breakdown Structure) Explorer allows presenting database content
depending on user needs. It is accessible in Home ribbon tab in Database group:
The data can be shown as one or more user-defined structures. Each structure is shown in
the explorer as a hierarchy starting from separate root node and can show database items
organised according to their belonging to system, class, etc., depending on definition in
Lexicon (for more information please refer to Project Breakdown Structure chapter in
Lexicon User Guide).
The PBS Explorer tree is generated during runtime from Lexicon definition and its nodes
can represent database items as well as just label texts generated from definition. By
selecting node connected to database item, user can navigate database hierarchy (set
current element). Also, context menu with basic commands is available for relevant nodes.
To explore the project database hierarchy, click Explore in the Database group of the
Admin tab. The Database explorer is then displayed:
If the Track CE checkbox is checked, the attributes of the element currently selected in the
hierarchy (the Current Element) are displayed to the right of the explorers.
When a different element is selected, the attributes of the element are automatically
displayed.
The displayed attributes may be edited if required.
Note: If the database has been set to Explicit Claim mode, before elements can be edited
they must first be claimed. Refer to Manage Claims for further information.
If an attempt to edit an unclaimed element in such a database is made, the edit will
fail.
A message will be issued explaining why (refer to Messages and the Message Log),
and the cell feedback colour will be set to that indicating an unsuccessful edit (see
Feedback Colours).
See also:
View Group
Alphabetically Used to set attributes to be displayed as a list (the default
setting).
Categories Group
Select Used to specify which attribute categories are displayed for
the currently selected type of object. The following window is
displayed:
Manage Clicking the arrow next to Select and then Manage displays
the Manage Category Filters by Element Type window. The
category filters, are used to determine which categories can
be displayed in the Attributes window and managed by the
user.
Expand All If attributes are displayed broken down into categories, this
Categories option is used to expand all categories.
Collapse All If attributes are displayed broken down into categories, this
Categories option is used to collapse all categories.
Display Group
User Defined Used to show or hide the display of user defined attributes in
Attributes the list of attributes.
Show Unset/Nulref Used to toggle on and off the display of unset and nulref
values.
New Explorer Opens a sub-menu from which another Explorer window can
be opened, either displaying the current element and its
members, or the owner element of the current element and
its members.
In addition to the common options above, the following options are available on the right-
click menu in the Engineering explorer:
8 Data Management
The following data management facilities are provided in the Tags Module:
• Facilities for viewing and changing the project lifecycle status of elements. Refer to
View and Change Status.
• Facilities for highlighting changes to data between sessions. Refer to View Changes.
• Facilities for claiming and managing database claims. Refer to Manage Claims.
• Facilities for comparing attributes in other AVEVA product databases and updating and
linking them if required. Refer to Compare / Update / Link Attributes.
Facilities are also provided to export data to AVEVA NET, and to export and import data to
and from Excel spreadsheets. Refer to Import and Export for further information.
A progress bar is displayed while the list is searched for all objects at the selected status.
The search can be cancelled if required by clicking the Cancel button. When the search is
complete, items at selected status are selected and highlighted:
The selected elements can then be collectively changed to another status as explained
below.
To change the status of an element or elements to the next status in the lifecycle, select
them in a list and click Promote in the Status Actions group of the Manage tab.
To change the status of an element or elements to the previous status in the lifecycle, select
them in a list and click Demote.
Note: Multiple elements at different status may be promoted or demoted using these
options.
To change the status of an element or elements to any status in the lifecycle that those
elements can be promoted or demoted to from the status it they are currently at, select them
in a list and click Edit.
Note: In this case, if multiple elements are selected they should be at the same status.
If the Promote or Demote options were selected, the Status - Tag Status window is
displayed as follows:
The window lists the names of the selected elements, the time and date of the last status
modification and the identity of the user who made that change, and if all the selected
elements are at the same status, the status that these elements will be promoted or
demoted to.
If required, enter a comment in the Comment field.
Click OK to apply the status change.
If the Edit option was selected, a different version of the Status - Tag Status window is
displayed:
In this case, the status to be applied to the selected elements may be chosen from a list of
available status. The list will consist of all status that the elements may be changed to,
according to the definition of the lifecycle.
As described above, enter a comment if required and click OK. To apply the status without
exiting the window, click Apply instead.
If multiple elements are selected that are different status, or had their status changed at a
different time and/or by a different user, “mixed” will be displayed instead of the data in
question. For example:
The current status of the element will be listed as “Not Controlled”, meaning they are not on
the current lifecycle. As described above, select the required status to apply to the element,
enter a comment if required, and click OK or Apply.
The log can be printed or exported to an Excel spreadsheet by right-clicking and selected
the required option from the menu that is then displayed.
If Export to Excel is selected, the Save as dialog is displayed. Refer to Export to AVEVA
NET for further information.
If Print Preview is selected, the Print Preview window is displayed. Refer to Print a List for
further information.
A Refresh option is available to update the log with any changes made since it was opened.
Each coloured segment of the chart represents a status in the lifecycle currently selected for
the list, as explained in the legend.
Hover the mouse cursor over a segment to view to percentage of selected elements that the
segment represents.
To display the list of selected elements that a segment represents, right-click on it and select
the List Elements option from the menu that is then displayed.
A window is then displayed listing the elements represented by the segment:
To edit the status of the elements that a segment represents, right-click on it and select the
Edit Status option from the menu that is then displayed. The Status - Tag Status window is
displayed then displayed. Select the required status for the selected elements as described
in Change Status of Elements.
To view a log of the status changes that have been applied to the elements that a segment
represents, right-click on it and select the Status History option from the menu that is then
displayed. The Status History window is then displayed. Refer to View Log of Status
Changes for further information.
Right-click on the report background to display a menu with options for:
• printing reports (the Print Preview window is displayed - refer to Print a List for further
information),
• saving reports as .xml files,
• loading saved reports,
• refreshing reports with any changes made since they were opened.
The window is used to select a target session and a base session. Stamps may also be
selected. The target session defaults to the current session. To select a different target
session or a stamp, and to select a base session or stamp, click the appropriate ... button.
The Select Session dialog is then displayed:
The Sessions tab displays the list of available sessions. The Stamps tab displays the list of
available stamps. Select the required session or stamp and click OK.
The Choose Historical Database Session window then displays the selected session:
Difference highlight colours are used for difference types of changes. Modifications are
highlighted in yellow. New records are highlighted in green. Deleted records are highlighted
in red.
Changes between the last and current sessions are then highlighted as described above.
Note: If a record is based on different database elements, the user will be prompted to
specify which element historical data is to be displayed for.
Details of the history of the selected record or cell are then displayed as a new list tab.
Details of the history of the selected record or cell are then displayed as a new list tab (see
above for an example).
why (refer to Messages and the Message Log for further information).
Data Management facilities in the Tags Module enable users to:
• View the current local and extract claim state of elements in a list.
See View Local Claim State of Elements and View Extract Claim State of Elements..
• Claim and release elements from a local claim.
See Claim Elements to Local Claims and Release Elements from Local Claims.
• Claim, release, flush, issue and drop elements from an extract claim.
See Claim Elements to Extract Claims, Release Claimed Elements from Extract
Claims, Refresh Extracts, Flush Extracts, Issue Extracts and Drop Extracts.
For further details of Extracts, Claims and related concepts and procedures, refer to the
Administrator User Guide.
If only some of the attribute groups of an element have been claimed to a local claim and the
highlight option was selected, only the columns in the claimed attribute groups are
highlighted.
The default highlighting colour can be changed via the Feedback Colours option in the
Grid Options group of the View tab (refer to Feedback Colours for further information).
To remove highlighting, click Reset Cell Feedback in the Grid Actions group of the Home
tab.
Select the required options on the Show in List tab of the window to specify whether:
• the rows of elements claimed to an extract will either be selected or highlighted
(displayed with a different background colour).
• all elements not claimed to an extract, all elements claimed to an extract, only those
that have been modified, or only those not modified are to be selected/highlighted.
Click OK. The window then closes and a progress bar is displayed while the extract states
of the elements in the list are queried.
The elements are then selected/highlighted in accordance with the selected options.
If only some of the attribute groups of an element have been claimed to an extract, and the
highlight option was selected, only the columns in the claimed attribute groups are
highlighted.
The default highlighting colour can be changed via the Feedback Colours option in the
Grid Options group of the View tab (refer to Feedback Colours for further information).
To remove highlighting, click Reset Cell Feedback in the Grid Actions group of the Home
tab.
The All Claimed Elements tab lists all elements claimed to an extract and can be used to
flush, issue and drop claims.
Refer to Flush Extracts, Issue Extracts and Drop Extracts for further details.
or
• select the elements in a list and then right-click and select the Claim option from the
menu that is then displayed, or
• in the Engineering tab of the Database explorer (see Explore the Database), right-click
on an element, group or world and select the Claim option from the menu that is then
displayed.
The Claim Records window is then displayed:
The window lists the attribute groups associated with the selected elements, and the
columns in each attribute group.
To claim an attribute group to a local claim, ensure the appropriate Select checkbox is
checked (this is the default setting).
Click OK. The selected elements/attribute groups are then claimed to form a local claim.
If a selected element or attribute group has already been claimed by another user, the claim
will fail. An error message will be issued explaining why.
• select the elements in a list and click Claim in the Records group of the Home tab.
From the menu that is then displayed, click Release.
or
• select the elements in a list and then right-click and select the Release option from the
menu that is then displayed, or
• in the Engineering tab of the Database explorer (see Explore the Database), right-click
on an element, group or world and select the Release option from the menu that is
then displayed.
The Release Records window is then displayed:
The window lists the attribute groups associated with the selected elements, and the
columns in each attribute group.
To release an attribute group, ensure the appropriate Select checkbox is checked (this is
the default setting).
Click OK. The selected elements/attribute groups are then released from the local claim.
If a selected element/attribute group has been edited, it must be saved before it can be
released. If it is not, the release will fail. An error message will be issued to explain why.
The window lists the attribute groups associated with the selected elements, and the
columns in each attribute group.
To claim an attribute group to an extract claim, ensure the appropriate Select checkbox is
checked (this is the default setting).
Click OK. The selected elements/attribute groups are then claimed to form an extract claim.
If a selected element or attribute group has already been claimed by another user, the
extract will fail. An error message will be issued explaining why.
The window lists the attribute groups associated with the selected elements, and the
columns in each attribute group.
To release an attribute group, ensure the appropriate Select checkbox is checked (this is
the default setting).
Click OK. The selected elements/attribute groups are then released from the extract claim.
If a selected element/attribute group has been edited, it must be saved before it can be
released. If it is not, the release will fail. An error message will be issued to explain why.
The refresh then takes place. Changes are indicated using the highlight colour.
The window lists the attribute groups associated with the selected elements, and the
columns in each attribute group.
To flush an attribute group, ensure the appropriate Select checkbox is checked (this is the
default setting).
The window lists the attribute groups associated with the selected elements, and the
columns in each attribute group.
To issue an attribute group, ensure the appropriate Select checkbox is checked (this is the
default setting).
If required, enter a comment regarding the issue in the Comments field.
Click OK. The parent extract or database is then updated with any changes made to
selected elements/attribute groups, and the selected elements/attribute groups are
released.
If a selected element/attribute group has been edited, it must be saved before it can be
issued. If it is not, the issue will fail. An error message will be issued to explain why.
The window lists the attribute groups associated with the selected elements, and the
columns in each attribute group.
To drop an attribute group, ensure the appropriate Select checkbox is checked (this is the
default setting).
If required, enter a comment regarding the drop in the Comments field.
Click OK. The selected elements/attribute groups are then dropped and released, and all
modifications made to them are undone.
From upper list in Source Selection group, select the data source with which Tags data is
to be compared etc:
If AVEVA Electrical, AVEVA Instrumentation or AVEVA P&ID is selected, the next step is to
select an Electrical, Instrumentation or P&ID project via the Login option which is then
displayed on the Compare/Update - Actions tab.
If attribute mappings and filters have previously been set up the compare process will then
start automatically.
If attribute mappings and/or filters have not been set up, the user will be prompted to set
these up.
The results of the process are displayed in the Compare/Update window:
Elements Once the source database has been selected, used to select
the type of elements that the compare/update process is to
be the subject of.
Source Group
Login / Logoff The Login option is used to select and connect to an AVEVA
Electrical, AVEVA Instrumentation or P&ID database.
The option changes Logoff once a connection is
established.
Not displayed if the data source is a Design, Schematic or
Engineering database.
Destination Group
Update Database Used to display the Update Engineering Database window,
which is used to view comparison process statistics and
options, and to apply updates to Tags data.
Configuration Group
Accept All / Reject All Used to accept or reject all changes all compared objects.
If the checkbox is checked, the label is set to Accept All. If
the checkbox is unchecked, the label is set to Reject All.
Data can be exported and imported to and from Excel spreadsheets. It can also be exported
to AVEVA NET.
• Import from and Export to Excel
• Export to AVEVA NET
Data in Tags can also be updated with data from other databases. See Compare / Update /
Link Attributes for further information.
Note: The Admin tab is only displayed if the user is a member of the TAGSADMIN team.
Refer to the Administration User Guide for further information.
For more information on setting up the interface, refer to AVEVA NET Schematic Gateway
Configuration Guide.
To export data to AVEVA NET from a list, open the list and click Publish to AVEVA NET in
the AVEVA Integration group of the Manage tab.
Note: In order for data to be exported to AVEVA NET from a list, the Can be published to
AVEVA NET checkbox for that list must be checked on the View tab of the List
Manager window. Refer to Create a List for further information.
If this checkbox is not checked, the Publish to AVEVA NET option will be disabled.
The schematic diagrams, schematic models and documents associated with an element
can be viewed in Tags. In the case of documents, further documents can be linked to
elements. Refer to:
• View Schematic Diagrams
• View Schematic Models
• View and Add Document Links
Diagram Group
Open Used to select and open a schematic diagram.
View Group
Zoom In When this tool is active, left-clicking the mouse on a diagram
will zoom into that diagram to the next standard zoom level.
Zoom Out When this tool is active, left-clicking the mouse on a diagram
will zoom out from that diagram to the next standard zoom
level.
Zoom To Selection Used to zoom to a selected area of the diagram. Select this
button 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 Used to zoom 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 Used to toggle the mode for auto-zoom. When this option is
Selection toggled on, selecting an element will zoom the diagram to
display that element and highlight it.
Bookmarks Group
Set Bookmark Used to save the current view of a diagram. Saved views
are known as bookmarks.
Previous Bookmark Used to set the view to the bookmark that was set before the
current bookmark.
Next Bookmark Used to set the view to the bookmark that was set after the
current bookmark.
Once the sessions/stamps have been selected, the changes to diagrams between sessions
are displayed in the Diagram Change Highlighting window.
Diagram Group
Open Opens the Select Diagram and Sessions to Compare
window so that a new session comparison can be made.
Highlighting Group
Highlight New Used to highlight new elements on the diagram in the
Elements selected highlight colour for new elements.
View Group
Zoom In Used to zoom into a diagram to the next standard zoom
level.
Zoom Out Used to zoom out from a diagram to the next standard zoom
level.
Zoom to Fit Used to zoom a diagram out so that the entire diagram is
visible
Auto Zoom on Used to toggle the mode for auto-zoom. When this option is
Selection toggled on, selecting an element will zoom the diagram to
display that element and highlight it.
Configuration Group
Attribute Configuration Used to specify which attributes are to be considered when
comparing changes to diagrams, i.e. changes to specific
attributes may be ignored if required.
Highlight Colour Used to set the colour used to highlight new, deleted and
Configuration modified elements.
The Schematic Model Viewer is then displayed, showing the element within the schematic
model. Refer to the Diagrams User Guide for further information.
To browse for and open an element to view within the Schematic Model Viewer, either click
Model View in the View group of the View tab when an element is not selected in a list, or
click on the arrow under the Model View option and select View Model from the menu that
is then displayed.
The Select Equipment window is then displayed, from which the required element can be
selected and opened in the Schematic Model Viewer. Refer to the Diagrams User Guide
for further information.
Model Group
Open Used to browse for and open a element to view within the
Schematic Model Viewer.
Visibility Group
Pipe lines Used to toggle the display of pipe lines within a model view.
HVAC lines Used to toggle the display of HVAC lines within a model view
View Group
Centre Used to generate a new view, with the item currently
selected in the model view at its centre.
Show Inline Items Used to toggle the display of inline items within a model
view.
Continue at:
• View Links
• Create Worlds and Classes
• Add and Edit Links
Links are organised in the link classes which are in turn collected into link worlds. Refer to
the Database Management Reference Manual for further details of this links worlds and
classes.
To view the links which have been assigned to a class, select it from the explorer. The links
assigned to the selected class are then listed in the middle, Linked documents in class
pane:
To view the classes a link has been assigned to click on that link in the Links tab or the
Folders/Classes tab. In the right-hand Assign Classes pane, the classes to which the link
has been assigned are indicated with a tick against them:
To create a new world, right-click on a space in the left-hand section of the Folders/Classes
tab and select the New world option from the menu that is then displayed.
A node for the new world is added to the explorer. Enter a unique name for it:
To add a class to a world, right-click on the world node, or on a sub-folder in that world (see
below), and select the New class option from the menu that is then displayed:
A new node is then created for the class under the selected world. Enter a unique name for
it:
If required, sub-folders may be added to the hierarchy under the world level into which
classes may be placed. To add a sub-folder, right-click on a world node or on an existing
sub-folder, select New folder from the menu that is then displayed, and enter the name of
the folder:
Classes and further sub-folders can then be added to the new folder as required. For
example:
To delete a world, class or folder, right-click on it and select Delete or click on it and press
the Delete key.
To rename a world, class or folder, right-click on it and select Rename, and enter the new
name.
World, classes and folders can be cut, copied and pasted using the appropriate options on
the right-click menu, by dragging and dropping in the normal way, and by using the standard
keyboard commands. The names of copied items are suffixed with “-COPY”.
To add an existing link to the element, click on the Existing link category (the window
defaults to this category if there are any existing links).
The Link options pane displays the hierarchy of worlds and classes as described above. It
also displays the existing links in each world.
To select an existing link, click on it, and then click OK. The link is then assigned to the
element:
Enter a unique name for the link and a description. Click Choose file to browse for the file,
or enter the file path and name in the Path to file field.
Click OK to add the link to the element.
To add a link to a web page, click on the Web page category:
Enter a unique name for the link and a description. Click Browse to browse for the web
page, or enter the URL in the Address field.
If Browse is clicked, a browser is opened. Browse to the required web page and then close
the browser. The Address field is then completed with the URL of the web page.
Click OK to add the link to the element.
To add a link to an e-mail address, click on the E-mail address category:
11 Reports
The window is used to select the template (a .repx file) to be used as the basis for the new
report.
To select a template, first select the template location from the Look In drop-down:
If Yes is selected, a new report is then created based on the selected template and
displayed in Reporting Designer. Reporting Designer facilities can then be used to save,
print and/or export the report.
If No is selected, a new report is created with the data source as the fields in the current list
but without the layout as defined by the selected template applied. The user may then
define the appearance of the new report using Reporting Designer facilities, and then save
and/or export the report as required.
For further information on Reporting Designer, refer to the Reporting User Guide.
12 Datasheets
The Datasheets functionality available in the module provides the user with the ability to
create, revise, view, export and compare datasheets. These datasheets are stand-alone
documents which can be created for tagged items.
12.1.3 Datasheet
A datasheet must be created below a DSIGRO element, to create a Datasheet Instance
(DSINST) element, right click the DSIGRO element in the Database Explorer, select New >
DINST: Datasheet Instance.
The datasheet instance is created with a default name, the attributes and properties of the
datasheet are displayed in the current editor element.
Or, on the View tab, in the Datasheets group, click Datasheet, select New from the drop-
down list to display the Datasheet window.
All of the tasks that a user would carry out that are associated with the creation or
modification of a datasheet are initiated from a central window which acts as a task hub.
Depending on selections made in the Datasheet window the user will be presented with
further prompts requiring user input, allowing the workflow to continue.
From the Datasheet window, the user must select a datasheet template, name and tag for
the datasheet. The Misc attributes of the optional, populate as required.
Select a datasheet template form the list of available templates, refer to Datasheets for
more information.
Enter a name for the new datasheet or use the autonaming functionality.
To specify the engineering tag item from which the datasheet is to be created. Select
Browse, the Reference Picker window is displayed.
From the list of displayed engineering tag items, select the required engineering tag item,
then click Add. The Reference Browser window is displayed.
The new DSINST element is displayed in the database explorer and the datasheet is
displayed alongside the CE editor.
Modify Datasheet
Tag attributes displayed in the grid can be modified and the corresponding attribute in the
datasheet is then automatically updated to reflect the modification and vice versa.
Open datasheet
On the Home tab, in the Datasheets group, click Datasheet, select Open from the drop-
down list to display the Datasheet window.
Or, on the View tab, in the Datasheets group, click Datasheet, select Open from the drop-
down list to display the Datasheet window.
The Open tab of the Datasheet window is populated with existing datasheets. Click to
highlight the required datasheet, click OK to display the required datasheet. Or click Cancel
to discard any inputs and close the datasheet window.
Datasheet Revision
Datasheets which have been revised can be viewed and opened, on the Home tab, in the
Datasheets group, click Datasheet, select Open Revisions from the drop-down list to
display the Datasheet window.
Or, on the View tab, in the Datasheets group, click Datasheet, select Open Revisions from
the drop-down list to display the Datasheet window.
The Revisions tab of the Datasheet window is populated with existing datasheets which
have been revised. Click to highlight the required datasheet, click OK to display the required
datasheet.
Edit datasheets
The common functionality to edit a datasheet, such as Cut, Copy, Paste Undo and Redo is
available to the user for selection from the Clipboard group and quick access toolbar.
Publish Datasheets
Datasheets and lists can be published to a variety of formats:
• Print a hard copy
• Export as Excel
• Export as PDF
• Publish to AVEVA NET.
Export as Excel
A current list or datasheet or a selection from the database can be exported to Excel for
example: Current Datasheet.
On the Manage tab, in the Import/Export group, click Excel Export Wizard, select Current
Datasheet, export the current datasheet in an excel format to any location.
Export as PDF
A current list or datasheet can be exported to pdf for example: Current Datasheet.
On the Manage tab, in the Import/Export group, click Pdf Export, select Current
Datasheet, export the current datasheet in a pdf format to any location.
On the Manage tab, in the Integration group, click Publish to AVEVA NET, select Current
Datasheet.
The datasheet can be published as MHTML format to any staging area specified by the
user. Refer to Import and Export for further information.
Import Datasheet/List
Datasheet or lists can be imported and then compared with currently opened datasheet. To
import and compare a datasheet. On the Manage tab, in the Integration group, click Excel
Import, select Import.
From the displayed Open window, select the datasheet to be imported and compared with
the current datasheet.
All of the mappings from the imported datasheet are compared with the current datasheet
and displayed in the displayed Datasheet Import window.
The highlighted rows are the imported mappings which differ from the current datasheet
mappings, the differences are also highlighted in the datasheet.
To update the current datasheet to reflect the mapping differences, from the Datasheet
Import window, select the Accept check box alongside the highlighted row. Then on the
Manage tab, in the Integration group, click Excel Import, select Current Datasheets then
Update from the drop down list.
Once the mappings that differ are updated, the status column is added to the Datasheet
Import window.
If required the user can refresh the datasheet (that is the imported datasheet is compared to
the current datasheet and the Datasheet Import grid is automatically repopulated).On the
Manage tab, in the Integration group, click Excel Import, select Current Datasheet then
Refresh.
From the Datasheet part of the Datasheet Configuration window, the user can select the
owner (the hierarchy) of the datasheet, see the Reference Browser window.
The Change Highlighting part of the Datasheet Configuration window allows the user to
specify how differences between the last revision and working version are highlighted.
Cell position changes Highlights the cell with changes in unit of measure.
Unit of measure Highlights the mappings whose cell position has changed
changes (the mappings are copied to another cell).
Sort order of list items Highlights all the list of value mappings with change in
sorting order.
If any changes are made to datasheet with free text, the user is asked if the changes to the
data sheet are to be saved as a revision. The revised datasheet will be saved to the
following location: Project Default folder\Data\Datasheets\Instances.
The Watermark part of the Datasheet Configuration window allows the user to format a
watermark for the datasheet.
Colour Select the required colour for the watermark from the drop-
down list.
Font Select the required font for the watermark from the drop-
down list.
Size Select the required font size for the watermark from the
drop-down list.
Click OK, all the settings are saved in DatasheetInstanceSettings.xml file at Project
Default folder\Data\Datasheets or click Cancel to discard any inputs and close
the Datasheet Configuration window.
Index
Publish H
AVEVA NET . . . . . . . . . . . . . . 12:11
Export as Excel . . . . . . . . . . . 12:10 Hierarchy
Export as PDF . . . . . . . . . . . . 12:10 DSIWLD . . . . . . . . . . . . . . . . . . . . . 12:1
Print . . . . . . . . . . . . . . . . . . . . 12:10 Highlight Changes between Sessions . . 8:9
Default Units of Measure . . . . . . . . . . . . 3:1 Highlight Changes in Schematic Diagrams 10:2
Delete Records . . . . . . . . . . . . . . . . . . . 5:32 History of Changes . . . . . . . . . . . . . . . . 8:12
Diagram Change Highlighting - Actions Tab Home Tab . . . . . . . . . . . . . . . . . . . . . . . 2:4
10:3
Diagram Viewer . . . . . . . . . . . . . . . . . . 10:1 I
Diagram Viewer - Actions Tab . . . . . . . 10:2
Display Lists in Windows . . . . . . . . . . . . 5:6 Issue Extracts . . . . . . . . . . . . . . . . . . . . 8:23
Document Links . . . . . . . . . . . . . . . . . . 10:4
Add and Edit . . . . . . . . . . . . . . . . . . 10:8 L
Classes . . . . . . . . . . . . . . . . . . . . . . 10:5
Worlds . . . . . . . . . . . . . . . . . . . . . . 10:5 List Categories
Drop Extracts . . . . . . . . . . . . . . . . . . . . 8:24 Create . . . . . . . . . . . . . . . . . . . . . . . 4:1
Delete . . . . . . . . . . . . . . . . . . . . . . . 4:3
Edit . . . . . . . . . . . . . . . . . . . . . . . . . . 4:3
E Lists
Edit Cell Data . . . . . . . . . . . . . . . . . . . . 5:21 Auto Rename . . . . . . . . . . . . . . . . . 5:30
Excel Autonaming . . . . . . . . . . . . . . . . . . 5:28
Import from Excel . . . . . . . . . . . . . . . 9:1 Categories . . . . . . . . . . . . . . . . . . . . 4:1
Explore the Database . . . . . . . . . . . . . . . 7:1 Close . . . . . . . . . . . . . . . . . . . . . . . . 5:3
Export to AVEVA NET . . . . . . . . . . . . . . 9:1 Copy . . . . . . . . . . . . . . . . . . . . . . . 4:14
Export to Excel . . . . . . . . . . . . . . . . . . . . 9:1 Create . . . . . . . . . . . . . . . . . . . . . . . 4:4
Extract Claims . . . . . . . . . . . . . . . . . . . . 8:12 Create Lists . . . . . . . . . . . . . . . . . . . 4:1
Claim Element to Extract Claims . . 8:20 Create New Records . . . . . . . . . . . 5:26
Drop Extracts . . . . . . . . . . . . . . . . . 8:24 Delete . . . . . . . . . . . . . . . . . . . . . . 4:14
Flush Extracts . . . . . . . . . . . . . . . . . 8:22 Delete Records . . . . . . . . . . . . . . . 5:32
Issue Extracts . . . . . . . . . . . . . . . . . 8:23 Display Lists in Windows . . . . . . . . . 5:6
Refresh Extracts . . . . . . . . . . . . . . . 8:21 Edit . . . . . . . . . . . . . . . . . . . . . . . . . 4:13
Release Claimed Elements from Extract Edit Cell Data . . . . . . . . . . . . . . . . . 5:21
Claims . . . . . . . . . . . . . . . . 8:20 Filter Row . . . . . . . . . . . . . . . . . . . . 5:16
View Extract Claim State of Elements 8:15 Filters . . . . . . . . . . . . . . . . . . . . . . . 5:16
Find and Replace Text in a List . . . 5:33
General Functionality . . . . . . . . . . . . 5:4
F Group List Data . . . . . . . . . . . . . . . 5:14
Feedback Colours . . . . . . . . . . . . . . . . . 5:12 Group List Data by Multiple Attributes 5:15
Filter Row . . . . . . . . . . . . . . . . . . . . . . . 5:16 Layout . . . . . . . . . . . . . . . . . . . . . . . 4:7
Filters . . . . . . . . . . . . . . . . . . . . . . . . . . 5:16 List of Values . . . . . . . . . . . . . . . . . 5:23
Alternate Filtering . . . . . . . . . . . . . . 5:20 Multi-Record Edit . . . . . . . . . . . . . . 5:30
Filter Row . . . . . . . . . . . . . . . . . . . . 5:16 Open . . . . . . . . . . . . . . . . . . . . . . . . 5:1
Multi-Select Filtering . . . . . . . . . . . . 5:17 Print a List . . . . . . . . . . . . . . . . . . . 5:36
Removing Filtering . . . . . . . . . . . . . 5:21 Refresh Lists . . . . . . . . . . . . . . . . . 5:32
Find and Replace Text in a List . . . . . . 5:33 Renaming . . . . . . . . . . . . . . . . . . . 5:29
Flush Extracts . . . . . . . . . . . . . . . . . . . . 8:22 Right-Click Menu . . . . . . . . . . . . . . . 5:3
Save Changes . . . . . . . . . . . . . . . . 5:33
Session Default Values for New Records
G 5:27
Get Work when Save Work is done . . . . 3:2 Short List Titles . . . . . . . . . . . . . . . . 5:6
Group List Data . . . . . . . . . . . . . . . . . . . 5:14 Sub-Lists . . . . . . . . . . . . . . . . . 4:13, 5:2
Group List Data by Multiple Attributes . 5:15 Undo and Redo Changes to Lists . 5:32
Ungroup Data . . . . . . . . . . . . . . . . 5:16