SYS600 - Historian Monitor Configuration
SYS600 - Historian Monitor Configuration
5
Historian Monitor Configuration
Document ID: 1MRK 511 642-UEN
Issued: February 2023
Revision: A
Product version: 10.5
Table of contents
Section 1 Copyrights......................................................................................................5
Section 2 Introduction....................................................................................................7
2.1 This manual...........................................................................................................................7
2.2 Use of symbols......................................................................................................................7
2.3 Intended audience.................................................................................................................7
2.4 Related Documents...............................................................................................................7
2.5 Document conventions..........................................................................................................7
2.6 Document revisions...............................................................................................................8
Section 10 Templates..................................................................................................... 71
10.1 Introduction..........................................................................................................................71
10.2 Inheritance, Templates and Base Templates.......................................................................72
10.2.1 Inheritance Rules.............................................................................................................. 73
10.2.2 Inheritance Example..........................................................................................................73
10.3 Creating Templates............................................................................................................. 76
10.3.1 Layout Definition and Run Modes..................................................................................... 77
10.3.2 Creating a Base Template in a Base Template Folder...................................................... 77
The information in this document is subject to change without notice and should not be construed as
a commitment by Hitachi Energy. Hitachi Energy assumes no responsibility for any errors that may
appear in this document.
In no event shall Hitachi Energy be liable for direct, indirect, special, incidental or consequential
damages of any nature or kind arising from the use of this document, nor shall Hitachi Energy be
liable for incidental or consequential damages arising from the use of any software or hardware
described in this document.
This document and parts thereof must not be reproduced or copied without written permission from
Hitachi Energy, and the contents thereof must not be imparted to a third party nor used for any
unauthorized purpose.
The software or hardware described in this document is furnished under a license and may be used,
copied, or disclosed only in accordance with the terms of such license.
Trademarks
ABB is a registered trademark of ABB Asea Brown Boveri Ltd. Manufactured by/for a Hitachi Energy
company. All other brand or product names mentioned in this document may be trademarks or
registered trademarks of their respective holders.
Guarantee
Please inquire about the terms of guarantee from your nearest Hitachi Energy representative.
List of Third Party Copyright notices are documented in "3rd party licenses.txt" and other locations
mentioned in the file in SYS600 and DMS600 installation packages.
This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit.
(https://www.openssl.org/). This product includes cryptographic software written by Eric Young
([email protected]). This product includes software written by Tim Hudson ([email protected]).
This product includes software developed by Computing Services at Carnegie Mellon University
(http://www.cmu.edu/computing/).
This manual provides information on how to configure and customize the SYS600 Historian user
interface. The configuration can be done both when the system is designed and at runtime.
This publication includes warning, caution and information symbols where appropriate to point out
safety-related or other important information. It also includes tips to point out useful hints to the
reader. The corresponding symbols should be interpreted as follows:
Warning icon indicates the presence of a hazard which could result in personal injury.
Tip icon indicates advice on, for example, how to design a project or how to use a certain
function.
Although warning hazards are related to personal injury, and caution hazards are associated with
equipment or property damage, it should be understood that operation of damaged equipment could,
under certain operational conditions, result in degraded process performance leading to personal
injury or death. Therefore, comply fully with all warnings and caution notices.
This manual is intended for installation personnel, administrators and skilled operators to support
installation of the software.
• The words in names of screen elements (for example, the title in the title bar of a dialog, the
label for a field of a dialog box) are initially capitalized.
• Capital letters are used for file names.
• Capital letters are used for the name of a keyboard key if it is labeled on the keyboard. For
example, press the CTRL key. Although the Enter and Shift keys are not labeled they are written
in capital letters, e.g. press ENTER.
• Lowercase letters are used for the name of a keyboard key that is not labeled on the keyboard.
For example, the space bar, comma key and so on.
• Press CTRL+C indicates that the user must hold down the CTRL key while pressing the C key
(in this case, to copy a selected object).
• Press ALT E C indicates that the user presses and releases each key in sequence (in this case,
to copy a selected object).
• The names of push and toggle buttons are boldfaced. For example, click OK.
• The names of menus and menu items are boldfaced. For example, the File menu.
• The following convention is used for menu operations: Menu Name/Menu Item/
Cascaded Menu Item. For example: select File/Open/New Project.
• The Start menu name always refers to the Start menu on the Windows Task Bar.
• System prompts/messages and user responses/input are shown in the Courier font. For
example, if the user enters a value that is out of range, the following message is displayed:
Entered value is not valid.
The user may be told to enter the string MIF349 in a field. The string is shown as follows in the
procedure: MIF349
• Variables are shown using lowercase letters: sequence name
The tree can be configured with the pop-up menu that opens by right-clicking an item. The pop-up
menu enables the user to create, copy, and delete folders and nodes (items), change their names
etc. The items can be moved to another location in the tree by dragging. The items can be copied,
moved and shortcuts can be created from item by dragging the item to a different location in a tree
while holding the right mouse button. Releasing the button in the desired location will open up a
window, where the user can choose either to copy, move or create a shortcut.
• "Basic UI components"
• "To set tree properties"
• "To set tree items properties"
• "Tree Items List Window"
• "To create a new folder"
• "To create a new node from a template"
• "Moving, Copying, and Deleting Tree Items"
• "To move folders and nodes by dragging with the left mouse button"
• "To copy folders and nodes with Copy and Paste"
• "To delete folders and nodes"
The Figure 1 shows how the Vtrin looks like after being successfully connected.
GUID-40C17AC5-5EA1-4496-AA85-EA3CB5893AA8 V1 EN-US
Figure 1: SYS600 Historian has been connected successfully using Vtrin user interface with
user with administrator credentials. The main components are main menu,
toolbar, tree (1), generic properties window (2) and area for the components
opened from tree (3, current blank).
The components on the layout can be dragged, dropped and pinned for different locations as usual.
When a user interface component is selected from tree view, it is opened in the blank area. Clicking
the Variables tree item opens a list display of the variables that are currently available in the
database.
Access the Vtrin main tree by choosing Properties from drop-down menu by right-clicking the tree
root.
GUID-33C4888C-2916-4848-8E8E-13F581421402 V1 EN-US
GUID-B8F61343-7245-43FE-A3FC-6FEDA41AD216 V1 EN-US
• Setting for … : These are the user specific settings. The settings are divided in five groups:
• Language: Used language
• Status Bar: Choose the Client and/or Server time to be shown in the bottom of the
mainview.
• Tooltips: Define the specific setting for the Tooltips.
• Shifts: Define the default base offset and length for shifts.
• Miscellaneous: Define if double-clicking is used to open forms, if domains' full usernames
are used and if tampering with the background printing area is allowed.
• Default Settings: Default settings can be modified from this tab.
• Security tab: See Section 3.3.3.
Changes in the parameters take effect after Vtrin has been restarted.
To open Properties, press the right mouse button and choose Properties from the drop-down menu.
The Properties dialog consists of three tabs: General, Translations and Security.
GUID-89A57E94-756A-4E7C-9F02-DBF31078F745 V1 EN-US
Set the security preferences for the item on the Security Tab. There are three subtabs for security
preferences.
GUID-E49E93EF-2716-4BB5-9364-D28A917F5764 V1 EN-US
GUID-6A27B759-564B-4C10-B5ED-EC10E1C54CF8 V1 EN-US
• Advanced Tab:
• Inherit from the parent: Checking this means that the item will inherit its security
preferences from the parent folder.
• Set Child to Inherit permissions from this object: Checking this means that the child
items of this folder will inherit these security preferences.
• Set the individual security preferences for different user groups:
• Owner: Check the Inherit box next to the drop-down menu to inherit the owner
from the parent folder. If the Inherit box is not checked, the correct owner can be
chosen from the drop-down menu.
• Group: Check the Inherit box next to the drop-down menu to inherit the group from
the parent folder. If the Inherit box is not checked, the correct group can be chosen
from the drop-down menu.
• Others: Others are everyone that are not part of the chosen Owner or Group.
• Inherit Perm.: Check this to set the item to inherit the security preferences of the
Owner, Group or Others from the parent folder.
• Read: Check this to enable reading the item.
• Write: Check this to enable editing the item.
• Execute: Check this to enable opening the item.
• Create: Check this to enable creating an item.
• Delete: Check this to enable deleting an item.
• Full: Check this to give full rights.
The Navigation Tree Items list window shows the tree items and their properties as a list. It can be
used, for example, to find the location of a missing window if some information about, e. g. it part of
its name, is known.
• Open the Navigation Tree Items window (Figure 2) in the Maintenance/System/Vtrin folder.
• Use a suitable mask, for example a part of the item name, in the selection box above the Name
column.
Note that there may be several items with the same name in the tree. Differentiate by checking
the parent folder in the Parent Folder column and, if necessary, the parent folder of that, and so
on. (None) in the parent folder column means that the item is a top level folder, directly in the
database root.
GUID-CD530220-B6BF-4929-B2C5-83FF99D5DA01 V1 EN-US
• Right-click the icon or the folder name where the new folder should be created and click New
Tree Item and then Folder.
• Type a name for the new folder (by default, New Folder).
• Right-click the icon or name of the folder where the new window should be created and click
New Tree Item Select the suitable template.
A template is a collection of controls, for example chart, legend, ruler, etc., with a specified
layout and properties. Templates are used as the basis when creating chart windows.
There are two kind of chart window templates:
• Master templates that can be copied. If the master is changed, the copy will remain
unchanged.
• Templates that inherit the master templates. If the master is changed, the copy will inherit
the changes. Using these kinds of templates ensure that all windows in the system have a
uniform layout.
GUID-D7736B23-489F-46C6-BE21-171A6526A85C V1 EN-US
Protection against dragging the tree items by mouse is enabled by default. To disable
Tree protection, hold down the CTRL key while dragging the item.
3.6.1 To move folders and nodes by dragging with the left mouse
button GUID-C3CD6CAF-DB4C-42BA-9A7B-B33BF96D0AA3 v1
Move folders or windows to another location in the tree by dragging. A folder is moved with its
contents.
• To move the item between two other items, hold down the CTRL key and drag its icon or name
until the black line is in the correct position. Release the icon.
• To move the item in a folder, hold down the CTRL key and drag its icon or name on top of the
folder until the folder name is highlighted. Release the icon.
Copy, move or create a shortcut for an item by holding down the CTRL key and dragging the item
with the right mouse button.
3.6.3 To copy folders and nodes with Copy and Paste GUID-08FBD492-0C29-4A49-9EAA-EF132D0D6A3F v1
Copying folders or windows to another location in the navigation tree and then modifying them as
necessary often saves a lot of work compared to creating them from scratch.
• Copy always uses the saved tree item. Therefore, if changes are made to a window and the
user wants to copy the new version, the window has to be saved before starting the copying.
• Right-click the icon or the name of the folder or window to be copied and click Copy to copy the
selected item to the clipboard. A folder is copied with its contents.
• To copy the item to another data source, connect to the appropriate data source.
• Right-click the icon or name of the folder to which to copy the item. Click Paste on the pop-up
menu to paste the item in the clipboard to the selected folder. A folder is pasted with its
contents. The item remains in the clipboard and it can be copied to other folders with Paste, if
necessary.
When copying a group of windows that have mutual links, the links in the copied windows point
to the original windows. Change the links in the copied windows to point to the copies of the
original windows.
When copying items to another data source, note that the links still point to the windows in the
source database.
Right-click the icon, the name of the folder or the node and click Delete. A folder is deleted with its
contents. Confirm the deletion in the confirmation dialog box.
Delete does not delete the possible links in other nodes to the node that is being deleted.
The links have to be deleted separately.
After creating a chart window node in the tree as described in Section 3.5.2, the chart window can be
configured.
GUID-4D4A5F5A-AE11-422F-B50E-6E598E3AEF6A V1 EN-US
• Open the Variables list window from the Maintenance folder. To view it at the same time
as the chart window, move the Variables list window to a new leaf by clicking Move to a
New Horizontal Leaf on the Window menu.
• Find the variables to be insert to the chart on the list.
• Select the variable row, and drag and drop the variable to the legend or to the chart.
• Insert other variables in the same way.
OR
Drag a graph specific row from the legend of another chart window to the legend or to the chart:
The data fetch and graph properties (including color) are copied to the new graph from the
source graph.
• Open a chart window where the graphs to be inserted are shown as graph specific rows in
the legend. To view the source and target chart windows at the same time, move the
source chart window to a new leaf by clicking Move to a New Horizontal Leaf on the
Window menu.
• Drag the graph specific legend row of the source chart window to the legend or to the
chart of the target chart window.
• Insert other graphs in the same way. Several graph rows can be inserted at the same time
if necessary.
OR
Insert graphs in the Properties dialog:
The data fetch and graph properties are copied from the chart's default settings. Graph colors
follow the default color order.
To add new graphs to the chart in the Properties dialog, see Section 4.2.
For all cases:
• Save the settings when closing the chart window.
GUID-B83F9B98-DF29-42D6-884D-4817214B4201 V1 EN-US
• Open the Properties dialog by right-clicking the legend row of the desired item and click
Properties.
• OR by right-clicking the chart, selecting Properties and then selecting the graph item by clicking
the up/down arrows in the upper left corner of the Properties dialog.
In the Properties section, the chosen graph is presented in a preview window. Add or remove
variable accordingly:
• Add New: Allows the user to insert a new graph item to the chart.
• Delete: Allows the user to delete the selected graph.
• Hide: Checking this box the user can make the graph invisible on the chart.
• Common limits: Give limits to the graphs shown in the chart by typing the minimum and
maximum values to the text fields.
• Apply: Click Apply to commit the changes.
•
: Click the up/down arrow to commit the changes and to get the next/previous
graph of the chart.
•
: Calculation name of the graph.
• Calculated check box allows the user to display graphs that are calculated on the basis of
chosen variables. See Section 4.2.7.
GUID-C05B5797-C4B0-4C80-A5C2-6A046DE49FF3 V1 EN-US
Specify general properties for the chart, for example background picture and chart grid, on the
General tab.
• Pointing: Select the pointer shape by choosing the desired pointer from the drop-down list.
• Auto scaling of common limits: Select this to use automatic values to set the common limits
for the graphs.
• Axis orientation: Choose either X or Y axis along which the chart is drawn. Use this, for
example, in process charts.
• Background: The user can either select a background picture or one solid color for the graph's
background.
• When selecting a picture, click Browse to open the picture choosing dialog. The picture
must be located in a shared folder so that all users can locate it from the path /DATA/
VtrinShared/Project pictures. Clearing the textbox will remove the chosen picture form the
background.
• When selecting a color, select the color from the drop-down list. There are three different
categories of color on the list.
• Grid: Create gridlines to help visualize the changes on the graph.
• Automatic Y-axis lines: Select to use automatic Y-axis lines.
• X-axis lines: Select to use automatic X-axis lines.
• Line width: Choose the gridline width from the drop-down list.
• Y-axis: Determine the size of the gap between gridlines.
• X-axis crosses at: Specify one specific value that crosses with the X-axis gridline.
This option is not yet supported.
• Unit: The number of gridlines is the Common limits value divided with this number.
For example if Common limits is set as 100 and the Unit number is set as 25, the
number of gridlines is 4.
• Gantt margins: Gantt margins are set automatically as default, but they can also be set
manually by giving values to Top margin and Bottom margin.
• Graph Coloring: Specifies how the coloring of the graphs is specified. Useful if several time
bars with specific colors are used. Choose the color from the drop-down list. The color selection
applies only to the trend line.
• Output style: Choose to display the data either as a graph or in list format.
• Time Step: Determines the time scale used in the graph.
Graph properties are specified on the Items tab. There are seven subtabs under the Items tab.
These are: Appearance, Past, Future, Past 2, Future 2, Advanced and Limits and Statistics.
GUID-90A91474-20DA-4FF0-98A8-9212B8B86619 V1 EN-US
• Automatic text: If selected, the variable description is shown automatically in the Text column of
the legend. Otherwise, the text entered in graph specific text field is shown.
• Text field: Graph specific text shown in the legend.
• Font...: Opens the Font dialog, where dialog the font of the graph row in the legend can be
defined.
• Graph type: Specifies the selected graph type (e.g. line trend or stacked column).
• Color: Defines the used color and style for each separate graph.
• Fill style: Choose the fill style from the drop-down list.
• Primary: Choose the Primary color for the graph from the drop-down list.
• Secondary: Choose the Secondary of the two-colored fill style from the drop-down list.
• Draw style: Defines Draw type for the line trend, area, stacked area and the line XY-scatter.
Different Draw types can be chosen from the drop-down list.
Choosing the size of the line and the markers of the graph is done from the drop-down list. The
size range is between 0 and 8 pixels.
• Draw markers: Checking this will display the markers in the graph. Only fetched points are
marked. The opening options allow the user to specify the shape of the marker when it is
presented and the markers location while the graph type is marker.
• Markers:
• Shape: Choose the marker's shape from the drop-down list.
• Location in the chart: This can only be modified if Markers is the chosen Graph type.
Location in the chart is chosen from the drop-down list.
• From bottom: If the chart location is set as User specific, set the distance as a
percentage from the chart height can be set. This can be done by typing the percentage in
the provided text box, or by choosing the value from the drop-down list.
• Cumulative trend is only used while the Graph type is Line trend or Area .
• Cumulative: Select this option to display the graph in a cumulative way, where each value
is added to the ones before. The value is formatted back to zero after each defined period
(defined in the chart element).
• Scaling divider: Type here the scaling factor that is used as a divider to convert the
values to the required unit.
• Gantt status state: Gantt status state is only used while the graph type Gantt is defined. When
the user selects graph type Gantt, status and color, the parameters and color for the specific
Gantt state in the chart can be specified. The definitions apply to all the Gantts in the picture.
The first valid color selection defines the color.
Values in the Past tab are preconfigured and do not usually need to be modified.
GUID-5BE3174E-4788-40C9-B3F1-9B59E714E1C1 V1 EN-US
GUID-AE64CD5D-120A-4E90-B1E5-1C47A87A42AF V1 EN-US
• Fetch data: If selected, the graph data to the past chart is fetched.
• Location: Choose the database to connect to from the drop-down list.
• Connect: Connect to a new database.
• Source: Choose the category of the variables from the drop-down list.
• X-Value Property: Choose the property of the X-value from the drop-down list. This is usually
time.
• Y-Value Property: Choose the property of the Y-value from the drop-down list. This is usually
value.
• Filter: Enter the filtering criteria, for example a history table name. If there is no string in the filter
area, no filter is in use.
• Parameters: Use drop-down lists to choose the parameters for the graph.
GUID-8235E405-1266-4FC7-A46E-FEAD7FBA4B96 V1 EN-US
GUID-0D9656DA-C6B9-4422-971E-AA3FE6909593 V1 EN-US
Figure 10: Properties dialog for graphs – Limits and statistics tab.
Set additional limits and statistics for the graph on the Limits and statistics tab.
• Use defaults: Checking this means that default graph limits and statistics are used.
• Enabled: Check this to take the chosen limit/statistic in use. Once this is checked, the chosen
limit or statistic will be visible on the chart.
• Hidden: Checking this will hide the chosen limit/statistic in the chart.
• Sigma limits are calculated using selected tables of historical averages and deviations. The
tables are found under Past/Misc/SPCAverage History/SPCDeviation History. For more
information, see Section 4.2.3.
To use this tab, choose Calculated. The X-expression is only used when the Graph type is either
Line, XY scatter or Stacked column, sorted.
GUID-8A9D7DF0-07FE-45BA-8E78-C9E4C1E4B104 V1 EN-US
The data available for the legend is determined by the data sources specified in the chart definitions.
Specify the information shown on the graphs in the Legend Columns dialog box. The information is
displayed in the legend columns.
GUID-23A4C2B0-7B91-46C4-9F6B-778A2AA4E2FD V1 EN-US
• Right-click anywhere in the legend. If the chart window has more than one legend, make the
specifications separately for each legend. Right-click a legend to specify the information shown
in that particular legend.
• If some limits and statistics are set to the graph, they will be visible in the legend as
subcategories under the graphs. Click the + to open the category for viewing.
• Click Legend Columns... on the pop-up menu to open the dialog box.
GUID-95DD766D-5AE5-49F9-9AA4-663C97106182 V1 EN-US
For Example, Identifier, Name, Alias, Current Value and Current Value Unit are specified
separately for the variables of the fetch area.
Variable/F Variable is associated with every graph type and P2 Variable/F2 Variable is
associated with the Line XY Scatter and the Stacked Column Sorted styles.
For XY-graphs, Variable/F Variable is the Y-variable and P2 Variable/F2 Variable is the X-
variable. For sorted stacked columns, Variable/F Variable is the variable defining the height of
the column and P2 Variable/F2 Variable is the variable telling in which order the columns of
different column series' are displayed vertically on top of each other.
• Specify which parameters are shown and hidden by directly selecting and clearing the check
boxes or by clicking the buttons listed below, which selects or clear check boxes. A selected
check box shows the parameters of the row in the legend, a cleared check box hides it.
• Show/Hide: Shows/hides the information of the highlighted row (i.e. row that has first
been selected by clicking it).
• Show All: Shows all parameters.
• Hide All: Hides all parameters.
• Invert: Hides all selected parameters (with selected check boxes) and shows all
unselected parameters (with cleared check boxes).
• Order the information in the legend columns by selecting the row in the Legend Columns dialog
box and then clicking the following buttons:
• Move Up: Moves the highlighted parameters upwards in this dialog box, i.e. left in the
legend.
• Move Down: Moves the highlighted parameters downwards in this dialog box, i.e. right in
the legend.
• Save the settings when you close the chart window.
Edit the graph properties with the function buttons in the upper part of the legend's pop-up menu.
The following settings can be edited:
• Item visibility
• Item type
• Marker type
• Scaling limit type
• Item fill style
• Color settings
Marker type
Shows the marker type currently in use. To change the
marker type, open the pop-up menu by clicking the arrow in
the right corner and choose the appropriate marker.
Marker type options
• No marker
• Rectangle
• Diamond
• Triangle
• Ellipse
• Diagonal cross
• Cross
• I-Beam
• Vertical
• Horizontal
Properties
Click Properties to open the Properties window.
Table continues on next page
• Right-click the legend row of the graph to be deleted and click Remove....
OR
• Open the Properties dialog by right-clicking the legend row of the graph to be deleted and click
Properties. When the dialog box is open, select the graph by clicking the arrow buttons.
• Make sure that the selected graph is really the one to be deleted and click the Delete button at
the top. Click Apply.
After creating a list window in the tree as described in Section 3.5.2, the list can be configured.
• "Properties dialog"
• "Open list window"
The UI word Mask has been changed to the word Search in all the lists. You can find the
word Search in the selection box.
GUID-CAF91DDB-3429-4BB3-B7E1-2136E5C03DCE V1 EN-US
GUID-72CDFF85-B5DF-4FC0-9B86-3A514F36EE2A V1 EN-US
• In the Properties dialog for lists (Figure 13), at least the source of the properties listed below
must be specified.
• Location : Definition of the source location.
• Source : Source (table) of the displayed information, for example Variable log.
• Type : The following types are available for displaying the information:
• List: Select basic attributes of the source to be shown.
GUID-1B224640-1BFA-456B-9627-5A053FFD1E2E V1 EN-US
• Text: Select the basic attributes of the source to be shown. The attributes are
shown as packed text instead of a table. The pieces of information in the column
according to which the rows on the list have been ordered are shown as headers.
Identical headers are not repeated. The rest of the information is written
sequentially in the column order, separated by hyphens. Current values and other
virtual attributes are not shown.
GUID-F548BDB9-DEDC-4373-AD70-DF1A774B4C30 V1 EN-US
• Counted List: In addition of the basic attributes of the source, select the minimum,
maximum, sum, and average of each basic attribute, as well as the count to be
shown.
GUID-AF025015-4D7F-48C1-9C29-D411189347F2 V1 EN-US
• Fixed columns : Specifies the number of columns (starting from the left) that are always
visible. Columns cannot be scrolled out of view with the scroll bar.
• Truncate at : If the source has an unlimited number of items, specify here how many
items are fetched. The items are selected in the defined sort order. Note that if a large
number is specified, it may slow down the system.
• Search : Shows the Mask bar where the user can enter a string mask that is compared
with the text strings in all columns. See the Historian Operation manual for more
information on how to use the Mask bar.
• Advanced search : Shows the column-specific selection boxes below the Mask bar. See
the Historian Operation manual for more information on how to use the Selection bar.
• Column resizing by dragging : Allows changing the column widths by dragging the
column header.
• Row sorting by clicking : Allows sorting the list rows in the normal/reverse order by
clicking the column header. See the Historian Operation manual for more information on
sorting.
• Row numbers : Adds a number in front of the row.
• Specify which attributes are shown in the columns of the list in the table at the bottom.
• Visible : Shows whether the attribute (column) is shown on the list.
• Name : Name of the attribute, shown in the column header on the list.
• Format : Defines the format of the row. For example, g = time with accurance of one
second.
• Color : Color used to show the attribute on the list.
• Font : Font used to show the attribute on the list.
• Mask : Defines the used filtering for the column.
• Hidden Mask : Defines the used filtering for the row that is not visible.
• : Defines the presentation of the columns.
• Graph Type : Defines the graphical outlook of the numerical column (Trend etc.)
• Graph Color : Defines the color of the numerical column.
• Include on out of Range Left: When defining the time range, this options also displays
the row that indicates the results from an earlier time range.
• Include on out of Range Right: When defining the time range, this options also displays
the row that indicates the results from a later time range.
• Select the attributes to be shown or not shown (check box selected or cleared) by clicking the
following buttons. For each source, certain attributes are shown by default.
• Select/Deselect: Selects/deselects the highlighted item (i.e. row that has been selected
by clicking). Only one of the buttons is visible at a time.
• Select All: Selects all items.
• Deselect All: Deselects all items.
• Invert All: Deselects all selected items and selects all unselected items.
• Reset: Returns the selections to what they were when the dialog box was opened.
• Order the attributes in the list columns by selecting the attribute row and clicking the following
buttons.
• Move Up: Moves the highlighted attribute upwards in this dialog box, i.e. left on the list.
• Move Down: Moves the highlighted attribute downwards in this dialog box, i.e. right on the
list.
• Save the settings when closing the list window.
String masks cannot be used for large, non-cacheable lists in the list selection
boxes on the selection bar.
GUID-965E6BE7-082E-493E-BD41-76C0B5401B54 V1 EN-US
Equipment Model can be used to group and organize variables into a structure. Grouped variables
can then be easily displayed on a list or as a trend. The Equipment Model is typically found from the
top level of the Tree. It is built automatically when the signals are configured in SYS600. By default,
the Object Identification (OI) structure from SYS600 application object structure is used as the
Equipment Model.
Additional entries can be created for custom items in SYS600 Historian. Right-click the desired tree
level where an Equipment Model should be created and select New Folder from the pop-up menu.
Right-click the new folder and select Properties to access the Properties dialog.
GUID-8E35BAE6-E992-4F52-A5C4-EA1180674521 V1 EN-US
There can only be one Equipment Model hierarchy in use. If several Virtual Roots i.e.
Equipment Models are created, they will show identical content.
GUID-A7849C25-32A7-46A5-829A-48E999C40376 V1 EN-US
Figure 15: Equipment Model with example content in the Tree Window.
Once an Equipment Model is established, any defined group of variables can be sent to any of the
displays attached to the Equipment Model. To display a group of variables, right-click the desired
group and select Send To from the pop-up menu. This opens up a list of available displays.
Selecting a display from the pop-up list opens the display with all the variables in the group. A trend
display shows all the variables on the same chart, as an example.
GUID-BA2BB6EA-3249-434B-B1AC-91357327405A V1 EN-US
GUID-6C4BCE09-1920-42A3-91D5-470E6F478187 V1 EN-US
The list of displays available in the Send To pop-up menu of the Equipment Model can be expanded
by associating new displays with the Equipment Model. This is done by using the References
Configuration display.
GUID-B1826637-1B3E-49BD-AD77-FA3E2219FF28 V1 EN-US
view. Copy the ID of the desired display to the clipboard by right-clicking the corresponding rows on
the ID field and select Copy Selected Data. Now access the reference list on the bottom of the
display to add a new reference to the list as instructed in Section 8.1.
GUID-0F42EC2F-CA6D-45C6-9A2F-AB41045B94D1 V1 EN-US
Figure 19: Adding a new display type to Equipment Model using window references.
Paste the copied ID of the desired display to the Target ID field of the newly created row.
Clean any leading or trailing characters outside the actual ID after pasting. The actual ID
is of the form: 0881b3c7-11d3-4f42-85b7-9b56932ac815 whereas the ID copied and
pasted from the display list may be of the form:
{0881b3c7-11d3-4f42-85b7-9b56932ac815;(None)}.
Use Path as the Source Type and assign a descriptive name for the new reference. The default value
TreeNode is to be used as the Target Type. Finally, assign an appropriate sort key for the new
reference to place it in desired position in the pop-up menu. After checking the changes, press the
Commit button to take the new display into use in the Equipment Model.
GUID-5598020E-5D08-49FB-9FAB-40930100D480 V1 EN-US
Figure 20: The newly added display is accessible through the Equipment Model nodes.
In the Equipment Model, the variables are grouped using the Process Path associated to them. This
attribute is configured automatically by SYS600. If settings are changed, the settings are updated
when SYS600 is connected to the SYS600 Historian. However, if a variable is created manually, the
Process Path must be configured as described here.
New variable groups are created to the Equipment Model either by adding new nodes to the
Equipment Model in the Tree Window (recommended) or by using the Process Path configuration
display.
To add a new variable group through the Tree Window, open the Equipment Model hierarchy up to
the point where the new group should be created. Right-click the parent node of the new node to be
created and select New Tree Item. This will create a new node under the targeted tree node.
Enter a descriptive name to the node and proceed to assign appropriate variables to the new group
as instructed in Section 6.3.
To add a new group using the Process Path display, first locate the Process Path tree item inside the
Tree Window. Use the Tree Search, for example, to quickly locate the item.
Open up the Process Path display to see the existing Equipment Model groups. To create a new
group, click Edit in the upper right corner of the list display.
GUID-FB2D5AC1-944F-4AD0-8126-D69B769950B8 V1 EN-US
Figure 21: Editing the Equipment Model variable groups in the Process Path tree item.
Clicking the New button adds a new row to the list.
GUID-771194FE-7E41-4907-9F38-DB154502EC43 V1 EN-US
GUID-9DD7D12D-3EA9-477E-A31E-F7FA6BDBFFE2 V1 EN-US
Figure 23: Filling in the information for the new variable group.
After committing the changes with the Commit button, the new group will be visible under the
Equipment Model structure.
The variables intended for the new group can be added one by one from the Variables list. Select
the desired variable from the list and select Properties from the pop-up menu. Select a Process Path
from the drop-down menu to the variable. The Process Path selection assigns the variable to the
variable group associated with the Process Path.
GUID-FBECD777-CB83-460D-9DA1-435FCA1F9F5F V1 EN-US
Figure 24: Selecting a Process Path to a variable assign the variable to the desired variable
group.
After all variables have been added to the group, all the variables can be displayed by selecting
Send To from the pop-up menu of the group. If there are displays configured for the Equipment
Model, they can be used to verify the contents of the newly created group.
GUID-CC810F97-0EE9-4B38-9345-738731C95C47 V1 EN-US
GUID-594EC2A1-37DD-4ED4-A153-7927A3497298 V1 EN-US
Figure 26: A trend presentation of a collection of system variables grouped using the
Equipment Model functionality.
Right-click the tree folder in which a new report should be created. Select New Tree Item and the
required template from the pop-up menu.
GUID-1E6E868C-919C-4AC4-9EA2-3505CE399A41 V1 EN-US
Add variables (columns) to the report by dragging a variable from the variable list. When variables
are dragged from the variable list, the report definitions comply with the report template defaults.
Save the report. If any changes are done to configuration, an asterisk (*) is visible in Vtrin display tab
at the top. Configuration is saved to the same Vtrin tree item as opened by using CTRL+S.
Open the Report configuration form by right-clicking a report toolbar and selecting Configure from
the pop-up menu.
GUID-D88A7425-8B1B-4CA5-9B87-8DC619F94471 V1 EN-US
Report template has general settings. General settings are applied in all configured levels in report.
GUID-0E3662E3-64B7-4FB9-AED1-37396BDBE5B3 V1 EN-US
Report template must have at least one added level. A level can be seen as one report. One
configuration can have several levels added but the results of only one level are shown at a time.
GUID-C01CE9CE-8D31-4FC1-907D-069EFFE089AF V1 EN-US
Level is added or deleted only when the Levels – General tab is active.
Level configuration is handled tab Levels/General. Each level has also three sub tabs: Periods,
Layout and Print.
GUID-43DDE911-FDE0-4FA0-82AD-1F5B347F29E5 V1 EN-US
GUID-3C343497-64FF-4292-AAC0-0704E1444758 V1 EN-US
A report template must have at least one level added to it. One level can be understood as one
report. Variables are added separately to each level. In configuration, each level has a zero index
item, which is not fetched to report, but is used in configuration. It is used as the default item for a
new item added to the report, as well as a reference to certain settings.
GUID-204E653A-D181-4EE1-8E91-A1A7C353A880 V1 EN-US
• General, where the value follow the general style, which means that
decimals are shown as much as needed or possible
• Past variable takes the number of decimals from past configuration variable
definition from the database if a past variable is defined
• Future variable takes the number of decimals from future configuration
variable definition from the database if a future variable is defined
• Manual option enables the text box on the right and the number of decimals
can be entered manually
Other items except for the zero index also have a fifth option, which is always the
first one in drop-down list. Selecting this first default options means that the
formation for this item is taken from the zero index configuration.
GUID-1F36F37C-2BF8-467E-A3BF-2D5FFE69B389 V1 EN-US
GUID-0D852108-62BC-4DE1-A901-3C87DF42DF0F V1 EN-US
Other configuration options in the Future tab are the same as in the Past tab.
The future functionality is not supported, and it is recommended to not change any settings on this
tab.
GUID-5A1D8313-CF2C-4AD2-AA44-1E3F6E24FE9D V1 EN-US
These additional settings are done separately for each variable. The different columns are:
GUID-96B895BD-BD11-4A9A-8E62-63714E217244 V1 EN-US
GUID-6BF57655-7D21-460E-AEB9-211D04EA5237 V1 EN-US
Variables at each level in report are defined separately, which means that they can differ from each
other if necessary. When a new level is added to configuration, the variables from the first level are
added automatically to the new level. When a new variable added to a level, it is added only to the
selected level. If variables in different levels are wanted to be same, the Copy functionality found in
Levels/Copy is supported. Only the variables are copied, not all other level configurations.
GUID-C15C5838-BFA6-4040-AEEB-48C01122419F V1 EN-US
Advanced settings are also general settings, which are applied in all levels.
GUID-C61930ED-1C03-4794-A3C7-2818B8B59543 V1 EN-US
Report template can also show fetch results in trends. All the main chart types are supported.
Configuration of charts is made from report configuration, not directly to charts. Each chart is
available as its own worksheet, and variables/values that are added to the chart must be selected
individually (by default, variables are not added chart). Charts are added from the Charts tab.
Configurations for the added charts are made in the Levels/Variables tab.
GUID-A405B772-32CE-45BB-94DE-120A33360AB9 V1 EN-US
Chart configuration has three tabs. The General tab has following settings:
Layout tab has several chart settings. Default values are used for settings that are not supported
because charts are created when the report opened.
GUID-22195298-80D1-4F00-A5F5-6589C8F4E246 V1 EN-US
Report template does not require any saved Excel file in order to work. If the user wants to add any
own functionalities or layouts, a separate Excel file must be prepared.
Template report supports printing values to other worksheets defined by the user. The worksheets
must be added to an Excel file and are only referenced in the report configuration (template report
will not add, delete or rename worksheets). The name Report is used by the template report, so the
user's worksheets must be named differently. Also see Section 7.2.12
GUID-1585A4C9-5F1E-4382-8233-9826296F5836 V1 EN-US
When sheet is added to report configuration it can be referenced from two places.
First place is Sheets tab from where non-variable related settings are done. Second place is Levels
- Variables – Sheets tab.
Range name: Range name (cell) to where item is printed in sheet. It is useful to
give good names to cells manually. This makes bigger changes in layout afterward
much more easier to handle. Also Excel default names can be used like A3 or C5.
If range name is inside brackets [ ], offset to actual range location is added (do not
define brackets to actual range name). Offset is equal to number of periods.
Text: Constant text, valid only if type is text.
Print downward: If there are more than one item to print, defines direction of
items
Use formatting: If selected some formatting is added by template report if
applicable. For example number format, horizontal and vertical alignment, font
size and shrink to fit setting.
The report template can archive reports when the user clicks on the Archive button on the report
toolbar.
GUID-28292C17-6632-46AA-BC94-1886F2B13BEE V1 EN-US
• YYYY: Year
• YYYYMM: Year and month
• YYYYWI: Year and week
Ignore 'Report' sheet in When this option is chosen, the archived file will not include the actual 'Report'
archiving sheet
File name Base name for the archived file
File format Format of the archived file:
The Version tab contains general information about the report, such as version information and
compilation time.
The company's logo can be added to a standard report. The logo is automatically placed in the upper
left hand corner of the report. The logo can be entered as a GIF, BMP, PNG or JPG format file. The
name of the file must be Logo (so that the full name of the file is either Logo.gif, Logo.bmp, Logo.png
or Logo.jpg). Note that the image must contain a border that separates the image from other content.
The logo file must be placed in the VtrinShared\R disk partition and directory. In addition, it must be
presented in the Autoload.lst file located in the VtrinShared root directory.
GUID-7ECB269B-392D-4E88-B1DD-E2262941D45B V1 EN-US
and JGP), the old file must be deleted from the working directories of all workstations. This can be
done by deleting each user's own C:\Users\<username>\AppData\Local\IsolatedStorage directory
and the subdirectories it contains.
By default, template report starts always with new empty workbook. Report template is adding
worksheet called Report to workbook for its own use.
If there is need for own report layout user can use also predefined Excel file. Template report
supports printing results also to other worksheets where user is designed layout. Prepare Excel file
not having worksheet called Report. Preferred location for file is the server where database is
running, because from there file can be copied to other clients without network mappings. If any other
location used take care that folder is mapped before opening report.
Vtrin is supporting file sharing between clients and server (original file). If file is located under
VtrinShared folder, Vtrin can copy it to client PCs. In addition if file is modified and saved in client,
new version can be copied back to server. Preferred location for report Excel files is D:\sc\Historian
\VtrinShared\R (disc letter may differ). In Vtrin tree item that is referenced by :R. For example if file
name is MyWorkbook.xls, add ":R\MyWorkbook.xls" to Command line parameter. Make sure that
there is space before additional parameters.
GUID-A759604F-100A-4C75-8CDD-5D3C1C1E7ADC V1 EN-US
Figure 46: Vtrin tree item configuration for user tailored report
Excel file is opened by default in read-only mode. If user wants to save Excel file from client, add
also /RW (":R\MyWorkbook.xls/RW") after file parameter. Also make sure that original file in server
can be overwritten. When report is closed and Vtrin detects changed file, it asks if file should be
copied to server too (Click Upload).
Remember to use Save Excel and close from report menu when there is need for saving
file. Otherwise all extra items (additional worksheet and logos) added by report template
are also saved.
References to windows (charts, lists, etc.) can be defined in the tree for variables. The references
allows for faster access to windows that are viewed often in connection with a certain variable or all
variables.
When a connected variable, for example in a chart legend or a variable list, is right-clicked, the Send
To command on the right-click pop-up menu shows the connected windows, which can then be
opened by clicking.
In the figure Figure 47, variable T_HIS_COUNTER shown in the chart legend is connected to the
Diary list window as well as the T_HIS_N_Trend and New Trend chart windows. Right-clicking the
row of the variable and then clicking Send To shows the names of these windows, which can be
opened by clicking.
GUID-C1B58C20-909F-4043-A432-D01B48781CDA V1 EN-US
Define the references in the References window. Open Reference Configuration, through the
Maintenance folder inside the Definition lists.
• Fetch the desired variable to middle display (for example SYS_CPU0_Time, like in Figure 48).
• Fetch the desired view to the upper display (for example CPU load and CPU current, like in
Figure 48).
• Add a new row to lower display by choosing Edit. The option New will become available to
create a new row.
• Input the desired information:
• Text: The given name that will appear in the Send to box.
• Sort Key: Variable that will define the sorting order
• Source Type: Type of the given information
• Source ID : ID of the variable
• Target Type: TreeNode as default
• Target ID: ID in the upper display (defined the connected window).
GUID-921C6EFC-6DF1-4100-8A6E-C4D20A150FBE V1 EN-US
• To add a new reference in the Reference window, first insert a new row by clicking Edit and
New.
• Find the ID of the variable in the Variables window. Click the ellipsis (...) button in the Source ID
column of the Reference window and enter the variable ID in the opening edit dialog box. If the
button is not visible if, for example, changing an existing variable ID, first click the Source ID
column on the row.
If the user leaves (None) in the column, all variables are connected to the window specified on
the row.
• After making the desired references, click Commit to commit the changes and answer Yes in
the confirmation box. Click Revert to exit the editing mode.
• It is now possible to check in the Variables window that the windows that were connected to the
variable are shown in the pop-up menu when the variable is first right-clicked and Send To is
selected, as shown in Figure 48.
Windows ODBC Maintenance Log (Section 9.1) and User Logs (Section 9.2), help the user to
monitor SQL maintenance operations and user logins and logouts, as well as view the users of the
system.
• The windows are viewed like list windows. For example, rows can be searched with string and
time masks as well as order rows according to the selected columns.
• Click a row to view its properties shown in the log/list columns in the rows of the Properties
window. If the Properties window is not visible, click Properties on the Vtrin tool bar. The
Properties window can be dragged to a detached window as in Figure 49 to view more rows at
the same time. For more information, see the Historian Operation manual.
• Find out the meaning of the log/list columns by clicking a row in the Properties window. The
explanation of the column is shown at the bottom of the window.
GUID-F7C30A0D-79E5-4BE8-A9B6-A078A8031CA9 V1 EN-US
The Login Logs window, which resides in the Maintenance/System/Users folder of the Vtrin tree,
shows user logins and logouts. A login means the creation of an ODBC connection to the database.
The logins that occur during a configurable logging period (usually eight hours) are combined on the
same row.
GUID-51E1DE2C-5C6D-4C2B-B7D8-824F025AEC31 V1 EN-US
GUID-103C3545-6B61-4AA5-99C8-D30084658CD2 V1 EN-US
GUID-C2A27E88-D142-42F5-BB81-C789D17A9B73 V1 EN-US
A template is a collection of controls, for example chart, legend, ruler, etc., with a specified layout and
properties. Templates are used for creating application chart windows that present data in a graphical
form. Figure 53 shows an example of a template.
GUID-696D6384-DE9B-45B6-8950-BBC82CCF9DAF V1 EN-US
GUID-09DC54B5-2B41-4E33-AABF-49E96E4A10C9 V1 EN-US
A chart window can inherit controls from another chart window, called the base. When controls are
changed or added in the base, the changes and additions are also seen in the inheritor. Inheritance
makes it easier to achieve a uniform look for the chart windows.
Inheritance of the chart windows is implemented with both base templates and templates. Base
templates are chart windows where the user adds the controls that should be inherited. Templates
are otherwise empty (usually) chart windows that are specified to inherit a given base template.
When the user creates a new chart node in the tree by selecting a template from the opened menu
as the basis, they actually make a copy of the selected template. As a result, the chart window
inherits the same base template as the template, and therefore the changes in the base template will
also affect the chart window. See Figure 55.
GUID-EBCB63D8-9EF0-46F7-8FC3-CB2D4F7045CE V1 EN-US
Base templates are placed in an ordinary folder. Templates are placed in a template folder, i.e. a
folder whose type is template folder. Several folders can be used for base templates. When creating
a new item in the tree, the menu shows templates in all the template folders.
Developers and administrators create and maintain the base templates and create the corresponding
templates in the template folder(s). The end users should see and use the templates only.
When the user creates a new chart window using a template that inherits a base template, the
following holds true for the new chart window after creation:
• Size and position of the controls are the same as in the base template.
• Properties, e.g. color and fixed text of the controls are the same as in the base template.
• Variables connected to the current values and symbols are the same as in the base template.
• No variables are connected to charts (or other collection type controls), even if variables are
connected to them in the base template.
• The size and position of the inherited controls cannot be modified, nor can they be deleted.
• The control properties like color, text, etc. can be modified.
• The variables connected to current values and symbols can be changed.
• Variable items can be added to charts and their appearance can be specified.
• If the inherited properties or variable items are changed, any later changes in the base template
do not affect them anymore. If they are not changed, the changes made in the base template
will also be seen in the inheritor.
• New controls can be added.
As an example of how inheritance works, let us create a base template called Inheritance Example
Base (in the figure below) in the folder Base Templates RTDB. See Section 10.3.2.
GUID-2B2520D5-66D2-4E55-A10A-AA4D441987B6 V1 EN-US
In the template folder Templates RTDB, a template (commands New/Folder) called Inheritance
Example that inherits this base template is created. Inheritance is defined by selecting the name of
the base template in box Base form in the Properties dialog box for the template (see the figure
below).
GUID-C53481D2-03E0-4214-8482-EF9B067D932A V1 EN-US
Then a new chart node called Inheritance Example Window is created by selecting the template
Inheritance Example from the menu that shows all templates (left in the figure below). This is
effectively the same as making a copy of the template with commands Copy and Paste.
When the Inheritance Example Window (see the figure below) is opened, it is apparent that it has
inherited the controls with their sizes and positions as well as the variables connected to the current
values. The variables in the chart are not inherited.
GUID-6AEF6013-DC75-43DF-B7DC-350F3DC68EAD V1 EN-US
The color and text of the leftmost labels and buttons and the color and variable in the left current
value in Inheritance Example Window (see the figure below) is now changed. In addition, two
variable items are added to the chart.
GUID-80746E30-3B7E-490C-A97A-A0F0F997E9E0 V1 EN-US
Then the colors and texts of all labels and buttons and colors and variables of current values and
chart items in the base template are changed as in the figure below.
GUID-450005F1-1996-4177-BEDF-86D8D1E74E41 V1 EN-US
The changes made to the rightmost controls will be visible in Inheritance Example Window when it is
reopened (see the figure below). The changes made to the leftmost controls are no longer inherited
because these controls have been changed in Inheritance Example Window.
GUID-7F0E4833-968B-47CC-B1B0-B5995DE0A2DF V1 EN-US
The default mode is the Run mode where the user can view chart windows and add data to them.
The user can define templates in the Layout definition mode. Design mode can be turned on and off
by clicking the Design button in the toolbar.
The Layout definition mode is divided into three different sub modes. The sub modes are the
following:
• Define size and position mode: Default Layout definition sub mode, used for adding controls and
changing their positions, sizes and properties.
• Define anchors mode: For defining how the controls are anchored in relation to each other and
the chart window.
• Define connections mode: For defining which controls are associated with the same data.
When the program is in the Layout definition mode, the button and the name of the current sub can
be seen mode in the upper left corner of the window.
When an inherited control is clicked, the text "Inherited" with yellow background appears
over the sub mode text. See Section 10.2.1.
Return to the Run mode by clicking Design button in the toolbar, or by right-clicking the empty
background and clicking the Layout Definition Mode command that now has a selection mark
beside it.
Base templates can be created in a base template folder in the navigation tree. Base template
folders should be located in the Maintenance folder. The recommended folder names are Base
Templates X, where X stands for project name.
10.3.2.1 To create a template from an existing base template or chart window GUID-2A0DDA4E-5DAA-4E5E-850E-EDD0F429277C v1
1. Right-click the icon or name of the base template or chart node that will be used as the basis for
the new base template and click Copy.
2. Right-click the base template folder where the base template will be created and click Paste.
3. Right-click the base template icon or name and click Rename. Enter the desired name.
4. Right-click the base template icon or name and click Properties. Ensure that the Base form
check box contains None (unless another base template should also be inherited).
A folder item can first be created in the base template folder, and then its type can be changed to a
chart.
1. Right-click the icon or name of the base template folder where the new base template will be
created. Point to New and then click Folder.
A new folder item appears as the bottommost item with the name New Folder.
2. Change the name to a suitable name for the base template.
3. Right-click the icon or name and then click Properties.
4. Select InternalForm as the item type and cGenericChart (default) as the form type. Click
Change Icon to select a suitable icon.
GUID-3E1676C8-BD1B-40FC-BD32-C5CB822665D4 V1 EN-US
Controls and sub controls can be added to the chart window in the Define size and position mode.
Sub controls are controls that are added inside another control, the so called parent control.
1. Ensure that the program is in the Define size and position mode. For more information on how to
get there, see Section 10.3.1.
2. To add a control, right-click the empty background in the chart window, point to Add, and click
the desired control on the pop-up menu.
OR
3. To add a sub control inside another control, right-click the control, point to Add Sub Control,
and click the desired control on the pop-up menu.
4. Repeat until all necessary controls have been added.
• Chart: Can contain various other controls. In chart windows, refreshed graphs of variables are
shown in a chart control, see Figure 53. Graphs are not controls.
• Current Value: Shows the refreshed value of a variable.
• Horizontal Splitter: Horizontal separator bar. The height of the controls to which horizontal
splitters are anchored can be changed by dragging the splitters in the Run mode. See Figure 53.
Place splitters under other controls so that they never cover the adjoining controls, even if
the positioning of the splitters is not very accurate. To do this, right-click the splitter and
then click Send To Back. Define the height of the horizontal splitters so that it extends
over the chart window or the parent control. Once this is done, the Anchoring is correct.
For more information, see Section 10.3.6.
• History Bar: Shows the start and end times when a part of the time span for history updating or
zooming is selected in the Run mode. It also contains the Commit button for opening the
History Updating dialog box. This makes the history bar obligatory in templates used for those
chart windows where history updating is allowed. Zooming is possible even without the history
bar. See Figure 53.
• Label: Contains fixed text.
Make the labels 3D (property BorderStyle = Fixed3D) and center the text (TextAlign =
MiddleCenter).
• Legend: Shows rows of information of the variables that are presented as graphs in the chart in
the Run mode. Each row contains, for example, an icon in the color of the graph. See Figure 53.
• Link Label:
• Ruler: Shows graph limits or axes in the Run mode. See Figure 53.
• Scroll Bar: In the Run mode, the user can scroll the contents of the controls to which it is
connected with the scroll bar. See Figure 53.
• Time Bar: Shows the time span, column width, and start and end times of the graphs in the
chart in the Run mode. See Figure 53.
• Vertical Splitter: Vertical separator bar. Dragging the vertical splitters in the Run mode changes
the width of the controls to which they are anchored. See Figure 53.
Place splitters under other controls so that they never cover the adjoining controls, even if
the positioning of the splitters is not very accurate. To do this, right-click the splitter and
then click Send to Back. Define the width of the vertical splitters so that it extends over
the chart window or the parent control. Once this has been done, the Anchoring is
correct. For more information, see Section 10.3.6.
• Panel: The user can group for example buttons and labels inside a panel.
• Other: Other controls are available by clicking this command.
GUID-31178252-56D8-4145-A020-4F3C0E0317D9 V1 EN-US
• Hold down the ALT key and select the area of the controls holding down the left mouse button
(rectangle select), or hold down the SHIFT key and left-click the controls one by one.
• Release the ALT key and mouse button or release the SHIFT key.
• Left-click the control that will be used as the reference. There are blue handle squares around
the reference control, the handles of other selected controls are white (the handles of the
inherited reference control are dimmed.)
Only same level controls can be grouped together, either main level controls only, or
subcontrols of a control only.
• Hold down the SHIFT key and left-click the control. (Clicking the same control again holding the
SHIFT key down adds the control to the selection group).
• Click the empty background in the chart window or any control outside the selection group.
When the program is in the Size and Position mode, the properties of the selected control can be
seen in the lower left corner of the Vtrin window.
GUID-320D448F-B9CF-4F9F-BBDD-D55FC3053F46 V1 EN-US
At the top, the name and type of the control selected in the template can be seen.
The list (see Figure 56) shows the properties of the controls. The properties of the different control
types vary. The left column shows the property name and the right one the property value. Below the
list there is an explanation text for the selected property.
Above the list there are buttons, with which the user can control how the properties are shown on the
list. When a function is selected, the button background color turns white. The button functionalities
are:
• Categorized: Shows the properties listed under property categories, for example Appearance
and Behavior. Category rows are marked with a grey background. The properties belonging to
the category are listed in the rows under it.
• Sort alphabetically: Orders the properties alphabetically.
• Selected only: Not applicable to templates.
• Include read-only: Shows also the read-only properties that cannot be modified. Read-only
properties are dimmed when shown on the list.
• Ensure that the program is in the Define size and position mode.
• Click the property row.
• Click the arrow button and select the desired option from the list.
With anchors, the user can specify how the controls are moved and resized in the Run mode when
the window is resized or the splitters are dragged to resize controls. Anchors can be seen and
modified in the Define anchors mode. After specifying the anchors, check in the Run mode that the
window behaves as planned.
• Fixed (red square with a white connector line): The edge with a red anchor always remains at a
fixed length from the control or window edge to which the anchor is connected with the white
line.
• None (grey square): The edge is not anchored anywhere. When a horizontal edge is not
anchored, the control maintains its height. When a vertical edge is not anchored, the control
maintains its width. When both a horizontal and a vertical edge of a control are not anchored,
the control maintains its size.
• Background (white square): The edges with white anchors maintain their proportional position in
relation to the window. They can be seen as pins that are attached to an elastic background.
When the background is stretched, the elastic control moves with it.
The anchor squares of an inherited control are dimmed. See Section 10.2.1.
The following examples aim to clarify the effect of the different anchors.
The positions of all edges with background anchors remain in proportion with the window when the
window is resized. The size of the control changes accordingly. See Figure 57.
GUID-C453158B-8313-4C04-A606-B4E83FBFB03A V1 EN-US
GUID-4B0DFB8D-0D5A-47F8-B48C-BE6AD207668E V1 EN-US
GUID-31148F28-ECA5-419B-8733-BF2A25454450 V1 EN-US
GUID-4B0DFB8D-0D5A-47F8-B48C-BE6AD207668E V1 EN-US
GUID-F8467F6B-1838-4DBA-93A3-C294EEFD1518 V1 EN-US
GUID-4B0DFB8D-0D5A-47F8-B48C-BE6AD207668E V1 EN-US
GUID-69311B3A-6C2D-41D0-B67F-3E4A778F572D V1 EN-US
GUID-4B0DFB8D-0D5A-47F8-B48C-BE6AD207668E V1 EN-US
As an example, a small control (Figure 61 a) is anchored as in Figure 60. If the window size is
decreased in the Layout definition mode so much that its width is less than the sum of distances 1
and 2 and its height is less than the sum of distances 3 and 4 in Figure 60, the control cannot be
shown (Figure 61 b). However, if the program is switched to Run mode while the window size is
decreased (Figure 61 c), the system nevertheless tries to show it using the original size and original
position and stores the current situation. If the window size is then increased either in the Run mode
or in the Layout definition mode, the system keeps the new distances fixed with the result that the
size of the control is no more the same as the original size (Figure 61 d).
GUID-A95F4E32-1C87-4DAA-80FB-C13E4AB5CE7C V1 EN-US
GUID-E84A70CA-1F3D-436B-8125-B231FC974ED2 V1 EN-US
GUID-873942C6-FB0F-46D9-AAE1-29F3EC967F1D V1 EN-US
GUID-6E5AE495-35A6-4315-B874-B92933B6653B V1 EN-US
• Ensure that the program is in the Define size and position mode. For more information on how to
get there, see Section 10.3.6.
GUID-30E61776-0B5A-4EC6-AFAD-AA97C832647E V1 EN-US
• To change the anchor type to None or Background, right-click the anchor and click the
appropriate command.
• To change the anchor type to Fixed, drag the anchor to the control or window edge to where it
should be connected. The white line appears showing the connection.
• After having specified the anchors, check in the Run mode that resizing the window and
dragging the splitters behave as planned.
Scroll bars, time bars, history bars, buttons and labels should retain their height, so leave one
horizontal edge not anchored (anchor type None).
Splitters should retain their positions, horizontal splitters their height and vertical splitters their width.
If the Splitters extend over the parent width, default anchoring can be used as follows:
• Horizontal splitters: Top edge is anchored to the background, where the bottom edge remains
unanchored. Right and the left side edges are fixed to the parent controls' edges.
GUID-557A16C5-9B60-4A31-B1CE-EC489E5497AE V1 EN-US
• Vertical splitters: The left side edge is anchored to the background, where the right edge
remains unanchored. Top and bottom edges are fixed to the parent controls' edges.
GUID-0DF3693D-E51E-4BEB-95F1-13DFE92F743F V1 EN-US
In this phase, a selected control can be connected to other controls. This allows the user to attach
data from other controls to the connected control. For example, the legend must be connected with a
chart before it can show information on the variables whose graphs are displayed in the chart. See
Figure 64.
GUID-1AADB23C-7993-4C47-B813-E5D41D951611 V1 EN-US
• Chart
• Legend
• Ruler
• Scroll bar
• Time bar
• History bar, if exists.
If there are several charts in one template, each chart usually has its own legend, ruler and history
bar (if they exist). All charts can share the same scroll bar and the same time bar.
• Ensure that the program is in the Define connections mode. For more information on how to get
there, see Section 10.3.1.
• Click the control that will be connected with other (target) control(s). The selected control is now
surrounded with a light-blue dashed line and small Connection boxes appear above it. The
names in the boxes show the control types that can be connected to the selected control.
• The connection box with grey background is a free connection property.
• When the selected control and the target control are connected, a connection box with a white
background and an arrow pointing to a white target box can be seen above another control. The
target box shows the name of the target control.
The connection boxes and the target boxes of an inherited control are dimmed. They
cannot be modified. See Section 10.2.1.
The chart connection with the timebar(s) is a special case. The chart can be connected
with several timebars. When the chart is connected to the first timebar, a white box
pointing to the timebar appears below the connection box and the first timebar property is
copied to the first item of the timebar collection. The next free timebar item of the
collection is shown as grey connection box, adjacent to the white boxes. See figure
below.
GUID-9263B549-406B-473D-BA72-71AEBA9A00FE V1 EN-US
First, create a folder item in the template folder and then change its type to chart. Make it inherit the
base template.
• Right-click the icon or name of the template folder where the new template will be created. Point
to New and then click Folder.
A new folder item appears as the bottommost item with the name New Folder.
GUID-C53481D2-03E0-4214-8482-EF9B067D932A V1 EN-US
When the template is opened, the user can see that it has inherited the controls from the base
template. It is possible to add new controls and connect variables to charts in the template. When a
new chart window is created using the template, these are only copied to the new window, not
inherited. If the template control properties and variables that are inherited from the base template
are changed, these definitions override inheritance, and changes in the base template are not seen
in the template, nor in windows based on this template.
Specify the base template that a template inherits from the Base form drop-down list in the
Properties dialog box of the template. This information is stored internally as a global ID.
If the base template or the base template folder is copied with Copy and Paste, the
global ID of the base template changes. If the template should inherit the copied base
template, the user must change the base template specification in the template
accordingly. Moving with dragging does not change the global ID.
If the user wants to copy a template to another database, both the template and the base
template it inherits must be copied. When doing this, their global IDs change, and the
user must specify the base template again for the inheritor template in the new database.
The following sections provide examples for creating templates for chart windows with one chart as
well as a chart windows with two charts.
The following example illustrates one way of creating a template for chart windows with one chart. If
the template is meant for charts with trend plots, the best position for the legend is below the chart
(Figure 65), for charts with columns, to the right of the chart.
GUID-6C29F498-D905-4F39-B991-2368F0957E3D V1 EN-US
Figure 65: Example template for chart windows with one chart
the empty space left just inside the window edges where no other controls except splitters
are drawn (see Figure 65).
• Move the horizontal splitter just above the legend and make it as wide as the window.
• If the history bar is not used:
• Move the time bar just above the horizontal splitter. Lengthen it so that it is as wide
as the chart control should be (i. e. the area where the graphs will be presented).
• Make the chart and scroll bar of the same width as the time bar.
OR
• Define properties for controls as appropriate. See tips for splitters in Section 10.3.3.
• Specify anchors in the Define anchors mode as described in the following table, for example
anchor the legend with red anchors to the bottom and edges of the window and the horizontal
splitter.
Table 22:
Control Anchor of the left Anchor of the right Anchor of the top Anchor of the
edge edge edge bottom edge
Legend
To the window To the window To the To the window
left edge right edge horizontal splitter bottom edge
Horizontal Background None
splitter To the window To the window
left edge right edge
Time bar None
To the vertical To the window To the
splitter right edge horizontal splitter
History bar None
To the vertical To the window To the
splitter right edge horizontal splitter
Chart
To the vertical To the window To the window To the
splitter right edge top edge horizontal splitter
Scroll bar None
To the vertical To the window To the window
splitter right edge top edge
Ruler
To the window To the vertical To the window To the
left edge splitter top edge horizontal splitter
Vertical splitter Background None
To the window To the window
top edge bottom edge
The controls needed depend on how the data will be presented in the chart windows that are created
from the template. As an example, let us take a template for chart windows that show columns in two
charts above each other. The legends are placed on the right, as recommended for column charts.
Use the following controls:
• Two charts
• Two labels: useful for explanatory titles for the charts
• Two legends
• Time bar (same time bar for both charts)
• Two history bars: obligatory if this template is meant for chart windows where history updating is
allowed. In addition, the history bar shows the start and end times when a time span for zooming
is selected. However, zooming is possible even without the history bar.
• Scroll bar (same scroll bar for both charts)
• Two rulers
• Horizontal splitter
• Two vertical splitters