Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
278597 Rev. A1
Refer to this publication for complete and accurate information that helps you better operate and service Metso Automation equipment. Your comments and suggestions are welcome. Metso Automation 1180 Church Road Lansdale, PA 19446 Attention: Manager, Technical Publications
Copyright 2004 by Metso Automation MAX Controls Inc. Printed in the United States of America All Rights Reserved
Contents
CHAPTER 1 ...................................................................................................................... 1-1
Constructing a Configuration-- an Introduction......................................................................................................1-1 Overview ...................................................................................................................................................................1-1 Creating Configurations Using maxDPUTools .................................................................................................1-1 Understanding Function Blocks ........................................................................................................................1-2 Defining Hardware Resources...............................................................................................................................1-2 Distributed Processing Unit...............................................................................................................................1-2 Backing Up the DPU .........................................................................................................................................1-2 Automatic Failover/Manual Takeover...............................................................................................................1-2 Defining I/O Modules........................................................................................................................................1-3 I/O Addressing...................................................................................................................................................1-4 Creating or Editing the I/O Inventory................................................................................................................1-4 I/O Configuration Rules ....................................................................................................................................1-4 I/O Module Types and Associated Signals........................................................................................................1-4 Digital Input Modules........................................................................................................................................1-4 Digital Output Modules .....................................................................................................................................1-5 Thermocouple/Millivolt Analog Input Module .................................................................................................1-5 Resistance Temperature Detector (RTD) Input Module....................................................................................1-6 Analog Output Modules ....................................................................................................................................1-6 Four-channel Position Adjusting Type (PAT)...................................................................................................1-6 Counter/Timer (Pulse) Module..........................................................................................................................1-6 Function block Categories .....................................................................................................................................1-6 Understanding Attributes.......................................................................................................................................1-8 Understanding Data Types ....................................................................................................................................1-8 Boolean..............................................................................................................................................................1-9 Integer................................................................................................................................................................1-9 Enumerated........................................................................................................................................................1-9 Float...................................................................................................................................................................1-9 String .................................................................................................................................................................1-9 Absolute Time .................................................................................................................................................1-10 Relative Time...................................................................................................................................................1-10 Complex Data Type.............................................................................................................................................1-10 Standard Complex Data...................................................................................................................................1-10 Forceback ........................................................................................................................................................1-10 Incremental Control Data ................................................................................................................................1-10 Family Ties ......................................................................................................................................................1-11 Using Hierarchical Groups ..................................................................................................................................1-11 Copying and Pasting Groups ...........................................................................................................................1-11 Adding a Group ...............................................................................................................................................1-11 Group Attributes ..............................................................................................................................................1-12 Setting Group Execution Rates and Priorities .................................................................................................1-12 Using Custom Blocks to Create Reusable Functionality.....................................................................................1-12 Using Templates to Create Reusable Models ......................................................................................................1-13
Contents
Adding Function blocks to a Group ................................................................................................................3-13 Changing Relative Index Number of Controls ................................................................................................3-15 Configuring Only Hardware................................................................................................................................3-15 Configuring from the By Type Tabular Detail ................................................................................................3-16 Adding Buffer Function blocks from the Hardware Tree Directory ...............................................................3-17 Using Referencing to Interconnect Controls .......................................................................................................3-18 Understanding Referencing .............................................................................................................................3-18 Relative Reference Syntax...............................................................................................................................3-19 Box Syntax Options.........................................................................................................................................3-19 Base HID Syntax Options................................................................................................................................3-20 HID Modifier Syntax Options .........................................................................................................................3-20 Point Modifier..................................................................................................................................................3-20 Attribute...........................................................................................................................................................3-20 Entering References.........................................................................................................................................3-21 Exposing Additional Group Attributes/Parameters .............................................................................................3-23 Using Cross Referencing to Locate References ..................................................................................................3-24 Creating Custom Function Blocks.......................................................................................................................3-25 Custom Enumerations......................................................................................................................................3-27 Custom Enumerations Edit Dialog ..................................................................................................................3-28 Custom Enumerations Detail Edit Dialog........................................................................................................3-29 Custom Data Types..........................................................................................................................................3-30 Custom Data Types Edit Dialog ......................................................................................................................3-31 Custom Data Types Detail Edit Dialog ...........................................................................................................3-32 Transferring Custom Functions to Other Configurations ....................................................................................3-33 Copying Custom Functions .............................................................................................................................3-34 Creating Templates..............................................................................................................................................3-35 Validating References..........................................................................................................................................3-37 Performing Global Edits Using Find And Replace Utility ..................................................................................3-38 Performing Database Searches ............................................................................................................................3-40 Searching for Points by Tagname........................................................................................................................3-41 Searching for Duplicate Group and Tag Names..................................................................................................3-42 Repairing the Database ........................................................................................................................................3-43 Using Data Compression .....................................................................................................................................3-43
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 or 4F. Download the configuration to an individual maxDPU. Create sets of configurations representing the maxDPUs in a system. Upload and save the complete contents of an individual maxDPU. 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. This application is usually installed only in the Engineer's WorkStation. maxDPUTools is a software utility that allows you to create a configuration database in offline mode. To configure points in an online environment, use the maxVUE Graphical Configurator, a separate software product available with the maxVUE Editor software. Note: This utility was formerly named maxTOOLS4E in previous releases but has been renamed in support of configuring both maxDPU models of 4E and 4F. Some of the pictures present in this document still use the old terminology in the window captions, but are otherwise correct!
1-2
1-3
1-4
Solid-state inputs can be scanned 1000 times per second for 1 ms SOE applications
Two relay output types: 240 VAC, 130 VDC Form A relay 10 channel 240 VAC, 130 VDC Form C relay
High Level Analog Input Modules: 15 inputs per module Three input ranges: 4 to 20 mA 0 to 6 VDC 0 to 10 VDC
1-5
1-6
1-7
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. Attributes may be divided into the following categories: General Inputs All function blocks have required foundation attributes. Inputs are values that are usually obtained by referencing another attribute. Parameters are similar to inputs except it is expected that referencing other attributes is unlikely and that the local value is used. Outputs are values that are the result of the function or operation with which they are associated. These are similar to outputs except it is not expected that these are connected to inputs. 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. All attributes have the sub-attribute Quality. The behavior of function blocks may be based on the Quality of its inputs. Use the QualityForce function block to force a quality change on a value as it is passed through. 0 = good data quality 1 = doubtful data quality 2 = substitute data quality (or point in manual) 3 = bad data quality Methods direct a function block to perform a special function. Methods include commands to change mode or target value, etc. Because pure method values do not exist after the method is executed, they cannot be read back.
Parameters
Outputs
Status
Custom
Quality
Methods
1-8
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. Example: mode in the auto/manual function block may be set to 0=manual 1= auto
Float
Real or floating point data is used to represent a value in a continuum of a range of possible values. They are not restricted to whole values and may differ from other floats by very small increments. (Behind the scenes, most data is actually stored in this format. Consequently, you may occasionally see fields where integer and even Boolean values are sometimes misrepresented as floats)
String
1-9
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.
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
1-10
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
1-11
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.
Use the ServicePriority attribute to establish an execution order for groups and individual function blocks within groups. Enter a number for this attribute from 1 to 100. Within function blocks, you may want to use the ServicePriority attribute to establish the execution order for, say, inputs that should be executed before a calculation using the inputs is executed. At the group level, use this attribute to determine the execution order of multiple groups.
1-12
1-13
Chapter 2
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. Use the context pop-up menus and displays included in maxDPUTools to instance functions and configure their attributes. In addition to basic configuration creation, maxDPUTools includes utilities for: Importing libraries of preconfigured custom functions and templates. Downloading configurations to a target DPU. Validating the soft-wire referencing. Finding duplicate group and tag names. Performing database searches. Performing global search and replace. Finding points by tagname. Copying and pasting all or part of a configuration within and across configurations. Transferring locally-defined custom functions to other configurations. Refer to the next chapter 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.
Figure 2-1. maxDPUTools Main Window opened to the DPU tab view.
2-2
2-3
Figure 2-2 shows the left hand pane opened to the Hardware tab. The hardware tab consists of only the I/O related buffers organized in a three-way hierarchical tree view: Sorted by location consisting of cabinet, rack, and card hierarchy. Sorted by function type and address within type. Sorted by address only. Use this view to quickly configure only hardware or to access only the hardware content of a configuration. Use a context menu, accessible after a right-click over a tree element, to add and delete buffer types. Selecting a buffer node in the tree allows viewing its attribute tabular detail in the right hand pane. See the next section.
2-4
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.
2-5
The Template tab shows a tree view displaying template definitions by source, category, and name combined with description. The source can be local or imported from a library. Library templates cannot be modified and are displayed as locked. NOTE that templates are only a feature of DPU version 3.0 and later. Use the template feature to create reusable functionality in terms of preset attribute values for any existing intrinsic or custom function. In the example above a template for the DEVLOG has been created and a description entered to define it as having preset attributes matching a Device A. Also note the presence of the Standard library templates along with a variety of categories and templates.
2-6
2-7
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. Right-click in a row to filter grid records three ways: 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.
2-8
2-9
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, appears in the Record Select box. When you edit a record, the an arrow arrow in the Record Select box changes to a pencil.
2-10
Reordering Columns
To change the order of any column in the window: 1. Click and drag the column heading to the left or right. 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.
2-11
Canceling an Edit
To cancel an edit for the active record:
2-12
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 appears in the Record Select box, indicating it is the active record. arrow To save an edit for the active record: Click the Update + <S>. button on the Grid Navigation Toolbar, or press <Ctrl>
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.
2-13
2-14
To move or copy function blocks or function block groups between two configurations of the same version: 1. From the File menu, select Open to open a configuration, if one is not opened already. 2. Select Open again to select a second configuration. 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.
2-15
Chapter 3
Creating and Editing a Configuration
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. The following guidelines cover several configuration fundamentals: 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. 3. Complex configurations are normally organized around a hierarchical structure using Group function blocks. Before configuring function blocks and buffers, develop the outlines of a hierarchical organization. A hierarchical structure, which may be up to eight levels deep, can be cut and pasted for use in other parts of the configuration or may be copied to different configurations as appropriate. 4. Consider using Custom blocks. Use Custom blocks to create a new control with its own unique attributes. Once created, Custom blocks can be used just like intrinsic functions.
Getting Started
Use maxDPUTools to create a configuration consisting of groups, function blocks and custom blocks assigned to specific DPUs: Define a configuration with the same name as the DPU. Import any standard or custom libraries of custom blocks and templates. Edit the standard DPMS, Backup and Timesync function details present in every configuration. Create group nodes. Define the hardware. Create local custom blocks, if required. Create local templates for reusability. Define the function blocks for control and data acquisition and configure their details. Configure reference pointers to interconnect the function blocks. Run the Validate utility to insure correctness of the references. Install (download) the configuration to the DPU for testing. Perform updates as needed.
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. maxDPUTools supports multiple maxDPU versions: 4E - 2.1 through the latest version 4F - 4.0. Each version supports a maxDPUTools database master containing different features. If existing configuration databases need to be converted, see "Invoking the Conversion Utility" before attempting to open and edit them.
3-2
If this dialog appears, click OK to update the selected configuration to match the current master. Or if upgrading is desired, a later revision DPU master. Note: going backwards in DPU version is not recommended! When you click OK, maxDPUTools asks you if you want to create a backup copy of the configuration, allowing entry of the backup name and location. When you respond to this prompt, (backup is recommended) the utility begins to update the configuration. When the update is complete, a confirmation dialog appears. Click Exit to close the completion dialog and open the updated configuration for editing. Note: Selecting Cancel will disallow the opening of the configuration until an update is successfully completed.
3-3
The dialog consists of a scrollable list of existing database configuration files and four radio button choices. Configuration files appearing on the list should include .4E and .4F extensions. Click Create a New Configuration to create a new point database. To open an existing configuration, select from the following options:
3-4
3-5
Similarly once maxDPUTOOLS is open an upgrade to a configuration can be initiated as follows: 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.
3-6
Click OK to proceed with the update or Cancel to abort the update. Before proceeding with the update, maxDPUTools opens the following dialog prompting you to create a backup copy of the updated configuration:
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. After you acknowledge the backup prompt, maxDPUTools begins to process of conversion and also automatically invokes repair and database compacting utilities to reduce the size of the database and resulting memory requirements. When maxDPUTools successfully completes a conversion, the following dialog appears:
3-7
The dialog includes the DPU version identification and confirms any file type change.
2.
3-8
Should this dialog appear, click OK to access the DPU Version Selection dialog. From this dialog, select an alternative version master.
3-9
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 Click the Cancel button to halt the operation if necessary To invoke a security download for an individual DPU: 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. Review the steps as outlined in Chapter 4, "Downloading a Configuration," to complete the security download for a singular DPU.
3-10
The dialog contains a list of available maxDPU versions. Select a version and click OK. Next the file dialog appears, select or create a file folder, then enter a configuration name and click Save to complete the creation of the configuration. Next the configuration is opened for editing and the main maxDPUTools window appears and a DPU icon and the configuration name appear in the directory tree pane.
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
To add one or more groups to the configuration:
3-11
2. Select Add Group from the pop-up menu. 3. When you add a group, a pop-up appears prompting you for a group name and relative index.
4. Enter a group name, and optionally a relative index, and click Add. Continue to add groups and click the Add button each time. 5. Click Exit when you are finished to close the pop-up. Notice that each time you add a group the path name is updated in the title bar of the pop-up. New group icons also appear in the directory tree pane. Index numbers assume a particular importance when the group cannot be identified by tagname or gname. If you need to change the index number, be sure the number is unique within the group. See "Changing the Group Node Relative Index Number." 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.
Renaming a Group
To rename a group:
3-12
3-13
3. Select Add Block from the menu to access the following pop-up list of available function blocks.
3-14
3-15
3-16
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.
3-17
4. Click the drop-down arrow in the Function window to select a buffer type. 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. 6. In the Group field, assign the buffer to a HID (Hierarchical Identifier) location. Click the Browse button to the right of the Group window to select a HID from a pop-up dialog and click OK. Note that the pop-up dialog of HIDs allows the in place addition of groups to create a new HID as needed. 7. Continue to click Add to add additional function blocks to the selected group. 8. Click Exit when you are finished to close the pop-up.
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:
3-18
Base HID
[] Null
3-19
. .. ^
<wild string>
Look up reference in same function block containing the reference pointer. For example: .Out Where .Out is my out attribute. From the control containing the reference pointer, move up in a hierarchy to the parent level. For example: ..PARAM1 Make this the leading character in the reference field to cause the routing to search upward in the HID structure until a match is found between the string that follows and the group name. For example: ^PULV*./COMMON/TEMP.OUT Where Out is the attribute of the function block genetically named TEMP in the child COMMON of the first group. A string possibly containing a question mark (?) character or an asterisk (*) character; use the question mark to match any one character. Use the asterisk to match remaining characters. For example, from the previous example: ^PULV*./COMMON/TEMP.OUT ^PULV*./contains an asterisk as a wild card character; this causes the routing to search upward in the HID structure looking for group name matches beginning with PULV.
<utag>. a unique tag (Tagname) assigned to a DPMS object /<l1>[/<l2>[/<ln>]] A HID location. .
A HID location.
null
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 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.
<generic>
Null
Attribute
3-20
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." Use auto editing to quickly access pop-up displays listing information to include in a reference. You may look up the names of other DPUs to reference attributes in other configurations. You may also look up the names of controls by tag names, and by relative index numbers. Controls organized in the same group are referred to as siblings that may be referenced by their respective index numbers. Once you select a control from a pop-up list by tag name or index number, a second pop-up appears listing eligible attributes associated with the selected control. When you select reference information from a pop-up list, maxDPUTools automatically enters your choice in the reference field using the appropriate reference syntax as described in the previous section. To enter a reference using auto editing: In the tabular detail grid, click on a reference field to access an Ellipsis button. Click on the Ellipsis button (or use the F4 key) to access the following pop-up:
3-21
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. Select External to reference a control in another configuration. Once a control is selected, select Attribute to select from a list of eligible attributes for that control. 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.
3-22
3-23
When you select a control and open the utility, a log appears listing all the controls that reference the selected control.
3-24
3-25
3. Enter the unique name of the control, add a Category and an optional Description and click OK. 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. Create a name for the attribute under the Attribute column. Select a category for the attribute in the Category column (Input, Output, Parameter). Select a Data Type under the Data Type column. Choose from the following: Boolean Complex Enumerated Float Long Relative time
3-26
Custom Enumerations
For custom function attributes assigned the ENUM data type, value /text pairs must be defined. These enumerations are then visible as values and dropdown selections for the associated attributes when configuring an instance the custom function. They will also be downloaded to the maxDPU, making them accessible to the browser for similar display and selection, and can likewise be uploaded from the maxDPU. The creation / editing of custom enumerations is initiated via a right click within the Data Type field of the attribute definition grid. This will Note that the record must have been previously saved and not have any edits outstanding. A single entry context menu will appear as follows, which when selected will launch the new enumerations editor dialog.
3-27
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.
3-28
3-29
3-30
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.
3-31
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). The # elements has a range of 2 16.
3-32
3-33
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. 3. Click the Destinations button to select target configurations. Selected destinations will appear in the choice list. Notice that, by default, the configuration you already have open appears in the destination choice list on the right. Click the Reset button to clear the list. 4. When you select a source configuration, a list of named custom Functions associated with that configuration appears in a list box on the left under Select a Source Configuration and Functions. Each Function is listed next to a checkbox. By default, all the Functions are selected. To clear the checkboxes, click Clear and select specific Functions. 5. Click the Transfer button to transfer all the selected Functions to the target configurations. 6. Click Exit to close the utility when you are finished.
3-34
The added or updated block becomes part of the maxDPU configuration, which is independent of the library source copy. Individual configurations are not updated when the library is updated. To apply updates, use the above procedure followed by a download.
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. Various context menu operations are initiated via right-click selection of a node in the tree hierarchy for creating and maintaining templates. These include adding a template, renaming the category or description for a template, deleting a template, renaming a category, deleting a category, importing from libraries, importing from another configuration, copying a template, and pasting a template. To create a template function: 1. Open maxDPUTools, create a configuration, and click the Template Tab in the left view pane. 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:
3-35
3. Select a function from either the Alphabetical or Categorized listings. The Category and Description fields will then default to match the selection. Now, optionally modify the category, and be sure to modify the description to uniquely identify the purpose of this template, and click Add. Another template may then be added, or when done click Exit. 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.
3-36
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. To check input references: 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.
3-37
3-38
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. 5. In the field labeled Position, specify which substring position to search. Click the down arrow to select prefix, suffix, exact, or use the default position, any. 6. In the field labeled Find, enter a substring you want the search tool to find. 7. In the field labeled Replace, enter the replacement substring. 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.
3-39
2. The dialog contains search filters allowing you to request progressively more specific information. In the Service window, use the drop-down arrow to select the name of a specific control. By default, <All> appears in the window, directing the search utility to search all available controls. 3. In the Attribute Match window, enter the name of an attribute, such as in1 (input 1) or enter a wildcard pattern, such as in*. In this example, the search utility will search all controls having any attribute names beginning with in. 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" values matching the entered string. To enter a different search criterion, click the drop-down arrow button next to the default (like) to select greater than (>), less than (<), and not equal to (<>). String comparisons are performed using ASCII values (example: abc is less than bcd). 5. In the Ref Match window, enter a reference string or a wildcard pattern. 6. Click Start to accept the inputs and begin the search. 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
3-40
3-41
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. 3. When the search is complete, maxDPUTools locates the point containing the searched tag name in the tree directory and opens its tabular detail in the grid view pane.
3-42
3-43
3-44
Chapter 4
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 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.
Click OK to ignore the mismatch and proceed anyway. 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 vise 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. Because the download is directed to a running DPU, the areas labeled Primary and Secondary contain information about the primary and secondary DPUs. If the target DPU is not part of a backup pair, the dialog shows only information for a single DPU. The dialog automatically obtains the information through Software Backplane subscription. Note also that the Freeze and Download buttons for each DPU are available. 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."
4-2
Downloading a Configuration
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. In Standalone mode, there is no automatic failover. To force a failover, click the Takeover button on the inactive DPU or issue on OpTakeOver command. The OpTakeOver command can be issued from maxDPUTools (take button), Point Browser, or a button added to a maxVUE display. Once the takeover is initiated, all outputs will be in the frozen state. The database in the previously active DPU will remain unchanged, including any new operator actions. If the original DPU is then forced to be active, it will contain the database it had at the time it became inactive except the outputs will now be frozen. The State LED is green on the active DPU and yellow on the inactive DPU.
4-3
4-4
Downloading a Configuration
4-5
4-6
Downloading a Configuration
the dialog displays a description of the backup DPU. If the download proceeds without errors, maxDPUTools informs you that the update succeeded. Click OK.
4-7
Chapter 5
Using Import/Export Utilities
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. Remember, many of these basic editing functions, such as moving and copying points within and between configurations, and making global changes to values and references can also done using other features built into maxDPUTools. As noted in Chapter 2, groups and individual points may be moved, copied, and pasted from the tree directory pane. Global changes to values and references can be done using the Find and Replace utility. See "Performing Global Edits Using the Find and Replace Utility," in Chapter 3.
5-2
Note that the keyword Service denotes the start of an addition followed by one or more attributes. Continuation lines are denoted by the absence of the leading Service keyword, i.e., continues until a new addition is encountered or the end of file is reached. Attributes can be in any order. Leading and trailing white space (tabs, blanks) are ignored. To insert comments, use the apostrophe character as the leading character. 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) Value vs. data type is validated. (warning) Implicit data type conversion will apply for numeric if needed. String lengths are truncated to their maximum length. (warning) Value ranges are checked. (warning)
5-3
Or include comments using a leading (beginning of line or immediately following a <tab>) apostrophe character: This is a comment line More comments Service=ATAG<tab>More comments Comment Parent=/u2/bms/l3 Comment Gname=G1 Comment Limhi=100.1 <tab>More comments
5-4
5-5
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.
5-6
5-7
If you click File, the following Export to File dialog box appears:
5-8
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 to be exported. To edit the Destination field to select a different destination, click the Ellipsis button.
5-9
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.
5-10
Chapter 6
Using Differences Utility
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. Use the maxDPUTools Differences Utility to compare the content of a selected configuration against either another configuration or a snapshot sampling of values from a running maxDPU to discover additions, deletions, and attribute changes between them. The configuration selected in the maxDPUTools editor is known as the master, while the configuration or maxDPU selected for comparison is known as the replica. For a meaningful and accurate comparison, a master and replica should be variants of each another and share a common configuration ancestry.
To execute the Differences feature, open a configuration in maxDPUTools, and in the tree directory of the editor (left view pane) select a level within the hierarchy at which to start. Start at the top level for a full hierarchical
Differences Types
Reported differences may consist of: Attribute modifications Graphical Configurator drawing modifications and attribute changes
Attribute modifications can represent either a value or reference difference. Text appearing in the tree hierarchy reports the new value vs. the old. The Differences utility also detects changes in a Graphical Configurator drawing resulting from an online editing session. Text appearing in the tree hierarchy reports whether drawing objects were moved, or whether connecting lines between drawing objects (wire connections) were edited. If drawing objects were moved, changes in X and Y coordinates are reported. If connecting lines are edited for clarity to include additional 90 degree turns (reference turns) or if a turn is moved some distance, text appears in the tree hierarchy reporting changes to reference turns Click on a selected node or optional attribute to view an associated tabular detail in the right view pane. This detail allows you to review its configuration information as a whole in addition to the item that changed.
6-2
Merging includes the adding or deleting of function instances, or the updating of attribute values as appropriate to the type of difference. Hiding provides a way of selectively discarding differences either for exclusion in a hierarchical merging or for the de-cluttering of the display for differences to be ignored. 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. Large comparisons will also tax the workstations resources, specifically CPU and memory usage and disk access. A high performance workstation is recommended as the minimum platform to achieve reasonable performance. The selection of hierarchical filtering is recommended when applicable to facilitate improved performance by simply reducing the scope of the overall comparison operation.
6-3
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. When comparing a configuration vs. a maxDPU, both are required to be at the same release version levels. Otherwise the comparison will not proceed.
6-4
The dialog consists of a single scrolling list of all possible maxDPUs available for comparison. The list content is dynamically determined from the entries in the standard DPUlist.ini file. The list contains the DPU names in sorted order. Note: DPU pairs are combined since by default the Differences utility always compares a configuration against the active DPU. Use the up/down arrow keys to select an entry from the list and click OK or double-click on an entry. 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. Alternatively, if an entry is not listed or you need to compare an inactive DPU, click the Enter button to invoke the following entry dialog:
6-5
Note that brackets are required to distinguish an address entry. The ! prefix can also be included for explicit addressing when DPU pairs are present and either the Primary or Secondary DPU, regardless of which is active, is desired. Note: if the maxDPU is inaccessible or the release versions are mismatched, one of the following error dialogs may appear:
In both error cases, the differences cannot proceed. Click OK to close the dialog and return to the main editor display view.
6-6
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. Note: if you should select the same configuration as the master, maxDPUTools silently cancels the Differences utility. Additionally, if a version mismatch exists between the master and selected replica, the following error dialog appears:
Click OK to close the error dialog and return to the main editor display view.
6-7
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 reexecution 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. Click the Selective Comparison button on the smaller dialog to choose specific functions and attributes to include in the comparison and exclude others. Select Cancel (or <Esc>) to close the differences dialog and return to the main editor display view.
6-8
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.
6-9
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. Should you click this button, the following dialog appears:
6-10
When Differences processing is completed and no differences are discovered, the following dialog appears:
6-11
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. Merge, delete or add differences Hide differences Print differences
6-12
Alternatively, as shown in the figure, you may select the G2, or G1, or top level DPU for merging or hiding of a hierarchy. Additionally, a singular attribute may be selected for deleting or adding a difference. See the following sections.
6-13
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. Note: a hierarchical merge that contains such instances automatically performs the additions as described in the previous section. However, when you select a singular instance as described here, the menu entry explicitly describes the action that will be taken. To add a difference in a singular node: Click on a node instance as shown in the following example, which contains the text, Exist Only in the replica. 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
6-14 Metso Automation 278597
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
6-15
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.
6-16
The dialog contains a list of differences found in the selected hierarchy. 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:
6-17
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. Important: It should be noted that the custom function differences appear at the top to provide an inferred preference to having them reviewed first, before any differences within the DPU instances. In fact attempting to add or hierarchically merge an instance of a new custom function prior to adding its definition is explicitly prevented, and results in the following example error dialog:
6-18
6-19