Max DPUTools
Max DPUTools
User's Guide
278597 Rev. E
Refer to this publication for complete and accurate information that helps you better operate and service Valmet
equipment. Your comments and suggestions are welcome.
Valmet
2750 Morris Road
Lansdale, PA 19446
Attention: Manager, Technical Publications
This document is the exclusive intellectual property of Valmet, Inc. and/or its subsidiaries (collectively “Valmet”) and is
furnished solely for operating and maintaining the supplied equipment and/or software. Use of the document for any
other project or purpose is prohibited. All copyrights to the document are reserved by Valmet. Accordingly, the
document or the information contained therein shall not (whether partly or entirely) be reproduced, copied or disclosed to
a third party without prior written consent of Valmet.
Valmet •278597 •
Contents
Valmet •278597 •
maxDPUTOOLS User's Guide
Valmet •278597 •
Contents
v
maxDPUTOOLS User's Guide
Valmet •278597 •
Contents
vii
Chapter 1
Constructing a Configuration--
an Introduction
Overview
Use maxDPUTools to create a configuration for maxDPU based maxDNA
systems:
▪ Define the configuration for an individual maxDPU model 4E, 4F, MR,
or ACN MR.
▪ Download the configuration to an individual maxDPU.
▪ Create sets of configurations representing the maxDPUs in a system.
▪ , and save the complete contents of an individual maxDPU or a set of
maxDPUs.
▪ Perform differences with a running maxDPU and selectively save any
changes resulting from online edits.
▪ Perform differences with a previous copy of the configuration to review
any changes resulting from editing.
▪ Export from maxDPUTools to Access or a formatted file.
▪ Import configuration data from Access or a formatted file.
▪ Convert an earlier release version configuration.
Valmet •278597 •
maxDPUTools User's Guide
The backup serial link cable (Part number 081387) carries data signals
between the primary and secondary DPUs, as well as a status signal which
determines which DPU is active. If one end of this cable is removed from
either DPU, that unit is rendered inactive.
I/O modules plug into a Remote Processing Unit (RPU) cabinet card rack
along with DPUs and other equipment. I/O modules communicate with
DPUs via an I/O bus.
Use digital and analog buffers to configure digital and high level analog
signals coming from I/O modules. Use thermocouple and RTD buffers to
specify linearizations.
Other function blocks may then be configured to point to analog and digital
input buffers to obtain conditioned signals as input data. Output buffers, in
turn, may then output processed data from other function blocks to an output
module connected to a field device.
The number of channels associated with a module varies from one, for an
Output Driver, to 16, for DI and DO modules. The number of channels
created need not be a multiple of a module count; when the channels are
allocated to modules, the spares may be left unnamed.
▪ 24 VAC/VDC
▪ 48 VAC/VDC
▪ 120 VAC/VDC
▪ 240 VAC/VDC
Solid-state inputs can be scanned 1000 times per second for 1 ms SOE
applications
▪ 4 to 20 mA
▪ 0 to 6 VDC
▪ 0 to 10 VDC
Inputs isolated from each other, from ground, and from module logic.
Each input individually configurable as thermocouple or millivolt.
Inputs isolated from each other, from ground, and from module logic
Three-wire or four-wire RTDs
SEQSTEP
FSTOUT
Understanding Attributes
The data stored in a function block are organized as a set of attributes. All
function blocks have some attributes in common. All attributes have sub
attributes. Sub attributes include category, description, reference, and several
others.
Outputs Outputs are values that are the result of the function or
operation with which they are associated.
Custom When defining a user block you are free to define your
own attributes. They can be categorized as any of the
above or you may define your own categories for your own
purposes.
The Type column appearing for each function block's tabular detail display
indicates which data type, configured in the value column, must be used for
a specific attribute. Single value data is often passed down the line without
regard to source, use, or range. An associated attribute to such data is
quality, which is, in fact, associated with all data. Value data functions in
several formats:
Boolean
Complex
Enumerated
Float
Long
Relative time
Text
Time
Boolean
Boolean data can only have the values True and False. It represents two state
conditions such as: active/not active; on/off; alarm/no alarm.
Integer
Integers are whole numbers with no fractional component. They may be
range restricted according to use.
Enumerated
Enumerated data is another variation of Integer or Boolean where there is a
meaning assigned to a list of values, which is severely restricted to those
having special meaning to the function.
Float
String
Generally used for text.
Absolute Time
Absolute time is a special type of data, which is displayed in a standard time
format. It is derived from the local clock, synchronized to the system master
clock. It is UTC (Universal Coordinated Time), not local time.
Relative Time
Relative time is another variation of float that enables it to be read by a
standard input reference.
▪ RHi
▪ RLo
▪ Val
Forceback
To avoid having upstream components run away (wind up) when the
downstream components are unable to respond, a concept called forceback is
used to impose limits on the master source. The special value Status is used
to describe the limit being imposed.
▪ RHi
▪ RLo
▪ Val
▪ Stat
▪ RHi
▪ RLo
▪ Val
▪ Rst
▪ Aref
Family Ties
Two special connections of function blocks require a special means of
complex and even bi-directional communication.
Participation master and members must be able to keep tabs on one another,
which they do through the master demand connection.
Sequence master and steps have to pass status and active state information to
one another, which they do through the chain--complex connection.
Adding a Group
When you add a group, a pop-up appears prompting you for a group name and
relative index. The relative index is selected incrementally by default. You
may manually change the relative index by also typing in the desired index.
The Relative index for each group or control must be unique within a group.
Group Attributes
The Group function block uses only parameter and general attributes. The
Gname parameter is already configured when you open the newly created
function block, showing the name you entered when you created the group.
You may also give the group a tagname and description.
Using maxDPUTOOLS to
Create a Configuration
Getting Started
Use maxDPUTOOLS to create a configuration specifically for the maxDPU
processor. Configuration always begins with creating a copy of a master
configuration assigning it a unique name typically matching the desired
maxDPU name. This base copy provides a self-contained framework
definition of all of the available intrinsic function blocks and related
attributes associated with the maxDPU.
Refer to the later chapters to learn how to use most of these utilities.
Consult this chapter to become familiar with the main maxDPUTOOLS two-
pane window, from which a configuration is built.
Valmet •278597 •
maxDPUTools User's Guide
Figure 2-1. maxDPUTOOLS Main Window opened to the DPU tab view.
Figure 2-2 shows the left hand pane opened to the Hardware tab. The
hardware tab consists of only the I/O related buffers. For a configuration
with maxPAC I/O it is organized in a three-way hierarchical tree view as
shown above:
Use this view to quickly configure only hardware or to access only the
hardware content of a configuration. Selecting a buffer node in the tree
allows viewing its attribute tabular detail in the right hand pane. See the
subsequent section. Use a context menu, accessible after a right-click over a
tree element, to add and delete buffer types. The context menu also provides
initiating a cross-reference listing or navigation to the Hierarchical view.
Figure 2-2b shows the left hand pane opened to the Hardware tab. The
hardware tab consists of only the I/O related buffers. For a configuration
with MIOFamily I/O (NOTE: MIO is a feature of the DPU ACN model,
version 5.0 and later). The tree is organized in a two level hierarchical tree
view as shown above:
Use this view to quickly configure only hardware or to access only the
hardware content of a configuration. Selecting a buffer node in the tree
allows viewing its attribute tabular detail in the right hand pane. See the next
section. Use a context menu, accessible after a right-click over a tree
element, to initiate a cross-reference listing or navigation to the Hierarchical
view.
The Custom tab shows a tree view displaying custom block definitions
hierarchically by source, category, name combined with description, and
function block contents. The source can be local or imported from a library.
Note that library custom blocks cannot be modified and are displayed as
locked. See Figure 2-3.
The most recent revision time will then be displayed for each of the custom
function blocks or templates as shown below.
Figure 2-1 shows a tree directory with the DPU tab selected. Notice that
when you select a group or specific function block in the tree directory pane,
its full path name appears in the title bar of the tabular grid view.
The tabular detail pane lists the attributes for a function block selected in the
tree directory. The first column of the grid view shows most of the
associated attributes for the selected function block or buffer typically
needed for configuration. To view more of the available attributes for a
selected function block, select either the Expert or the All view in the
combo box in the tabular detail title bar at the far right. Expert view adds
attributes that are normally hidden as their values are infrequently edited. All
view adds Status and Output category attributes, which likewise cannot be
edited except for the special case of creating an exposure via the reference
field. Refer to the section on reference editing for details.
The remaining columns display the associated category for each attribute,
the value assigned to the associated attribute, reference pointers, and the type
of data that may be entered into the Value column for each attribute. Only
the Value and Reference columns, highlighted in a white background, are
configurable. The remaining columns, highlighted in gray, are informational.
Open the Hardware tree directory and expand the By Type folder to view an
alphabetized list of buffers.
Click on a buffer type folder icon to open a tabular detail for all buffers of
that type. See Figure 2-4.
Figure 2-4. By Type tabular detail accessible from the hardware tree directory.
For instance, click on the AIB folder to display the tabular detail in the right
pane for only AIB types. See Figure 2-4. Click on the AOB folder to display
a tabular detail for only AOB types, and so forth.
Buffer types appear in the tabular detail organized as rows. The first column
of the tabular detail describes the HID location of each listed buffer. The
next seven columns list hardware related attributes which you may edit. By
default, the following attribute types appear:
▪ Address
▪ Redundancy,
▪ maxPAC option,
▪ Failover type,
▪ Cabinet,
▪ Rack,
▪ Card.
Click the Reconfigure button on the tabular grid toolbar to customize the
column configuration and select other attribute types.
▪ Filter by selection
▪ Filter excluding selection
▪ Filter by entry
Click the Remove Filter button, also on the tabular grid toolbar, to remove
any applied filtering.
Refer to this section to acquaint yourself with some of the right-click context
menus you will need to access to create a configuration. Main Menu Bar
functions are explained individually in the next chapter.
While both the tree directory and tabular grid panes support right-click
accessible context menus, tree directory context menus assume the most
importance when you are creating a new configuration and installing
(downloading) to a DPU.
As noted, a DPU tab tree directory consists of a single DPU icon, group
nodes, and individual functions. Each of these types of tree element support
their own right-click accessible context menu. When you begin a new
configuration, only the DPU icon and the preconfigured System folder
(Containing implicit DPMS, Backup, and Timesync controls) are available.
Right- click on the DPU icon in the tree directory to open a pop-up menu. As
you add groups and then other functions, the other right-click context menus
become available. Refer to the following figures:
In the DPU tab tree directory, right click on a DPU icon, group node, or leaf function
node to open a context menu. The figures below show menus for DPU, group nodes,
and individual functions, respectively.
Editing Records
Notice that the first column on the left of a grid view contains a Record
Select Box for each record in the grid. When a record is selected in the grid,
an arrow appears in the Record Select box. When you edit a record, the
arrow in the Record Select box changes to a pencil.
When you leave the mouse pointer over the cell for several seconds each cell
will display a fly-over indication to show the complete contents of the cell
even if the column width is too narrow to make the entire cell visible.
maxDPUTOOLS provides several auto entry features for fields that require a
specific entry from a known list of choices. These are:
When you click on certain entry fields in the Value column, a Drop-down
Arrow button appears at the right of the field. When you click on certain
entry fields in the Reference column, an Ellipsis button appears.
Click on the down-arrow button to display a list of appropriate entries for the
field you're editing. Click an item on the list to select it. You may also press
the <F4> key to access the list.
If you know the correct entry, type the first few characters. maxDPUTOOLS
looks for the closest match from its list of known choices and fills in the rest.
Alternatively, you may click the field repeatedly to scroll through a known
list of choices.
1. Rest the mouse cursor over the vertical border between two columns
until the pointer changes to a vertical bar with a horizontal arrow in each
direction.
2. Click and drag the mouse to move a column border left or right. This
feature always adjusts the width of the column to the left of the pointer.
Reordering Columns
To change the order of any column in the window:
2. Release the mouse button after you move the column to its new, desired
location.
Note: the double bar to the right of the left-most column indicates that the
column is fixed if the view is moved with the horizontal scroll bar.
For example, the Attribute column in the point grid view would still be
visible if the window was resized and the view was scrolled to the right. It
would also be visible if the width of the other columns was increased and the
view was scrolled to the right.
Click on the desired column header. This causes the tabular view to be
sorted by that column in ascending order.
The Grid Navigation Toolbar, shown in the following figure, appears at the
bottom of a grid view. When a record is selected in the tabular grid, the
toolbar buttons become available. Additionally, the name of the selected
attribute appears at the center of the toolbar as shown in the following
figure.
Previous Record
Click this button to move the active record up to the previous record. Note:
hold the button down to continue to move backwards.
Next Record
Click this button to move the active record down to the next record. Note:
hold the button down to continue to move forward.
Canceling an Edit
To cancel an edit for the active record:
Click the Cancel button on the Grid Navigation Toolbar, or press the
<Esc> key on the maxSTATION keyboard.
Note: The first column on the left of a grid view contains a Record Select
Box for each record in the grid. For the record you wish to cancel, an arrow
should appear in its Record Select box, indicating it is the active record.
Saving an Edit
The first column on the left of a grid view contains a Record Select Box for
each record in the grid. When a record is selected in the grid for edit, an
arrow appears in the Record Select box, indicating it is the active record.
Click the Update button on the Grid Navigation Toolbar, or press <Ctrl>
+ <S>.
Note: The first column on the left of a grid view contains a Record Select
Box for each record in the grid. For the record you wish to save, an arrow
should appear in its Record Select box, indicating it is the active record.
Click on the function block or group as it appears in the tree directory and
while holding down the left mouse button drag the selected function block or
group to a new location in the directory tree and release the button.
While holding down the <Ctrl> key, click on the function block as it
appears in the tree directory and while holding down the left mouse button
drag the selected function block to a new location in the directory tree and
release the button.
Notice that as you drag the selected object to a new location, the mouse
cursor includes a plus sign (+) to indicate a copy operation is in progress.
1. While holding down the <Shift> key, click on the first function block or
node in the tree you wish to select. Then click on the last item in the list
you wish to include to highlight the entire selection.
2. Continue to hold down the <Shift> key and while holding down the left
mouse button, drag the selected function blocks or nodes to a new
location in the directory tree and release the button.
1. While holding down the <Shift> key, click on first function block or
node in the tree you wish to select. Then click on the last item in the list
you wish to include to highlight the entire selection.
2. With the selection highlighted, hold down the <Ctrl> key, and while
holding down the left mouse button, drag the selected function blocks or
nodes to a new location in the directory tree and release the button.
1. While holding down the <Ctrl> key, click on each function block you
wish to include in the move to highlight then.
1. From the File menu, select Open to open a configuration, if one is not
opened already.
3. From the Window menu, select Tile Horizontal or Tile Vertical. When
you make your selection, both configuration windows appear, one
beneath the other or side by side, depending on your tiling choice.
4. With both configurations open on your display, you may now perform
drag and dropped operations between the two windows. Use the same
move and copy techniques you would perform within a single
configuration. Review the previous sections.
The feature exists to annotate the nodes in the tree with bookmarks, each
with an optional reminder note. With the tree pane having edit focus, a
bookmark may be added by right clicking via the mouse on a selected node
in the tree. This will show a context dropdown menu with four possible
bookmark operations that may be selected for toggling, navigating, or
clearing all bookmarks. Note also the presence of keyboard shortcuts as an
alternative to using the context menu as demonstrated below:
Once the bookmark has been added, the affected node’s text will be
annotated with a right most yellow flag image. By hovering over the
bookmarked node a tooltip will appear that now includes the reminder note:
In addition to the context menu, a fifth keyboard only operation exists using
the <ALT>-B keyboard sequence to perform a quick create of a Bookmark
without the reminder note prompt.
Overview
Creating a configuration database meeting an overall process control strategy
requires some advanced planning. To begin, decide what control and data
acquisition applications are required and their scope. Once the size of such
applications is understood, measured in hardware resources and total number
of points, you may begin constructing configurations using
maxDPUTOOLS.
Remember that you may create one configuration per DPU. Note that large
and complex applications will likely be composed of multiple configurations
spanning multiple DPUs. Because of this, planning is important. As you map
out a control strategy, decide how many separate configurations are needed,
and what they should contain.
1. Decide what hardware resources are needed, namely DPUs and I/O
modules. The IP addresses of all the available DPU pairs are normally
entered into the DPUlist.ini file before configuration begins.
2. Use buffers to define I/O modules and signals and to specify further
single conditioning. Use Atag and Dtag function blocks to assign names
to each signal.
Valmet •278597 •
maxDPUTools User's Guide
Getting Started
Use maxDPUTOOLS to create a configuration consisting of groups, function
blocks and custom blocks assigned to specific DPUs:
Updating Configurations
Use maxDPUTOOLS to create a new database or edit an existing database.
Remember that, if you are editing an existing database, it may need to be
converted from earlier versions of maxDPUTOOLS or the DPU.
maxDPUTOOLS supports mixed versions of the maxDPU from a single
workstation. This allows a site to have multiple maxDPU versions present in
a system. Multiple versions may exist for several reasons. For instance, new
equipment is added or a complete update to existing equipment is not desired
or must be deferred until a later date.
For instance, a version 2.1 configuration created for a 2.1 DPU4E may need
to be updated at some point. An automatic conversion may be triggered due
to minor revisions or corrections within a DPU version that occur as part of a
new or maintenance release. Such automatic updates do not change the DPU
version of the individual configuration.
Note: Selecting Cancel will disallow the opening of the configuration until
an update is successfully completed.
If the configuration of interest is not in the most recently edited list select the
More Selections entry to initiate an open file dialog for its selection.
A double click on an option is also available, after the list selection, without
requiring OK.
The backup option is also available from the File menu, making it possible to
create a backup copy anytime.
1. Select a configuration from the choice list and click the radio button for
creating a backup copy.
2. From the SaveAs dialog, specify the path and name of the backup file.
1. Select a configuration from the list and click the radio button for
creating a new copy.
2. From the SaveAs dialog, which opens by default to the directory of the
original file, specify the path and name of the copy.
Note: a Save As option also appears on the File menu. This entry is enabled
when a configuration is open and has active focus. Select this feature to
create a copy of an active configuration with a new name.
This option opens a Save As file dialog with its directory location set to
match that of the original file. When you select this option, maxDPUTOOLS
closes the original configuration, creates a copy and opens the new
configuration to take its place.
Select Configuration Version Update from the File menu to access a file
selection dialog.
From the file directory, select a target configuration file with an extension to
access the DPU Version Selection dialog.
The dialog contains a list of available maxDPU models and versions. Select
one and click OK.
DPU models and versions listed in the dialog are sorted in descending order
to place the most recent release at the top for quick default selection via an
enter keystroke. Each master contains the definition of functions and
attributes uniquely supported by their particular release, and serves as a
starting copy for the creation of new configurations as well as a master
reference for the performance of version updating.
After you select a DPU version, the following confirmation dialog appears:
Because maxDPUTOOLS replaces the original file with the updated file, a
backup file is recommended should there be an unforeseen need for error
recovery.
If you select Yes, the utility opens a file directory dialog from which you
may identify the location and name for the backup file.
The dialog includes the DPU version identification and confirms any file
type change.
Select System Wide Security Download from the File menu to access the
following dialog:
The dialog displays a list of DPUs dynamically read from the DPUList.ini
file. Click the Download button to start the sequential download of security
to each DPU one by one. The Status column, next to the DPU column,
presents status information as the download progresses through each DPU.
The following status messages may appear:
▪ Pending
▪ In progress
▪ Complete
▪ Failed
From the left-pane tree directory, right-click on the root node of a DPU to
access a menu and select Security Update to access a DPU download dialog.
When the dialog opens the phrase "Security Download Only" appears in the
Action field.
Renaming a DPU
To rename a DPU:
1. In the tree directory pane, click the DPU tab, click on the DPU node to
open the Rename a DPU dialog box.
2. The From window contains the current name of the DPU. In the To
window, type a new name and click OK. Click Cancel to close the
dialog without making any changes.
Adding a Group
Groups are created in a directory hierarchy which may be 8 levels deep.
These groups are used for organizing related function blocks together. This
hierarchy is shown and configured using a tree view structure in the left hand
display pane. Groups appear as tree branches, and the function blocks appear
as leaf nodes.
1. In the tree directory, click the DPU tab, right-click on the DPU icon in
the directory tree pane to access a pop-up menu.
Once groups are created at the first level, you can next expand into more
levels of a tree hierarchy by right-clicking as above on any individual
group in the tree view as the starting parent for new groups.
3. When you add a group, a pop-up dialog appears prompting you for a
group name and relative index:
4. Note that the title bar of the dialog shows the selected parent group in
the hierarchy where the new group will be added. Initially this must start
at the top using the DPU name as the root level ([Virtual] as shown in
this example).
Enter a group name (GName), and optionally a relative index, and click Add
Group. Both entries must be unique within the parent group. The GName
naming rules are:
• 1 – 16 characters in length.
5. You may next continue to add more groups at the same parent level by
entering another new group name and clicking the Add Group button each
time.
7. Once the parent target has moved down from the top level, the Move Up
button will become enabled. After making several hierarchy additions, you
can use this button to navigate back up the hierarchy, and then begin a new
sub-tree of group additions along the way.
8. Also note that after having added a group, the Switch To Add Blocks
shortcut button will become enabled. Using this selection will exit the dialog
and immediately call the Add Blocks dialog with the last added group as the
parent for function block additions. Refer to the later section on adding
function blocks.
After exiting, additional groups can later be iteratively added to expand the
hierarchy by repeating the above steps.
Notice that each time you add a group, a new group icon also appears in the
directory tree pane, and is made the newly selected tree location, for use in
immediately completing the group detail, and then adding function blocks.
As a simple example, one can quickly create a three level group hierarchy of
/G1/G2/G3 with an ATAG:
1. Open the dialog at the DPU root name via right click and Add Group.
2. Enter “G1” as the GName, click the Add + Move Down button.
3. Enter “G2” as the GName, click the Add + Move Down button.
4. Enter “G3” as the GName, click the Add + Move Down button.
Renaming a Group
To rename a group:
1. In the tree directory pane, click the DPU tab, click on the group node
whose name you wish to change to open the Rename a Group dialog
box.
2. The From window contains the current name of the group. In the To
window, type a new name and click OK. Click Cancel to close the
dialog without making any changes.
1. In the tree directory pane, click the DPU tab, click on the group node
whose relative index number you wish to change to open the Renumber
the Relative Index dialog box.
1. In the tree directory pane, click on a group node to select a group in the
configuration where you want to place one or more function blocks.
2. Once you select a location, right-click to open the following group pop-
up menu.
3. Select Add Block from the menu to access the following pop-up list of
available function blocks.
4. Click on a listed function block to highlight it and click Add to add that
function block to the configuration. Use the scroll bar to view the entire
list. Note the button options for viewing either a list of templates or a list
of all function blocks. Also note the tab options for viewing an
alphabetic list or a two level hierarchy list by category. Note the option
for viewing help on the selected function.
3. In the tree directory pane, click on the control whose relative index
number you wish to change to open the Renumber the Relative Index
dialog box.
Use this view to quickly configure only hardware or to access only the
hardware content of a configuration. Right-click within any folder at any
level of the folder hierarchy to access a pop-up menu containing items to add
or delete buffer function blocks. As you add buffers, they are added to each
of the three folder types.
Click on a function block appearing in the tree directory to open its tabular
detail in the right pane. The detail lists all the attributes associated with the
selected buffer. Use the Value and Reference columns to configure
attributes.
By default, the following attribute types may be configured from this tabular
view:
▪ Address
▪ Redundancy,
▪ maxPAC option,
▪ Failover type,
▪ Cabinet,
▪ Rack,
▪ Card.
Click the Reconfigure button on the tabular grid toolbar to customize the
column configuration and select other attribute types. When you click
Reconfigure the following dialog appears:
The Available Attributes window lists attributes from which you may select.
The Selected Attributes window lists attributes already selected to appear in
the tabular grid as columns. Use the left and right arrows at the center of the
dialog to move attributes between the two windows.
Click OK after making your selections. The new selections should now
appear in the tabular detail.
1. Click the Hardware tab in the left pane to open the hardware tree
directory.
2. Select and expand any one of the three standard hardware tree directory
folders.
5. Using the keyboard <Tab> key, tab to each of the other fields in the
dialog to specify a buffer module address, cabinet location, rack
location, and card number.
Use referencing:
Understanding Referencing
References consist of text strings used to identify the location of a specific
attribute. To locate an attribute within a configuration or within another
configuration, a reference text string may consist of:
Point Modifier Is used to select a DPMS object from a group; enter the
generic name assigned to a DPMS object, or the relative
identification of an object within a group.
Note: use a dot with a slash (./) or a slash by itself (/) as level separators.
Point Modifier
/#<rel> This contains the relative index identification of an object within a
group. For example:
GROUP123./AREA1/#1.in1
Where
Attribute In1 is associated with a function block having a
relative index of 1 in Group123's child, AREA1
<generic> The generic name assigned to a DPMS object. For example:
./BILL./TEMP.OUT
where
The attribute out is associated with a control having the generic
name temp.
Null
Attribute
<attribute> an input, output, parameter or status of a DPMS object
Entering References
To enter references, click on a control listed in the tree directory pane to
open its tabular detail display. Enter reference strings for the control in the
Reference column of the tabular grid view.
Notice that the Reference column contains both white fields and grayed out
fields associated with attribute categories. Fields associated with input and
parameter attribute categories are white, indicating that they may be edited.
Gray fields, associated with other attribute categories, will not accept inputs.
Input and parameter attribute categories are used to reference other
attributes, however, input type attributes are most typically used.
You may enter reference strings manually or you may take advantage of
maxDPUTOOLS auto editing features as described in Chapter 2, "Using
Auto Editing Features."
Note: you may also right-click in a reference field to access the same pop-up
or use function keys to access a pop-up. The pop-up menu available in
reference fields lists function key equivalents for each menu item.
From the pop-up, select Tag name to select any control within the
configuration that has a tag name. The pop-up lists all the available tagnames
found in a configuration.
Select Sibling to select a control within the same group by its relative index
number. The Sibling pop-up lists all index numbers associated with the
target group.
Select Hierarchy to view a tree view of groups and functions for selection.
Note: once you enter a reference, select Follow from the pop-up to go
directly to the referenced control. When you click Follow, maxDPUTOOLS
looks up the control being referenced and opens its tabular detail.
Select Toggle Quality to add or remove a leading “!” prefix which is used to
ignore quality when present in order to prevent a closed loop feedback
lockup of bad quality.
Select Print Detail to get a printed report matching the current grid contents.
To implement this, use a greater than (>) symbol as the leading character in a
reference field associated with an attribute you wish to expose. This permits
that function block attribute to be accessed by GroupName.Attribute.
If nothing follows the greater than symbol (>), then the exposed attribute
takes on the name of the function block attribute. This can only be allowed if
there is only one attribute exposed with that name. Normally, a name follows
the greater than symbol (>), which becomes the new name of the exposed
attribute.
For example:
1. Click on a control from the tree directory to select it. This feature is
available in the DPU, Hardware, and Custom tab views.
2. Select Cross Referencing from the drop down context menu to access the
Cross Referencing view pane.
When you select a control and open the utility, a log appears listing all the
controls that reference the selected control.
When the cross-referencing search is complete, the Print and File buttons
become available. Click Print to print the search log. Click Save to save the
log to a file. To close the cross-reference view pane, select the close (X icon)
button in the upper right-hand corner.
Note also the presence of a shortcut icon in select lines of the cross-
reference. These lines can act as a double click shortcut to go to the detail
for the identifier shown, along with selecting the associated attribute in the
detail grid being referenced.
In addition when a custom function is selected under the custom tab, the
cross-reference has the special meaning of where the particular custom
function is instanced rather than referenced. The list again contains double-
click-shortcut go to capability to the identifier shown.
Use the custom tabular detail to create and edit attribute definitions for a
new custom function. When you first open the tabular detail, a single row
appears featuring the same five column headings used with intrinsic function
blocks:
▪ Attributes
▪ Category
▪ Data Type
▪ Default Value
▪ Reference
▪ Description
▪ Alternate Description
▪ Security Class
Use the tabular grid toolbar to delete rows or add new rows as needed.
2. Right-click on the Local Custom top level icon in the view pane and
select Add from the pop-up menu to open the following dialog:
3. Enter the unique name of the control, add a Category and an optional
Description and click OK. NOTE: When creating the name it must be
unique. Avoid keywords like Service, LSS, Write, Read, Input, Status,
etc. and names or attributes of any standard function blocks or custom
blocks that will be imported from the standard libraries. As a general
rule, names that contain numbers or “_” are more likely to be unique.
Avoid leading or ending the name with “_”, but rather use it within the
name.
After you click OK, a new icon appears inside a category node, in the Local
Custom directory folder, bearing the names you entered when you created
the object. A blank record field appears in the right view pane. Use these
record fields to create your own attributes for the control.
Select a category for the attribute in the Category column (Input, Output, and
Parameter) via the dropdown selection, or right click in the Category column
to invoke an entry dialog for designing a new category. In designing a
Note that the previous dialog is for release 4.3 and later configuration
versions. For Earlier versions, only the Expert option is allowed, presented
as a check box, and the dialog has the following presention:
Data Types
Select a Data Type under the Data Type column. Choose from the
following:
Boolean
Complex
Enumerated
Float
Long
Relative time
Text
Time.
Once the custom name is created in the custom field, the name should now
appear in the list of available controls when a control is to be added in the
control hierarchy under the DPU tab.
The following modal dialog is used to create and edit custom enumerations:
The buttons on the right provide intuitive edit capabilities. The up / down
arrow buttons on the right provide position reordering within the list for the
highlighted selection. Selecting Add invokes another modal dialog for
defining a new value and text pair, which is then added at the end of the list.
Selecting Edit for a highlighted entry in the list invokes a modal edit dialog
for modifying the value and text. Delete removes the hightlighted entry in
the list. Restore discards all changes and restores the initial enumerations.
Save makes the changes permanent and closes the dialog. Cancel discards all
changes and closes the dialog.
The following modal dialog is invoked via the Add or Edit button for editing
a single enumeration entry:
The following modal dialog is used to create and edit custom complex data
types:
The buttons on the right provide intuitive edit capabilities. Selecting Add
invokes another modal dialog for defining a new type, which is then added to
the list in name sorted order. Selecting Edit for a highlighted entry in the list
invokes a modal edit dialog for modifying the existing type information.
Delete removes the hightlighted entry in the list, subject to a usage count of
zero. Usage invokes a modal dialog listing where the data type is in use.
The following modal dialog is invoked via the Add or Edit button for editing
a single custom data type entry:
The name entry specifies the unique name to be given to the data type (16
char max.)
The SubType specifies the unique complex subtype ( range 100 – 999).
2. Click the Source button to access a file directory. From the directory
select a configuration containing custom Functions you wish to transfer
to other configurations.
5. Click the Transfer button to transfer all the selected Functions to the
target configurations.
Creating Templates
Select the Template tab in the tree pane to create Template function blocks.
Use the template feature to create reusable models in terms of preset
attribute values for any existing intrinsic or custom function. Templates may
also be imported from libraries, or copied between configurations via cut and
paste. Different variations of the same function can be created each with a
unique description to describe the functionality represented by the preset
values of its attribute set. Once created, these templates are available as an
alternate list for selecting a function block in the Add Function Dialog used
with adding functions to a group in the DPU tree hierarchy or to a custom
function in the Custom function tree hierarchy.
2. Right-click on the Local Templates top level icon in the view pane and
select Add from the pop-up menu to open the following dialog:
After you click Add, a new node appears for any categories added, in the
Local Template directory folder. Under the category nodes, the template
nodes added appear with the names of the function selected and the alternate
description entered. Now selecting the template node will result in the
matching attribute detail to appear in the right hand pane, allowing the
customized presetting of values and references to create the desired model.
Validating References
To check the validity of references in a configuration, maxDPUTOOLS
includes a Validate References utility. Use the utility to check references
within the same configuration and also to check external references,
references pointing to function blocks in configurations in other DPUs.
When the utility finds a bad reference, the path name of the reference is
listed on a status log display. Double-click on the reference to locate where
the reference occurs in a configuration. You may print the status log or save
the log to a file.
1. Select Validate References from the File menu to start the utility. When
the utility is started a status log display appears at the bottom of your
screen opened in a third viewing pane. When the utility finishes its
search, it lists the path names of all the found bad references and reports
an error and warning count total.
Note: by default the External checkbox is checked when you first open the
utility. This means the utility will also check references pointing to function
blocks in other DPUs. To limit the search to references only in the currently
opened configuration, uncheck the checkbox. The optimized checkbox
option can also be unchecked to eliminate the warnings for non-optimized
references, and thus declutter the view to errors only.
3. To save the status log file to disk, click the File button.
4. To close the validation view pane, select the close (X icon) button in the
upper right-hand corner.
When the utility finds an error or warning, the path name of the attribute is
listed on a status log display (typically Addr). Double-click on the status log
entry to navigate to where the attribute occurs in a configuration for editing.
You may print the status log or save the log to a file.
Note that the utility is also automatically run prior to a download. Any errors
will prevent the download from proceedings. Warnings are ignored.
In the above example a mix of errors and warnings are demonstrated. Note
the presence of shortcut go to icons in the list. Those lines containing such
an indication may be clicked to navigate to the detail pane where the error
exists, along with selection of the particular attribute in need of correction.
After making corrections and saving the updates, click the Start button to
rerun the validation.
To save the status log file to disk, click the File button.
To close the validation view pane, select the close (X icon) button in the
upper right-hand corner.
When the utility finds an error or warning, the path name of the attribute is
listed on a status log display. Double-click on the status log entry to locate
where the attribute occurs in a configuration. You may print the status log or
save the log to a file.
Note that the utility is also automatically run prior to a download. Any errors
will prevent the download from proceedings. Warnings are annunciated via a
messagebox with the option to continue the download.
In the above example a mix of errors and warnings are demonstrated. Note
the presence of shortcut go to icons in the list. Those lines containing such
an indication may be clicked to navigate to the detail pane where the error
exists, along with selection of the particular attribute in need of correction.
After making corrections and saving the updates, click the Start button to
rerun the validation.
To save the status log file to disk, click the File button.
To close the validation view pane, select the close (X icon) button in the
upper right-hand corner.
1. Select Find and Replace from the File menu to access the Find and
Replace dialog box.
2. In the Service field click the down arrow to select a control from a drop
down list or accept the default, <ALL>, to search on all available
controls.
3. In the Attribute field, click the down arrow to select an attribute type
from a drop down list, or accept the default, <ALL>. If you accept the
default, the utility searches for values and references associated with all
attributes in a configuration.
4. In the field labeled In, select value or reference to direct the search tool
to search in reference fields or value fields. The tool cannot search both
values and references in one pass.
6. In the field labeled Find, enter a substring you want the search tool to
find.
8. Click the Find button to begin the search and replace. When you click
Find, the first point name containing the substring matching the search
criteria appears under Results in the ID field. The From field contains
the target substring match. The To field contains the replacement
substring you entered in the Replace field. You may edit the replacement
substring appearing in this field if you desire.
9. Click the Replace button to replace the value or reference for the
selected point.
10. Click Replace All to replace all values or reference matching the search
criterion at one time.
To perform a search:
1. Select Search from the File menu to access the following dialog.
4. To make the search more specific, in the Value window, enter a value
string or wildcard pattern. By default, the search utility looks for "like"
When the search begins, the search utility opens a new dialog featuring a
search log and a new set of buttons. The search log reports when the search
was begun, describes the search criteria, and lists specific matches. The bar
at the bottom of the dialog reports total number of matches found.
Click the Print button to print the search results, or click the File button to
save the search results to a file.
1. Select Find by Tag Name from the View menu to open the Select a Tag
Name dialog box.
2. The dialog presents you with a list of all tag names in the configuration
database. Click on a tag name from the list to select it and click OK to
begin the search. Alternatively, a tagname may be typed or pasted into
the text box at the top. The text box supports auto-completion and will
position the list box to match for reviewing the description and function
type before selecting OK.
1. Select the I/O Cross Reference sub-menu selection from the File menu
to open the summary as a modal dialog box. This may take a while to
search the configuration for the data to display.
3. Note the Combo Box labeled as Sort. This provides for four choices in
the Sorting and column ordering of the grid:
4. Note that the display dialog window can be resized by dragging its edges
(the above pictures were intentionally made small as examples), or
selecting the maximize button at the top right of the title bar.
6. The contents of the grid can be consecutively filtered or drilled down via
the use of a context menu that will appear when a right click action is
performed in a cell location of interest:
7. As shown above, the cell value at row 4 and column 6 was selected and a
substring of the cell text was highlighted. Note that without performing
any highlighting, the complete cell text is used as the selected text. Note:
Numeric field will always use the complete cell text. Next a right click
was used to invoke the context menu for filtering. Five choices exists:
• Fiter by Selection – Remove all rows that don’t match the selection.
• Filter Excluding Selection – Remove all rows that match the selection.
• Filter by Entry – Invoke a dialog box for entry of a pattern match string
using wildcard characters to be the selected text for filtering.
• Remove Filter – Disabled as no previous filtering has been applied.
• Cancel – Close the context menu and take no action.
The number of rows has been reduced to 7, those matching the filter criteria.
9. Note that the two filter buttons have now been enabled:
The left-hand Undo button can be used to remove just the last filter
applied. The right hand Remove Filter button removes all filtering. In
this way through a stepped combination of filtering the grid content can
be drilled down. Any mistake in filtering can be removed via the Undo
button.
10. The Print button provides a formatted report output to a printer. The
column ordering and width on display is used as the formatting, with
a header and page numbering provided.
12. The Export button produces CSV output for use with MS-EXCEL.
To begin a search:
1. Select Duplicate Names from the File Menu to open the search tool
dialog display.
3. Click the Start button to begin the search. The search results appear in
the bottom window of the dialog display.
The search results window reports the date and time the search was
requested, when the search ended, and how many total duplicates were found
for all configurations searched. Each configuration in the search is compared
to one or more other configurations in the search.
Two configurations are compared at one time until all combinations have
been analyzed. The main body of the search report details which two
configurations were compared, how many duplicates were found for this
specific comparison, followed by a listing of each duplicate tag name found.
Click the Print button to print the search results, or click the File button to
save the search results to a file.
When you select Repair, maxDPUTOOLS goes back to the last successful
transaction before the interruption occurred. Your most recent edits may be
lost.
Select Compact Database from the File menu for an open configuration.
When you select Compact Database, the utility begins to compact the
selected configuration. When the utility finishes, a prompt informs you that
compacting is completed. Click OK. Note that automatic compacting always
occurs when initially opening a configuration. This feature is most useful
after a significant number of edits have been performed, and a separate
backup copy is desired before continuing, or the configuration is just being
closed prior to an archive copying operation. When performing a backup
copy, compact first then select Backup from the file menu.
1. Select the Configuration Upload entry from the File menu to access the
following dialog box.
2. In the Select a DPU section, click the down arrow of the name entry to
select an entry from a drop-down list. Note that all DPUs should be
present sorted by their name and backup role. Choosing one will cause
the live operational status on the right to be activated as follows:
• DPU_ACTIVE_STAND_ALONE
• DPU_ACTIVE_UNINIT_STAND_BY
• DPU_ACTIVE_WARMING_STAND_BY
• DPU_ACTIVE_FAILED_STAND_BY
• DPU_INACTIVE_HOT
6. Next, click the Upload button to access a Windows file directory dialog,
which permits you to copy the configuration to a new name. If you don't
make a copy, the uploaded configuration will overwrite any original
configuration having the same name.
When you click Upload and create a copy of the target configuration, the
upload utility begins to load the configuration. A progress bar appears at the
bottom of the dialog. A trace log appears in the center of the dialog to report
any errors or problems during the upload.
When the upload is finished, click the Print button to print the trace log or
click the Save button to save the log to a file.
Note: the upload utility attempts to match the DPU version being uploaded.
If the utility cannot find a DPU matching version after you click the Upload
button, the following warning dialog box appears:
Should this dialog appear, click OK to access the DPU Version Selection
dialog. From this dialog, select an alternative version master.
1. Select the Configuration Bulk Upload entry from the File menu to start a
multiple selection upload. Note that this same capability also exists as a
stand-alone application program named maxDPUToolsUpload.exe in the
C:\Mcs\maxDPUTools folder, providing an easy method of performing a
complete save of the DPU running set. The program’s advantage is the
capability to completely minimize itself to the tray while running.
2. The bulk upload will first present a multi-selection check-box list dialog.
Note that all DPUs should be present sorted by their name and backup
role. The dialog will show the operational status of each, and again
provide preferred recommendations based on current state and backup
link status, based on the rules pereviously stated above:
5. Next select a destination folder, and then finally select the Upload
command button to begin.
7. Note that when starting each upload if the operational status has changed
from that when originally selected, this will be considered an error and
the individual DPU will be skipped. The intent is to favor uploading in
the “Inactive Hot” state to avoid any loading on the other DPU of the
Pair running in “Active Hot Standby” state.
9. After completion review the log for any errors. The log may be printed and/or saved as a
file.
Overview
The maxDPUTOOLS utility now supports performing graphical
configuration for a version 4.3 or later DPU 4F configuration.
• Toolbars and context menus, combined with the keyboard and mouse,
are used to accomplish various edit actions.
Valmet •278597 •
maxDPUTools User's Guide
• No main menu exists. Similar operations are all performed via the tool
bar buttons, pop-up context menus, or keyboard short cut entry.
• All edits are saved as they are made in the currently open configuration
file. Appropriately timed configuration file backups are recommended.
• All custom block instances appearing in groups are always locked, with
their detail inaccessible.
• Wiring edits made in the tabular view that affect the sheet drawing are
immediately refreshed in the sheet, and vice versa.
Getting Started
The graphical configuration view is launched from within the tree view of
maxDPUTOOLS. First select any node in the tree view under the DPU tab or
an individual custom block under the Custom tab view. Then right click to
access the context menu entry labeled as “Graphical Configuration…”.
Alternatively, the short cut keystroke “<Ctrl>-G” can be used after selection.
Within the DPU tab, selecting the top level DPU node in the tree, will result
in a sheet view of the top-level group of the DPU with a path of “/”. Note
that the “/System” group is explicitly hidden from view, since its content
should not be edited!
Lastly, selecting a custom block node from the custom tab view yields the
special version of a sheet used for custom block design, with Input and
Output shell connector blocks.
The dialog title bar contains the name of the configuration file along with the
name of the group hierarchy represented by the sheet. Note that no main
menu is present as in maxVUE.
Otherwise the above example sheet has an identical look and operation to
maxVUE Editor. As shown, the Editor view and Graphical Configuration
toolbars are optionally docked at the top, along with the Thumbnail view
floating. Excluded from view are the Graphic Drawing and Control List
toolbars, which can be enabled using the context menu checkbox selections
as shown.
• The Browse Configuration button, , has also been duplicated from the
Graphic Drawing toolbar to avoid the necessity of showing the drawing
toolbar.
• The Freeze check and Values/Names buttons have been removed and are
not supported by maxDPUTOOLS.
• The Alternate language and test mode related buttons have been
removed and are not supported by maxDPUTOOLS.
Shortcut Keys
The following shortcut keys are available, even with the toolbars not present:
The tabular detail layout and operation is identical to that in the main editor
display of maxDPUTOOLS. Once open, the detail persists and follows the
selected point, until closed via the button shown at the top right of the
detail. Note the splitter bar in between the sheet and detail panes, which
allows resizing of the detail pane via mouse selection and drag movement
The selection dialog is a tree view of the Group and function hierarchy.
Navigate to and select a group or function within a group to view,
completing the selection with the OK button, or a double click. The initial
display always navigates to and selects the currently viewed group as a
starting reference. Note that a selected function within a group will show as
initially selected in yellow highlight within the correct sheet page of the
group.
Saving MN Displays
The Graphical Configuration view implicitly keeps track of the editing of a
sheet when it includes any optional graphical elements or controls. Upon
adding, editing, or deleting graphical elements or controls, the following
prompt will appear upon closing the sheet if a File Save using the Graphic
Drawing toolbar button was not performed:
An initial save also confirms the file name and folder location desired:
The default folder where group sheet files are saved is named after the
configured DPU name: with a pathname of
“C:\Custom\Configs\Operating\[DPUNAME]”.
The default folder where custom function sheet files are saved is named:
C:\Custom\Configs\Operating\Library” and is intended to be shared among
configurations.
Downloading a Configuration
Overview
maxDPUTOOLS allows you to install all or part of a configuration. Use
maxDPUTOOLS to install an entire configuration (full installation) or to
install any part of the configuration down to a single function block (an
incremental installation).
In the tree directory, select the DPU icon at the top to perform a full
installation of the configuration. To perform a partial installation, select any
level of a group hierarchy or a single point within a group. When you select
a group, the Download option installs all groups nested under the selected
parent group.
Valmet •278597 •
maxDPUTools User's Guide
A mismatch may occur when a maxDPU has been upgraded with the latest
firmware update but the maxSTATION contains an older version of
maxDPUTOOLS or vice versa. Use this override with caution; this should
not be considered normal! There may exist significant compatibility
differences, particularly between major releases, that will result in
unexpected behavior.
In the Selection area, the DPU name and the type of install (in this case a full
download) are already entered in the appropriate fields. The IP address of
the target DPU appears in the Primary Address window. Note the optional
field for entering a reason statement, which will become part of the
download history log file (See later chapter on Configuration Management).
Note: If you are creating a configuration and defining a new DPU for the
first time, only the fields in the Selection area are filled in. Other information
fields are blank and associated buttons are not available. See Figure 4-2. See
"Starting a Download when the DPU Is Not Defined."
Upon starting a download, the backup link between the DPU pairs will be
automatically disabled to prevent the active DPU from updating the inactive
DPU during a download.
Standalone Mode
Standalone mode of a DPU pair is used for downloading of a new database
to a DPU. The DPU pair can be left in Standalone mode to allow testing of
database variations or updates.
To accomplish this testing, each DPU will need to be downloaded with the
desired database. In Standalone mode it is assumed that the active will
remain in control and no automatic failover will take place. In this mode no
database update information is passed over the backup link. The only
information sent across the link is the current state of the outputs.
This information is used by the inactive DPU to maintain the current state of
the outputs in the event of a failover. However, since the control algorithms
may be different, a DPU taking over will freeze all outputs. You must
unfreeze the outputs to re-establish automatic control.
The State LED is green on the active DPU and yellow on the inactive DPU.
Then click the Download button to begin the configuration transfer to the
target DPU. Note: When this DPU is made active, all outputs will become
frozen. The Download Freeze Check program will need to be run after this
DPU is made active.
The DPUs will enter a warming state. In the warming state, there can be no
automatic failover since the database in the inactive is not complete. Once
the warming is complete, the inactive will enter an “Inactive Hot Standby”
state. In this mode the following conditions will cause failover:
Enabling Backup will cause the active DPU to “restart” the inactive DPU
and then send a current copy of the database to it. The bottom LED of the
active DPU will flash from green to red while warming the inactive DPU.
The inactive DPU will flash from red to yellow while warming.
When the backup is fully functional, the active DPU will flash yellow to
green and the inactive from yellow to off. At that point, a failure of the
active DPU will result in the inactive taking control. Manual intervention is
required to enable the previous active to become an available backup. To
accomplish this, reset the failed DPU.
When the download is finished, Print and File buttons next to the Info
window become available. Click the Print button to print the search results,
or click the File button to save the search results to a file.
To define a single DPU or DPU pair, you must first enter a DPU IP address.
The download dialog, in turn, updates the DPUlist.ini file.
1. In the tree directory, click on the DPU icon and right-click to access the
DPU pop-up menu.
2. Select Download from the menu to access the download dialog. Notice
that in the Selection area the DPU name is already entered. In the Action
field, the type of download is full.
3. In the Primary Address field, enter the IP address of the target DPU in
the form n.n.n.n and click Save.
4. When you click save, maxDPUTOOLS updates the DPUlist.ini file. You
are prompted to confirm the update. Click Yes or No.
5. If you select Yes from the last step, a second prompt asks you if the
target DPU is part of a backup pair. Click Yes or No. If you click Yes,
the dialog displays a description of the backup DPU. If the download
proceeds without errors, maxDPUTOOLS informs you that the update
succeeded. Click OK.
The Download dialog contains a Critical Resource Usage section as show below:
The Critical Resource Usage shows the actual count, the maximum capacity, and the
percentage in use of the services and the references defined in the configuration. These limits
will vary with the DPU model. Exceeding either of the maximum capacity limits will prevent
any download.
Typically the services are the more critical resource used. A Services Limit Warning will
occur when less than 500 spares remains. Spares are recommended to support an incremental
download where custom functions have changed, which may require the need for more than
the stated usage.
1. In the tree directory, click on any group icon at any level of the
configuration and right-click to access the group pop-up menu.
2. Select Download from the menu to access the download dialog. Notice
that in the Selection area the DPU name is already entered. In the Action
field, the path name of the group about to be installed appears.
3. In the Primary Address field, enter the IP address of the target DPU in
the form n.n.n.n and click Save.
4. When you click Save, maxDPUTOOLS updates the DPUlist.ini file. You
are prompted to confirm the update. Click Yes or No.
5. If you select Yes from the last step, a second prompt asks you if the
target DPU is part of a backup pair. Click Yes or No. If you click Yes,
the dialog displays a description of the backup DPU. If the download
proceeds without errors, maxDPUTOOLS informs you that the update
succeeded. Click OK.
1. In the tree directory, click on a point you wish to install and right-click
to access the control pop-up menu.
2. Select Download from the menu to access the download dialog. Notice
that in the Selection area the DPU name is already entered. In the Action
field, the path name of the point about to be installed appears.
3. In the Primary Address field, enter the IP address of the target DPU in
the form n.n.n.n and click Save.
4. When you click Save, maxDPUTOOLS updates the DPUlist.ini file. You
are prompted to confirm the update. Click Yes or No.
5. If you select Yes from the last step, a second prompt asks you if the
target DPU is part of a backup pair. Click Yes or No. If you click Yes,
If neither the GName nor the SvcRelIdx is present in the running DPU under
the parent Group in the DPU, then an addition will occur.
If both the GName and SvcRelIdx are present and assigned to a single group
instance in the DPU under a matching parent group, then an update will
result.
Special handling is provided, so, that when the parent group hierarchy is
missing in the maxDPU, it is also included in the downloaded hierarchy.
Incremental Adding
Adding is straightforward, with all details handled.
Incremental Modifying
Modifying an existing hierarchy is performed as a merge operation. A merge
operation proceeds by determining what instances have been added, deleted,
or are still present in the configuration as compared to that in the running
DPU. This is based on parent, function type and SvcRelIdx (similar to the
starting instance scenario above).
Any instances that were present in both the configuration and DPU at the
start are unmarked for deletion.
All attribute values and references for all instances are then written to
complete the download.
The first step is to examine the intended download content for the presence
of instances of custom functions:
Second, the comparison then repeats, as needed, with the full comparison of
all of the child functions as well as any nested custom function children, and
their attribute values and reference settings. For example, if custom function
‘A’ contains a ‘B’ and ‘B’ is found to be different, then ‘A’ is also
considered modified, requiring re-downloading.
Note:
The key to this scrubbing is the presence of the ‘~’ tilde character in the
name. Hence, although tilde has been enabled as a legal character in the
creation of a custom function name (for the sake of possible uploading and
difference merging), its use should be restricted to the rename feature
described.
The side effect of all of this is the introduction of closely related custom
function variants in a running DPU. The user must manage the effects of this
when considering and performing online differences and/or full upload
operations. If these variants are introduced into a configuration because of
difference merging or full uploading, they should be considered for
collapsing into a single custom function matching the latest design.
Alternatively, they could be distinctly renamed and described if it is to be
kept.
definition as well. This feature allows changing instances of one type into
another preserving the value and reference assignments of all the attributes
common to both types. In the case of the custom function definition, right
clicking on the custom function folder node within the Custom Tree view
will call up a context menu containing the “Change Function Type” as one
of its option. The meaning of selecting this option for a custom function
definition is to rename ALL existing instances of this custom function
throughout the whole configuration into the function selected from the list in
the popup dialog display. After the selection, another message box will
appear prompting if the actual function definition should also be deleted as
well.
Use this feature with caution and be sure to review the results!
Overview
maxDPUTOOLS provides a master configuration management feature based
on the successful completion of download actions:
Also provided is the option for a user entered reason line as a history log
entry during the initiation of downloading. A text entry field appears within
the download dialog for this purpose.
Valmet •278597 •
maxDPUTools User's Guide
Overview
Point data created and edited in Microsoft Access or from some other source
file, such as in a text editor, may be imported into maxDPUTOOLS using the
import utility. Conversely, all or portions of a database created using
maxDPUTOOLS may be exported to Access as an .mdb file or to a text
editor as a formatted .dat file.
Use the import utility to capture point data created outside maxDPUTOOLS.
Use the Export utility to transfer point data from maxDPUTOOLS to an
Access database or to a text editor. The Export utility may be useful for
merging together portions of various configurations developed
independently in maxDPUTOOLS, or to perform quick edits to values and
references. The point database may then be imported back into
maxDPUTOOLS.
▪ Attributes
Valmet •278597 •
maxDPUTools User's Guide
▪ Data types
▪ Instance attributes
▪ Scheme version
▪ Services (function blocks, custom controls)
▪ Steam property out types
▪ Thermocouple and RTD signal types
If you are importing a text file, point data should be formatted as shown into
following example:
<Begin>
Service=ABS
Parent=/x
RelIdx=1
SvcX=0
SvcY=0
In1=0
In1_Ref=
In1_RefTurn=
In2=0
In2_Ref=
In2_RefTurn=
K1=1
K1_Ref=
K1_RefTurn=
K2=1
K2_Ref=
K2_RefTurn=
Out_Ref=
Out_RefTurn=
SvcPriority=60
SvcSecLevel=3
SvcTimeBase=3
<End>
Figure 5-1. Sample .dat File
The text file is composed of one or more lines of text per point. Use the
following formats:
Service=string
Attribute=valuestring
Attribute=valuestring
Attribute=valuestring
Service=string <tab>Attribute=valuestring
Attribute=valuestring<tab>Attribute=valuestring
Note that the keyword Service denotes the start of an addition followed by
one or more attributes.
Attributes can be in any order. Leading and trailing white space (tabs,
blanks) are ignored.
The import function supports both formats, while the export function
supports the one line per attribute format.
Error Handling
Import will enforce the validation of parameters to include:
▪ Service type must exist (must be a legal function block type). (error)
▪ Parent must be specified. (error)
▪ Attribute must exist. (warning)
If any error is found, the point is not added. If any warning is found, the
attribute is not set.
Service=ATAG<tab>Parent=/u2/bms/l3<tab>Gname=G1<tab>Limhi=100.1
Service=ATAG
Parent=/u2/bms/l3
Gname=G1
Limhi=100.1
Service=ATAG<tab>Parent=/u2/bms/l3
Gname=G1<tab>Limhi=100.1
If you are exporting to a database, such as Access, that uses fixed table
formatting, select the attributes you intend to export and place them into a
named table. The table can then be exported as a database file with an .mdb
extension to Access.
If you export point data as a simple .dat file, the export utility automatically
formats the point data as shown in Figure 5-1.
If you click File, the following Import from a File dialog box appears:
In most respects, the two dialogs are similar, except the Import from an
External Database dialog features two tabs for selecting Microsoft Access
tables and queries.
In both sample dialog boxes, notice that the first two fields are already filled
in. The Hierarchy field contains the name of the hierarchy level you selected
in the tree directory where you wish to place the imported point data. The
Database field in the Import from an External Database dialog contains the
path name of the .mdb to be imported. Likewise, the Source File field of the
Import from a File dialog contains the path name of the .dat file to be
imported. To edit the Database or Source File fields in their respective
dialogs and select a different path or file, click the Ellipsis button.
In this dialog to edit the target .mdb file before the import, click the Edit
button to open the file in a Microsoft Access session.
Additionally, this dialog allows you to select which tables or stored queries
you wish to import.
1. Select the Tables tab or Queries tab in the center of the dialog and then
click on the table or query names you wish to import from the scrolling
list.
3. Select Replace to replace the root group of any parent field with the
selected imported hierarchy.
4. Under Mode, click the Insert New radio button if you wish to add a new
set of points to the configuration. They are added to a selected location
in the tree. If you are updating existing points identified by tagname,
gname or relative index number, click the appropriate radio buttons. The
import utility will then use tagnames, Gnames, or index numbers as the
update correlation key.
If the import utility detects problems with the import file, the Warnings and
Errors buttons become available. A warning is generated if data is missing.
An error is generated if the import utility detects bad service names. Click
the Warnings or Errors buttons to open log files in a text editor, such as
WordPad. See Figures 5-2 and 5-3.
1. From the Import from a File dialog, click the Prefix or Replace radio
buttons under Parenting to determine how the imported point data should
be placed in the target configuration. Select Prefix to append imported
group hierarchies to an existing parent group in the target configuration.
2. Select Replace to replace the root group of any parent field with the
selected imported hierarchy.
3. Under Mode, click the Insert New radio button if you wish to add a new
set of points to the configuration. They are added to a selected location
in the tree. If you are updating existing points identified by tagname,
gname or relative index number, click the appropriate radio buttons. The
import utility will then use tagnames, Gnames, or index numbers as the
update correlation key.
1. Open a maxDPUTOOLS file and select the points you wish to export in
the tree directory pane. You may select points from any level of the
hierarchy ranging from the DPU root, group nodes, or a single point
within a group.
2. Select a level of the hierarchy, right-click and select Export from the
pop-up menu. Click Database to export to an Access fixed-table format
.mdb file or click File to export to a formatted .dat file.
If you click File, the following Export to File dialog box appears:
Both dialogs feature Selection and Destination fields that are already filled
in when the dialogs open.
The Selection field contains the name of the hierarchy level you selected in
the tree directory, indicating which portion of the database you wish to
export. The destination field contains the path name of the .mdb or .dat file
2. Under Mode, click Create a New Table, if this is a new table or click
Reuse Table, Clearing, if this is an existing table.
Note: The table you create here becomes a .mdb file containing the point
data to export. After a successful export, you may open this table in Access.
3. In the Selected Services window, check the services you wish to export.
Click Select All to check all the services listed in the window, or click
Clear All to clear all the selections and select individual services.
7. After making your selections, click Start to begin the export. When the
export begins, a progress bar appears at the bottom of the dialog. When
the export utility finishes, an Access session opens containing the table
you created using the Export utility.
Exporting to a File
To export to a .dat file:
1. Open the Export to a File dialog and check the services you wish to
export in the Services window. Click Select All to check all the services
listed in the window, or click Clear All to clear all the selections and
select individual services.
2. After making your selections, click Start to begin the export. When the
export begins, a progress bar appears at the bottom of the dialog. When
the export utility finishes, the utility creates a formatted .dat that you
may open in any text editor, such as WordPad.
Overview
The maxDPUTOOLS Configuration Editor includes a utility that detects
changes between two configurations or changes between a configuration
created in maxDPUTOOLS and a downloaded configuration running on a
maxDPU. Changes to a running configuration may be introduced online
using such applications as the MAXVUE Graphical Configurator or Point
Browser.
Valmet •278597 •
maxDPUTools User's Guide
When the Differences utility finishes its analysis, you are presented with a
two-pane dialog showing the comparison results. The dialog consists of a
tree directory pane on the left, and a tabular detail on the right. As with the
standard maxDPUTOOLS main editing window, select an object in the tree
directory to view an associated tabular detail.
Where differences exist, the hierarchical tree contains group folder and
function instance nodes along with the possible addition of individual
attribute leaf nodes. Each contains a text description describing the
difference as existing only in the master or replica, or as an attribute
modification.
Differences Types
Reported differences may consist of:
▪ Attribute modifications
▪ Graphical Configurator drawing modifications and attribute changes
After you execute the Differences utility, you may generate and print a list of
found differences.
Audit Trail
Lastly, an audit trail is accumulated for all applied updates and the results
may then be printed or saved to a file. See “Viewing the Change Log.”
Differences Performance
Large configuration comparisons could potentially tax the resources of
DPUs and maxSTATIONs. For a full comparison of a large configuration,
the execution of differences against a maxDPU requires significant SBP
throughput of attribute read operations, potentially on the order of 100,000.
Because this represents the most significant bottleneck to performance a
balance must be achieved which leverages pipelining the reads via
asynchronous responses. Performance, however, at the same time must be
throttled to not overload the system and in particular the maxDPU.
Differences Compatibility
When comparing two configurations, both are required to be at the same
internal schema and release version levels. Otherwise the comparison will
not proceed. Refer to the section on multiple version support for more details
regarding release versioning support.
2. Expand the configuration in the tree directory and select a level you
which to include in the comparison. For a full hierarchical comparison,
start at the top level. You may also limit the comparison to a specific
level within a hierarchy or even a specific individual function.
The dialog consists of the live operational status for the DPU(s), and in the
case of a DPU pair allowing the selection of one of the pair. A preferred
selection will usually be highlighted based on the current combination of the
operational status and backup link as the
• DPU_ACTIVE_STAND_ALONE
• DPU_ACTIVE_UNINIT_STAND_BY
• DPU_ACTIVE_WARMING_STAND_BY
• DPU_ACTIVE_FAILED_STAND_BY
• DPU_INACTIVE_HOT
Click the Cancel button to cancel the selection operation or press the <Esc>
key to close the dialog and return to the main editor display.
Click OK to close the error dialog and return to the main editor display
view.
The full screen difference dialog contains a header section that displays the
master and replica selections, along with any starting hierarchical level
selection made in the tree. Note that the replica text is color coded blue. Any
items in the tree that exist only in the replica also contain text description
color-coded blue as a visual correlation.
The dialog footer section contains command buttons for the repeated re-
execution of comparison, optionally varying the mode between Full and
Selective.
Click the Cancel Comparison button to halt the utility while a comparison
is in progress.
Click the View Change Log button (on the full-screen dialog) to view a
changes log (audit trail) in a separate dialog.
Select Full Comparison on the smaller dialog (the <Enter> key default) to
begin the comparison including all function types and their attributes as
qualifying.
Select Cancel (or <Esc>) to close the differences dialog and return to the
main editor display view.
The dialog consists of six Quick Options buttons and an attribute selections
checkbox-style, tree directory consisting of function names and associated
attributes.
A check indicates inclusion for comparison. Use the space bar to toggle the
checked status of a selected node in tree. A gray background check mark is
used as a special case for a function that has some but not all attributes
included. A Selected Only option box exists to limit the tree to selected
items only for review.
Use the Quick Options buttons to filter the differences to selected categories
of attributes as shown. Click the Include All button to select all functions
and attributes or click the Exclude All button to uncheck all checkboxes to
make individual selections.
Click the Names button to mark all Tagnames and Gnames as included.
Click the Parameters option to mark all value attributes as included (vs.
References).
Click the References option to include all .Ref of attributes intended for the
discovery of any changes in wiring. Note that .Ref also implicitly includes
.RefTurns from sheet drawings.
After you select initial mode options or iterative difference execution, the
utility begins to prepare differences. As this is occurring, the following
dialog appears:
Notice that the Cancel Comparison command button is enabled for the
duration of the difference processing to allow aborting. The editor
synchronously waits for completion, disallowing any other entry until
completed or canceled.
2. Four attributes were changed for the ABS instance. Note the value
comparisons in the tree node text, and the synchronized grid showing the
master’s detail for the ABS function with the attribute highlighted.
Note the distinct edit pencil icon unique to attribute differences. All
other icons used are the same as in the main edit tree view.
Merging Differences
As described in the previous section, when the utility finds differences
between a master and replica, these are enumerated in an expandable tree
directory appearing in the left view pane. When you right-click on a
differences entry in the directory, a pop-up menu appears showing the
following available edit actions. Review the following sections for an
explanation of each.
▪ Print differences
To merge differences:
Click on any level of a hierarchy in the tree directory, right-click and select
Merge Differences from the pop-up menu.
After you select Merge Differences, the utility compares and analyzes the
selected configuration at each level of the hierarchy, and automatically
performs the appropriate additions and deletions to the master to make it
match the replica.
In the following figure, for example, the ABS instance node was selected.
Because the function node was selected the action will affect all four of the
attribute differences included hierarchically.
Alternatively, as shown in the figure, you may select the G2, or G1, or top
level DPU for merging or hiding of a hierarchy.
Adding Differences
When you click on a singular difference instance in the tree directory
containing the text, Exist Only in the Replica, the context menu available
after a right click contains the Add Differences command. Use this
command to add the instance or hierarchy that exists only in the replica to
make it match the master.
1. Right-click and select Add Differences from the pop-up menu to add the
instance to the master.
2. When the instance is added to the master, the affected tree note entry is
removed from the display.
Deleting Differences
When you click on a singular difference instance in the tree directory
containing the text, Exist Only in the Master, the context menu available
after a right click contains the Delete Differences command. Use this
command to delete the instance or hierarchy that exists only in the master to
make it match the replica.
When the instance is deleted from the master, the affected tree note entry is
removed from the display.
Hiding Differences
Select the Hide Differences option to remove a singular node or hierarchical
branch in the tree without applying any changes. Use this option to
selectively eliminate differences that are not to be included in a subsequent
hierarchical edit action, or to remove differences no longer of interest to
declutter the display.
When all differences have been removed either through merging or hiding
the following dialog appears:
Click the View Change Log button at the bottom of the maxDPUTOOLS
Differences main display to view the following dialog:
The dialog contains a scrolling list, each line of which represents an applied
change. The list is sorted alphabetically to be close to a hierarchical
identifier order, regardless of the chronological order of the applied changes.
Each line contains a full path identification.
Click the Print button to invoke the Windows standard printer dialog,
allowing you to select a printer destination and of copies.
Click the File button to invoke the standard Windows save-as dialog to save
the log as a file. The file is saved to the following default location:
C:\Temp\DiffEdits.log
Execute the Differences utility and open the tree directory containing a list
of enumerated differences.
Click to select some level of the hierarchy in the tree directory. The printed
list will include any differences found within the selected hierarchy
inclusive.
Right-click and select Print Differences from the pop-up menu to access the
following dialog:
Click the Print button to invoke the Windows standard printer dialog,
allowing you to select a printer destination and number of copies.
Click the File button to invoke the standard Windows save-as dialog to save
the log as a file. The file is saved to the following default location:
C:\Temp\Differences.log
Note that in the tree a top level “<Custom Functions>” node appears when
such differences are present in addition to the DPU top level node. This is
distinct from the normal edit display where a separate tabular selection is
required to view the custom function definitions.
Custom functions can thus be added, and the instances also added all within
one difference run as long as the definition is added first.
It is presumed that such online edit actions are typically part of the
incremental creation and testing of a custom function definition presumably
running in a simulation environment.
Valmet does not recommend these types of edits remain in place in a running
DPU since it creates inconsistencies, that can later be lost. Once stable, the
custom block design should be locked to prevent inadvertent changes that
would result in this problem. If an online change is necessary, care should
be taken to update all instances. Editing of the Template instance is not
recommended, as it is excluded in online differences.
There are also two distinct presentations for custom function differences
based on whether a comparison to a maxDPU or a configuration is being
performed:
The Function folder itself only has the option for Hide. Details of the
differences within the instance will be present for viewing, but edit actions
can only be performed at the individual instance level and not selectively
within its hierarchy. In such a case, if an individual instance is merged or
added, then the whole of the function folder is subsequently removed from
the tree upon completion of the action.