Datasheets templates are created in AVEVA LEXICON module and stored in dictionary database. The instances are created in AVEVA Engineering, Tags Module and stored in engineering database.
To create datasheets templates and datasheet instances as represented above a number of procedures must be followed such as:
In AVEVA LEXICON
Create datasheets template (DSTMPL).
Define datasheets template presentation.
Define Unit of Measure.
Define and assign revision number control to datasheets template.
Add continuation Area (not mandatory – only setup if required).AVEVA Engineering Tags
Create a datasheets instance based on datasheets template created in LEXICON.
Add /modify data in the Datasheets instance.www.aveva.com
Database Views Set for Datasheets – A Worked Example
Although section 4.6.16 covers the definition of Database Views set, as well as its setup and configuration, this is further covered in this section for use within datasheet configuration.
The datasheet feature utilises the Database Views sets within its configuration, and this example describes the creation and configuration of a Database Views set which will be subsequently applied.
Select the created Database View group ‘MECHANICAL-VIEWS’, and create a ‘Database View Set (DBVWSE) using the context menu.
Fill in the attribute details as shown.
Name – PUMP-NOZZLE-DBVIEW-SET
Description- Database Views Set for Pump and Nozzle
User-defined name –
PUMP_NOZZLE_DBVIEW_SET
Relevant Database Views can be directly created under a Database View Set or indirectly linked to existing Database Views as illustrated below:
To do this, select existing Database View ‘MECH-EQUIPMENT-FULL-VIEW’
131
www.aveva.com
© Copyright 1974 to current year.
In the Current Element Editor form, select the “Database View Sets” field browse button and enter the relevant
Database View Set name
“PUMP_MOTOR_DBVIEW_SET”.
Enter the relevant Database View Set name “/PUMP-NOZZLE-DBVIEW-SET”
Select OK button to save the setting
Assign Database View Set “/PUMP-NOZZLE-DBVIEW-SET “to NOZZLE-VIEW Database View, using the same procedure shown above.
www.aveva.com
Create Datasheets Template Records – A Worked Example
Navigate to the Dictionary World /*, select Create from right-click menu and click on DSTWLD option from the right-click submenu.
133
www.aveva.com
© Copyright 1974 to current year.
Enter the following data in the appropriate textboxes:
Name: ENGINEERING-DATASHEETS-TEMPLATES Description: DATASHEETS WORLD
These fields are not mandatory.Navigate to the DSTWLD, select Create from click menu and click on DSTGRO option from the right-click submenu.
www.aveva.com
Enter the following data in the appropriate textboxes:
Name: ENGINEERING-DATASHEETS-TEMPLATES-GROUP Description: DATASHEETS-TEMPLATES-GROUP
These fields are not mandatory
Datasheets Template World (DSTWLD) and Datasheets Template Group (DSTGRO) are the top level containersSelect the created Datasheet Template Group ‘ENGINEERING-DATASHEETS-TEMPLATES-GROUP’, and Create a Datasheet Template (DSTMPL) using the “New Datasheet Template” context menu.
Enter the following data in the appropriate textboxes:
Name: CENTRI-PUMP-DATASHEET-TEMPLATE Description: CENTRIFUGAL-PUMP-DATASHEET-TEMPLATE
135
www.aveva.com
© Copyright 1974 to current year.
Data Source: Select the browse button , next to the Data Source field. The “Add Data Source” dialog is then displayed.
Select the preferred Database View Set “PUMP-NOZZLE-DBVIEW-SET” from the “View Sets” tab and click on the “Add” button.
Template File: The template file field should remain unset.
The “Template file” field is automatically populated with the location file path of the template when created
Datasheet Templates are stored by default in …….project>dflts\Data\Datasheets\Templates Click the “OK” button from the “New Datasheet Template” dialog to create the datasheet template (DSTMPL) and close the dialog form.www.aveva.com
To open the newly created datasheet template, select the datasheet template (DSTMPL) e.g.
“CENTRI-PUMP-DATASHEET-TEMPLATE” from right- click submenu click “Edit Datasheet
Template”.
The Datasheet Template Editor dialog is then displayed.
137
www.aveva.com
© Copyright 1974 to current year.
The Datasheet template is divided into two main areas. The left area shows spread sheet layout, this is mainly used to define the datasheet layout. The right area contains a list of all the attributes contained in the selected Database View. After the creation of the datasheets templates (DSTMPL) the presentation or format can then be defined by Administrator in line with the company template format or user preference using the Datasheet Template Editor Toolbar functionalities as shown below:
Datasheet Template Editor contains buttons that allow end-users to perform below actions in datasheet template editor.
Icons Toolbar button Description
Save datasheet template Allows to save current datasheet template Print Allows to print current datasheet template
Cut cell Allows to cut data, mapping and
presentation of selected cell
Copy cell Allows to copy data, mapping and
presentation of selected cell Paste cell Allows to paste data, mapping and
presentation of selected cell Delete cell Allows to delete data, mapping and
presentation of selected cell Zoom-in Allows zoom-in in various sheets in
datasheet template
Zoom –out Allows zoom-out in various sheets in datasheet template
Add Area Allows to add continuation area to selected cell area
Remove Area Allows to remove the continuation area available in selected cell area Auto Map Allows to auto map the cells on right side of
selected header text cell Bold font Allows to bold font of selected cell Italic font Allows to italic font of selected cell Underline font Allows to underline the font of selected cell
Font Allows to change the font of selected cell Merge/ Unmerge cells Allows to merge or unmerge the selected
cell area(s)
Lock Allows to lock or unlock the selected cell in datasheet instance
Properties Allows to user display or close the Properties window
Template Explorer Allows to user display or close the Template Explorer window
Toolbox Allows to user display or close the Toolbox window
Message Grid Allows to user display or close the Message window
GridLines Allows to user control the display of Grid Lines. This control of the display of Grid
Lines is on a per-page basis.
www.aveva.com
User (s) should be able to design their datasheet templates with different styles of borders and various colours which also reflect in the data sheet instances.
Adding Border to Datasheet Templates
Open the borders window by selecting few cells in the datasheet template and right click, and clicking on the new menu item “Border”.
A new window with title “Border Editor” is then displayed.
139
www.aveva.com
© Copyright 1974 to current year.
Select the preferred border styles and colours e.g. ‘ThickLine’ style and ‘Black’ colour as shown.
After selecting the line style and colour, click on the Outline, Inside buttons in the “Presets” section, which will be used to set the outer/inside borders of the selected cells.
Users can also select or deselect the individual horizontal or vertical buttons in order to set the cell borders in different ways. After the button selections user can see the over view of the border settings in the
“Border” group box. User can also the change the borders by clicking on the “None” button the ‘Presets’ section.
Click on the OK button to display the border in the selected cells.
“Cancel” button is used to close the window and user will not see any changes in the borders of selected cells.
www.aveva.com
The Datasheet Editor also allow user to modify Cell properties such as Height and Width, justification of text in Template Editor, font etc. which apply to the whole row or column, when this is selected.
The format of multiple cells can modified, by selecting the desired cells before updating the value in the properties window.Reference Existing Datasheet Template Excel File
Excel files templates from external source can also be referenced and used in existing datasheets template (DSTMPL) configuration.
Only the XLSX file format from MS Excel 2007 & 2010 are supported141
www.aveva.com
© Copyright 1974 to current year.
Reference Existing Datasheet Template Excel File – A Worked Example
To do illustrate this, navigate to the preferred DSTMPL (e.g. CENTRI-PUMP-DATASHEET-TEMPLATE);
select Properties option from right-click menu to display the “New Datasheet Template” dialog.
From “Template File”, select the browse button , next to the “Template File” field. And select the preferred Excel file from the desired location.
Select the Open button to update the Template File field.
www.aveva.com
Check the “Edit the template when finished” checkbox and click the “OK” button from the “New Datasheet Template” dialog to update the datasheet template (DSTMPL) and open the “Edit Datasheet Template” dialog.
The Datasheet Template Editor dialog is then displayed.
Once the datasheet is displayed, Admin users can insert new rows or columns in the Template Editor if required. This can be achieved by selecting the preferred row/columns and click the ‘New’ option to insert new row /column.
143
www.aveva.com
© Copyright 1974 to current year.
Database Attribute Mapping to Datasheet Template – A Worked Example
To map database attribute (Name) to datasheet cells (Name), drag the required database attribute from the
“Field List” (MECH-EQUIPMENT-FULL) section of the Datasheet Template Editor dialog to the desired cell and drop the Database attribute onto the cell.
If the mapping is successful the default yellow feedback colour is displayed.
If the mapping is successful, when the mapped cells are selected, the corresponding attribute will be highlighted in the database source field
If the mapped database attribute datasheet cells have list of values, a pull down list button will be displayed in the mapped cellTo un-map or un-assign a mapped cell, click on the mapped cell in this case “Name” cell and select Delete icon from the Datasheet Template Editor main toolbar or context menu.
www.aveva.com
Using the same procedure as shown above; map the following database attribute from the “Field List”
(MECH-EQUIPMENT-FULL) section of the Datasheet Template Editor dialog to the appropriate label text cell:
Name Prefix Tag Letter Tag Number Suffix Description Area/Unit
Users can also set the “Behaviour” property of the mapped cell to indicate that the field should be filled in by a supplier when the datasheet instance is exported as an Excel spreadsheet and sent to a supplier to complete some of the information.
This can be achieved by selecting the preferred mapped cell in the case “Description”. Click on the Provide By Supplier from the context menu accessible via Behaviour option.
145
www.aveva.com
© Copyright 1974 to current year.
The Behaviour field in the Properties window is automatically updated for the selected cell.
For cells that have been set with the Behaviour as Provided by Supplier, these cells will remain unlocked by default, with the rest of the cells in the datasheet instance with the rest cell in datasheet instance being locked by default, when exported as an Excel spreadsheet.
Auto Database Attribute Mapping to Datasheet Template
Auto database attribute mapping allows creation and mapping of attributes to the adjacent cell of the selected header text cell.
Automap process runs the below algorithm to find the best possible UDA or attribute for selected header text(s).
Searches the attribute with the same name as of header text in list of data source present in datasheet template
If no attribute exists then, searches the dictionary database for UDA with same name as of header text.
If no match is found, the selected header text row is considered as not matched.
www.aveva.com
Auto Database Attribute Mapping to Datasheet Template – A Worked Example
To automatically create and map database attribute to datasheet cells:
From the displayed datasheet template, select the preferred header text cells e.g. “Stages & No.Operating”.
In the Datasheet Template it is possible to make multi-selections that include merge cells.Select the Auto Map icon from the main toolbar to display the ‘Create and Map’ form.
147
www.aveva.com
© Copyright 1974 to current year.
Matched - Selected header text matches the one of the attribute available in template explorer. User can check the detail for matched UDA and can accept the row to create mapping for adjacent cell.
User can change the attribute name.
Not Matched -Selected header text does not match any attribute in database. User needs to select and specify the required properties to create UDA.Complete the required fields as shown below.
Attribute Name Field – Select the appropriate database attribute name (:NoOperating) from the available pull-down list.
Attribute Names must not contain space. If the label text has equivalent attribute name in the database. Simply modify the displayed attribute e.g. “No.Operating”, should be “NoOperating to remove the space between characters.Data Source Field – Select the appropriate Data source (database view) e.g. “MECH-EQUIPMENT-FULL”.
Data Type Field: Select the appropriate UDA type from the pull-down list e.g. Text.
Category Field: UDA Category, this is not required in this example.
List of Values: UDA Valid values, this is not required in this example.
Unit of Measure: UDA Units; this is not required in this example. This field is only enabled if the UDA type
“real” is selected.
Maximum Length: Enter the appropriate UDA Length e.g. 50. Select the “Accept” or the “Accept All” to enable the “Create and Map” button.Click the “Create and Map” button to create the label text in the database as an attribute and map the attribute adjacent cell to the label text.
www.aveva.com
The “Create and Map” form will display message, if the UDA creation fails, successful or required data is not specified by user.
The selected label text cells are created in the database and mapped to corresponding label text as shown.
Units of Measure Definitions – Unit Sets
The Datasheet Template Editor dialogue gives the Admin user(s) the capability to assign:
User defined Unit Sets to datasheet
Default unit of measure to datasheet This is explained in the following work examples.
The tool also allows the Admin users to set the unit of measure presentation and precision
independently from the project units and precision.
149
www.aveva.com
© Copyright 1974 to current year.
Unit Sets Definition for Datasheet and List columns – A Worked Example
Compound units based on the available base units e.g. m3/s2, ft3/hours2 can be defined in LEXICON and utilised within Datasheet and AVEVA Engineering Tags List columns.
To define desired Unit Sets;
Select “Unit Sets” from the main toolbar and then click on “Configure” from the submenu to display the Unit Sets Configuration form.
Enter or select the following data in the appropriate Unit Sets Configuration form textboxes.
Name: Temperature UnitSet
Dimension: Select from the pull-down list or enter the appropriate dimension e.g.
“Temperature”.
Unit: Enter the relevant Units e.g. degC, degF, K. and select enter icon after each entry.
Add the second Unit Set as shown below, click the ‘New’ button and enter the following details:
Name: Pressure Unit Set
Dimension: Select from the pull-down list or enter the appropriate dimension e.g.
“Pressure”.
Unit: Enter the relevant Units e.g. bar, and psi and select enter icon after each entry.
www.aveva.com
The Unit Set Configuration form supports multiple Unit Sets definitions as shown below
The “New” button is used to create new Unit Sets definitions and “Delete” button to delete existing unit Sets definitions that are not required.Click the “OK” button from the “Unit Sets Configuration” window to save the configuration and close the dialog.
Assigning Default Unit of Measure to Datasheet Cell – A Worked Example
To assign default unit of measure to mapped datasheet template cell with the appropriate unit dimensions.
First map the following database attribute from the “Field List” (MECH-EQUIPMENT-FULL) section of the Datasheet Template Editor dialog to the appropriate label text cell.
Select the desired cell in this example (e.g.H22).and double click
“Unit of Measure” option or drag and drop the “Unit of Measure”
option from the Standard Control menu to the desired cell.
Datasheet Template label text Database Attributes
Min Design Pressure Minimum Design Pressure Max Design Pressure Maximum Design Pressure
Max Design Temp Maximum Design Temperature
Min Design Temp Minimum Design Temperature
151
www.aveva.com
© Copyright 1974 to current year.
Datasheet Editor also supports the mapping of Unit of Measure control to multiple cells.Select the relevant mapped cell in this case “Max Design Pressure” and assign the appropriate “Unit of Measure” (e.g. UoM1-25-8) from the right click menu.
The cell Properties is automatically updated with selected Unit of Measure value.
Use the same procedure as shown above; assign the same Units of measure group (e.g. UoM1-25-8) to
“Min Design Pressure” mapped cell.
Select the pull-down list button from the mapped Unit of Measure cell to display all the associated unit derivatives.
www.aveva.com
To change the “Unit of Measure” Name (e.g. UoM1-25-8) to preferred name.
Select the appropriate mapped Unit of Measure cell and enter the desired name, in this case “Pressure” in the “Properties” section of the Datasheet Template Editor dialog.
153
www.aveva.com
© Copyright 1974 to current year.
Assigning Unit Sets to Datasheet – A Worked Example
Users can also assign a user-defined Unit set to datasheet template mapped cells that has the appropriate unit dimensions, if the user chooses not to use the default unit of measure.
To do this; select the desired Unit Sets with appropriate assigned mapped cell. From the Properties window select the preferred Unit Sets definitions from the Unit Sets pull-down list as shown.
Select the pull-down list button from the mapped unit cell to display all the associated unit derivatives.
To set preferred presentation precision if required, click on the Unit of Measure pull-down list button.
Click the “Set Precision” tab. The “Set Display Precision” dialog is then displayed.
www.aveva.com
In the “Set Display Precision” dialog, increase the precision value to “3”
using the button as highlighted.
In the “Properties” section of the “Datasheet Template Editor”
dialog, the Precision Value can also be increase or decrease by entry preferred value in the Precision field.
Select the appropriate Unit Sets definitions from the Unit Sets pull-down list as shown.
155
www.aveva.com
© Copyright 1974 to current year.