278622 Rev. A
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
PREFACE ............................................................................................................................III
How This Book Is Organized ..............................................................................................................................iii Other History and Reporting Capabilities ...........................................................................................................iii
Contents
Editing Data for a Selected Point.........................................................................................................................4-17 Using Edit Dialog Control Buttons..................................................................................................................4-19 Using the Edit Search Time Feature ................................................................................................................4-20 Inserting a New Sample...................................................................................................................................4-20 Editing a Sample Value ...................................................................................................................................4-22 Editing a Sample Time ....................................................................................................................................4-22 Retrieving Data Using MxsViewMount..............................................................................................................4-24 Adding Trending Points Online...........................................................................................................................4-25 Adding Points to a Template ...........................................................................................................................4-25
APPENDIX A ....................................................................................................................A-1
Registered Services and Command Line Parameters ............................................................................................A-1 Overview of _MXS members...........................................................................................................................A-1 Template and Point Members ...........................................................................................................................A-3
APPENDIX B ....................................................................................................................B-1
Using SRCheck to Correct Storage Room Errors ................................................................................................... B-1 Overview .................................................................................................................................................................. B-1 The SRCheck Window and its Options .................................................................................................................... B-2 Running SRCheck to repair and compress ............................................................................................................ B-3
APPENDIX C ....................................................................................................................C-1
Wave Generator..........................................................................................................................................................C-1
Preface
The maxSTORIAN historic trending package is designed to collect and store trend data for extended historic periods. The product may be used with DBM-based and maxDPU4E-based maxDNA systems. In systems that use DBMs, maxSTORIAN can replace the DBM-based historic trending features, and is capable of collecting longer-term storage using a delta-save style storage and compression algorithm. Additionally, the maxSTORIAN package allows third-party vendors to easily create an interface with the maxDNA system, allowing the system to feed information into another historian package.
iv
Chapter 1
Introduction
Overview
The maxSTORIAN historic trending package is designed to collect and store trend data for extended historic periods. The product may be used with DBM-based and maxDPU4E/4F based maxDNA systems. In systems that use DBMs, maxSTORIAN complements the DBM-based historic trending features. For either DBM or maxDPU4E-based systems, maxSTORIAN can collect higher quantities of points using a delta-save style storage and compression algorithm. Using this approach, much more data may be retained and accessible online since not all values are saved. Instead a delta from the last time the value changed is saved.
Backup Stations
Any maxSTORIAN instance can be executed on a single, standalone maxSTATION, or on two maxSTATIONs designated as a backup pair. One station is set up as primary, and the other as secondary. When maxSTORIAN is started, it must be configured for operation as one of these three possibilities.
Setting up maxSTORIAN
To make maxSTORIAN operational: Using the Workstation Startup Configuration Tool, enable maxSTORIAN to run as a service and select its role as stand-alone, primary or secondary. For a backup pair, the associated backup station must also be declared by name. A maxSTORIAN password must also be defined to enable access to views and maintenance features from other maxSTATIONs. The same password must be defined on all maxSTATIONs that you wish to allow this access. Create and install configuration files consisting of templates and associated points. See Using the Configuration Editor in a subsequent chapter. Configure the maxVUE maxSTORIAN Status display to set the service name. See the maxSTORIAN Status Displays. Refer to chapter 2 for further details.
maxSTORIAN Components
maxSTORIAN consists of the following components:
maxSTORIAN
maxSTORIAN, the main executable for the maxSTORIAN Package, is located in the folder c:\mcs\history. maxSTORIAN performs history collection and provides for history retrieval for clients such as trend displays and history reports. Note that as of release 4, maxSTORIAN is typically configured to run continuously as a service, started when the operating system boots in a separate EngineerService user account with appropriate privileges granted.
MxsReplica
MxsReplica, the executable for backup maxSTORIAN operation, is located in c:\mcs\history\. MxsReplica transfers collected history data from the active member of a backup pair to the inactive member of a backup pair. Replica can also be used to transfer history data to tertiary storage and to export data. Replica is automatically started by the active maxSTORIAN of a backup pair. See Defining Backup Transfer and Using Replica Window. NOTE that, as of the Release 3 version of maxSTORIAN, the computer used for tertiary storage must be running Windows, just as the maxSTATION does.
Configuration Editor
The Configuration Editor is used to interactively configure the point and attribute identification of data to be collected by the maxSTORIAN instance. See Using Configuration Editor.
Wave Generator
1-2
Introduction
Wave Generator, also known as Pointsim or Point Simulator, is a utility tool used to create local status variables that will oscillate over a selected wave pattern. See Starting up the Wave Generator.
MxsStorageRoom
The MxsStorageRoom, consisting of saved delta storage data files, is located directly under the c: root directory, but can also be located on another logical drive, such as D:\. MxsStorageRoom is created automatically when the maxSTORIAN package is installed. Specifically, it is created when the MxsSimpleStorage2K.dll or MxsSimpleStorage.dll is registered, so if for some reason your MxsStorageRoom folders become deleted, register the dll to recreate it again (the 2K one should always be used with Release 3 or later). Additionally, a subfolder, named Configurations, maxSTORIAN is installed. This folder contains the file is created automatically by maxSTORIAN to contain configuration, including any modifications made online. then use this configuration on subsequent restarts. is created when LastConfig.csv that the latest installed maxSTORIAN will
Beginning with Release 3.0, the Storage Room uses the Sparse Files feature available only in Windows 2000 and later.
SRCheck
SRCheck (Storage Room Check) performs three operations on the MxsStorageRoom: 1) Detects and corrects any errors in the files that make up the Storage Room; 2) packs files so that they can be copied and so that they occupy less space; 3) Converts a Storage Room from maxSTATION Release 2 compatibility to Release 3 and later compatibility.
Supported Statistics
The following statistics may be retrieved from maxSTORIAN: SAMPLE AVERAGE MINIMUM ( MIN ) The value at the end of the interval. The average of the samples during the interval. The minimum value sampled during the interval
1-3
OFFCOUNT
TOTCOUNT
maxSTORIAN also supports two special members: LAST VALUE Reports the last value written to the core file. Reports the most-recent value received in an update message.
1-4
Introduction
2. Click the Machine Settings tab, expand the folder in the left directory window and click the following file: Default Trend Source 3. When you click on this file name, a field appears on the right containing the current setting, which is empty. To change the setting, type _mxs_trend (or the name of your maxSTORIAN instance) over the current entry and click Apply and OK. In the case where the majority of your applications need to use DBM history data for their source of trend data, leave the Registry entry Default Trend Source set to empty.
1-5
1-6
Chapter 2
maxSTORIAN Installation and Setup
Getting Started
To set up and run maxSTORIAN, perform the following steps in the order listed here: Use the Workstation Startup Configuration Tool to enable maxSTORIAN and select it backup role options. Optionally define the backup transfer options. Optionally relocate the StorageRoom to a drive other than C:. Reboot the maxSTATION to start the maxSTORIAN running as a service under the ownership of the EngineerService account. Use the Configuration Editor (mxsConfig) for creating a configuration and downloading it to maxSTORIAN. See Using the Configuration Editor. Bring up the maxSTORIAN Control Panel to add, delete, search, browse, and access information about online point databases. See Chapter 4. maxSTORIAN Online Operation.
Check the boxes for Enable and Run As Service. Next select its role as standalone, primary or secondary in the adjacent combo box. Next enter the service name to be assigned to the maxSTORIAN within the SBP name space (_MXS for example as shown). For a backup pair, the associated other station must also be declared by name (myother as shown). Next enter the upload startup speed in pts/sec (see subsequent section on maxSTORIAN tuning for details). Note that one line down a password is to be defined. This password entry is required on the maxSTATION(s) running maxSTORIAN. It is optional on any other maxSTATIONs to enable access to views and maintenance features via the maxSTORIAN Control Panel view. This entry is needed on both the stations running maxSTORIAN as well as on the other stations involved, and all entries must match! Also note that to make any changes effective the maxSTATION must be rebooted as the station must cycle through startup to use the changes!
2-2
2-3
Sec Level
Compression Storage
Manual
Temporary
Priority
2-4
2. The configuration grid display consists of two tabs, Templates and Points. Click the Templates tab to define templates and their characteristics. See Defining Template Parameters. Once you define your templates, click the Points tab to create point names, attributes, and assign them to a desired template.
2-5
If you are creating a new configuration, the, configuration editor produces a blank point grid. If you are opening an existing configuration, grid views appear containing the last entered values. 3. To import a maxTOOLS trend database, select Import from the File menu. See Importing a maxTOOLS Trend Database. To import tag names from maxDPUTOOLS, select Quick Import from the File menu. See Importing Tag Names from maxDPUTOOLS. to 4. After loading an existing point database, click the Upload button incorporate any points added from the most current online version of the configuration. Because multiple instances of maxSTORIAN may be running, when you click the Upload button, a dialog box prompts you for the service name of the maxSTORIAN instance you wish to target. Enter the name and click Upload. Note: if the name is already registered in this station (with_lss.default_STORIAN), the dialog box is already preloaded with the name; you dont have to reenter the name in this case. Only enter a name if you wish to change it. 5. Select Validate from the File menu to check the validity of point names and associated attributes, referencing one or more configurations. See Validate Point Name Assignments.
2-6
2. Click the Select button to select one or more configurations to reference from a Windows style file directory dialog box. 3. When you make your selections, click Start from the Validate Point Assignments dialog.
2-7
2-8
2. 2. Click the Select a Configuration button to select a configuration from a Windows directory and click Open. 3. Assign database trend points to one of three template types, organized by 1 second, 5 second, and 30 second sampling rates. Note: when the import utility determines that no trend points sampled at 1, 5, or 30 seconds are found, the respective template assignment windows are not available.
To import Atag and Dtag related point names and Out attributes: 1. Select Quick Import from the File menu to open the DPU4E to maxSTORIAN Quick Assignment Import dialog.
2-9
2-10
To perform a Selective Import, do the following: 1. Select Selective Import from the File menu to open the maxDPUTOOLS to maxSTORIAN Selective Import dialog. If no Reference Configuration has been previously selected, you will be prompted for one. After you have made your selection, the Select Attributes by Function window will show all of the types of blocks, presented as a tree list, which can support a tagname. 2. Next, expand each of the block types. You will be shown a list of attributes that each block type supports. You may select among Output and/or Status Category attributes, or you may select All attributes. You can select each of the attributes that you want to include by clicking on an attribute name and then pushing the keyboard spacebar to turn on the checkbox next to each name. If you check Selected Only, you will see only those attributes that you have selected for import. If you push Clear Selections, then all of the attributes will be deselected. 3. Select a Template into which the resulting point.attribute names will be loaded. A pulldown allows you to select any template that has been defined in your maxSTORIAN configuration.
2-11
Pressing the Import button will complete the operation. Note that, if you have points with the same point type, but with different tagnames or attributes, that you wish to import into a different template, you can perform the import again with a different template name. When the Import List Confirmation Preview comes up, you can deselect the points that you just imported into the original Template, and import the rest into the newly selected Template.
2-12
Use data compression to reduce the size of a maxSTORIAN database and improve retrieval performance. To implement data compression: 1. Open the Configuration Editor and load a configuration. 2. Select Compact Database from the File menu. 3. When you select Compact Database, the editor begins to compact the selected configuration. When the editor finishes, a prompt informs you that compacting is completed. Click OK.
2-13
2-14
2. Release the mouse button after you move the column to its new, desired location. Note: in the following figure, 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. This is true for all grid views. For example, the Name 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-15
Canceling an Edit
To cancel an edit for the active record: on the Grid Navigation Toolbar, or press the Click the Cancel button <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 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.
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 delete, an arrow should appear in its Record Select box, indicating it is the active record.
2-16
Soundex
2-17
2-18
Second, Windows Explorers properties of MxsStorageRoom will, after one or more Trims has occurred, show that the file or folder size is much larger than size on disk; in fact, the folder size may appear to be larger than the logical drive. After SRCheck has been run, the size will be equal to size on disk, and it is OK to copy.
2-19
To configure and use these displays: Copy the status displays and associated bitmaps (Yieldclickbutton.bmp, blankclickbutton.bmp, ResumePriClickButton.bmp, ResumeSecClickButton.bmp, and clickbutton.bmp) to c:\Custom\Displays\Operating\SystemStatus. You may need to create this folder if you have not modified any other standard displays located in the SystemStatus folder. You must edit the Status display first before it can be used in your system. Open maxStorianStatus.mn in the maxVUE Editor. Now right-click anywhere in the main display area, to get the popup containing the option for Group. Expand the Group menu, and select the option to Edit Group Parameters. In the first block labeled Param1, enter the exact name of your maxSTORIAN instance (example: _mxsU1). In the second block, Param2, enter the name of the maxSTATION that is running the primary or standalone maxSTORIAN (example: U1HIST1). In the third block, enter the name of the maxSTATION that is running the secondary maxSTORIAN (example: U1HIST2). After you save this display, it is ready for use by maxVUE Runtime. There is a button on the System Menu display that will allow you to swap to this display or you can add a button in your existing display hierarchy that will call up this display (SystemStatus\MaxStorianStatus.mn). While this display is active in Runtime, there are three options that you can edit, but they can be edited only when you are logged in at security level 9. You can edit the Trim Percentage, the Warning Percentage, and the Clean Percentage. Another feature that is available if you are logged in at security level 9 is the ability to failover from the currently scanning maxSTORIAN to the hot stand-by maxSTORIAN. You may click the Yield to Remote button to request the failover. You may then command the pair member that is stopped to resume by clicking the Resume Primary or Resume Secondary button as appropriate.
Metso Automation 278622
2-20
From the maxSTORIAN Status display, you can call up the maxSTORIAN Control Panel, to view more status, view stored data, etc. (see Chapter 4). You can also call up the View Mount Control in order to mount a data source to view history stored on CD (for example).
2-21
Chapter 3
maxSTORIAN Performance Considerations
Overview
maxSTORIAN includes built in performance monitoring capabilities and also includes tuning parameters that allow you to enhance performance or tailor maxSTORIAN to take better advantage of the performance capabilities of the specific hardware platform on which the application is running. Refer to this chapter for discussions of maxSTORIAN self monitoring and tuning capabilities.
This alarm is posted when maxSTORIAN cannot access one or more points it was asked to collect. This may be a result of a device failure or a communications problem. The alarm will remain on the Alarm Summary and Alarm List until all points can be collected. The presence of this alarm is not an indicator for load shedding, only that one or more points cannot be accessed.
(maxSTORIAN name)_BADPOINTS
This alarm is posted when maxSTORIAN has found that it cannot keep up with the updates being fed to it for all of the points to which it is subscribed.
Metso Automation 278622
3-2
maxSTORIAN Tuning
Under certain conditions, you may need to tune key maxSTORIAN parameters described here to improve performance. These consists of configured point delta, upload speed, and configured Replica bandwidth. Tuning may be called for especially when maxSTORIAN has to deal with a large configuration. It is difficult to establish an ironclad rule to find correct values for them, because they depend on the hardware used as well as the software configuration. It is important, therefore, to understand the meaning of the tuning parameters and the effect of changing their values.
3-3
3-4
Chapter 4
maxSTORIAN Online Operation
Overview
This chapter describes how to operate maxSTORIAN online. maxSTORIAN online operation consists of graphical interface displays:
maxSTORIAN status display Points display Panel Used to view configuration statistics, perform tuning and yield backup operation. Used to add and delete points online, search for point names, display point information, and browse data for a selected point, import and export points, edit selected point data, etc.
4-2
The number of deltas (changes) maxSTORIAN is currently receiving and processing into storage per second. The current status of this maxSTORIAN instance and its backup partner. The possible states that this instance could be in are usually divided into these parts, unless maxSTORIAN is not yet started. The possible states are: maxSTORIAN was started, but has not received the command stating what its role is (standalone, primary, or secondary). This information comes from the appropriate text file. See Chapter 2, Creating Text Files Using Mini Configurator. maxSTORIAN now knows what role it has been assigned.
NOT_CONFIGURED
This maxSTORIAN is now collecting and storing data. This maxSTORIAN is now idle it is inactive, but ready to take over if there is a failure of its backup pair member. This maxSTORIAN was issued a stop command it can be reactivated only with a start command. This maxSTORIAN is now transferring history to the inactive device of the backup pair, but has not yet made a complete transfer of all data. If a failover occurred, the newly active device would not have complete history. This maxSTORIAN has now transferred all of its history to the inactive device. If a failover occurred, the newly active device would have complete history (except for the short outage from the time that the active device failed until the newly active device started) and collected all first samples of all points again. In Release 3, getting from WARMING to HOT will happen much faster, in general, because the backup storage room is updated only as necessary. The other maxSTORIAN of the backup pair is not answering the local devices request for status. The other maxSTATION may be on the network and its MxsStorageRoom folder may be accessible, but
or HOT
UNKNOWN
4-3
4-4
The Control Panel contains large function buttons to the left of the list and radio buttons and checkboxes beneath the list. The following sections explain their use.
Selecting Checkboxes
Click the Status not SBP_OK checkbox to limit the view to only those points which are not currently being collected due to a Software Backplane error.
4-5
Click the Add button on the maxSTORIAN Control Panel to download additional configured points. First, pick a template to which you wish to add a point. When you click this button, the following dialog appears. Enter a point.attribute and click OK:
A point name and attribute must be entered. The point will be collected with the parameters assigned to the selected template. This function requires that the current login security level is greater than or equal to the security level assigned to the selected template.
The maxSTORIAN Control Panel includes a point search capability. To locate a point from the list in the right pane of the window: 1. Click the Find button on the control panel to access a dialog box.
4-6
Use the Delete button to delete the selected point from the currently configured and collected points within the maxSTORIAN. Note: this button is not available until a point is selected. To delete a point: 1. Select a point appearing on the maxSTORIAN Control Panel List and click the Delete button. 2. A prompt asks you if you are sure you wish to delete the selected point. Click OK or cancel. This function requires that the current login security level is greater than or equal to the security level assigned to the template of which this point is a member.
Use the Stop button on the maxSTORIAN Control Panel to stop the collection of a selected point. Note: this button is not available until a point is selected. To stop point collection: Select a point appearing on the control panel list and click the Stop button. Any point that is paused will remain so until it is resumed with the Go button. See Resuming the Collection of a Point.
4-7
Use the Go button on the maxSTORIAN Control Panel to resume collection of the currently selected point previously paused or stopped. Note: this button is not available until a point is selected. Use this button in conjunction with the Stop button. See Stopping the Collection of a Point. This function requires that the current login security level is greater than or equal to the security level assigned to the template of which this point is a member.
This feature allows you to remove, by date, a portion of maxSTORIAN history to free up more space for newer data just coming into maxSTORIAN. Use this feature in conjunction with the Control Panel Export feature. First Export the oldest data to archive it offline on CD or other such media. Click the Trim button to free the space of the data just exported. When you click the Trim button, the following dialog box appears:
4-8
The date and time that you enter tell maxSTORIAN the date and time of the oldest data to be retained. Any data older than the entered date and time will be deleted. If points have been added whose oldest-stored date and time are newer than the selected date and time, the storage for those points will be unaffected. If a point was selected when the trim button was clicked, checking the Trim only selected point box causes ONLY the selected points data to be trimmed. This is useful if you know that a handful of points account for a large portion of the total storage being consumed.
4-9
This message remains until maxSTORIAN trims history to below 90%. To change the percentage use the role text file that maxSTORIAN is using to write to _MXS.CLEAN_PERCENTAGE (dont forget to use the correct maxSTORIAN name.) See Chapter 2, Creating Text Files Using Mini Configurator. When the second threshold (the trim threshold) is reached, maxSTORIAN records the date and time of the oldest sample in the StorageRoom, then calculates the total time span between then and the present. From this, the trim function multiplies the total span by a percentage, the _MXS.TRIM.PERCENTAGE, to determine the oldest date and time for data to be retained. Then maxSTORIAN searches each points data, and discards any storage blocks with dates and times older than the oldest date and time to be retained. For example, suppose that 50 days worth of data was stored, and the maxSTORIAN_TRIM alarm is posted. All data older than 45 days will be discarded. If any points have been stored for fewer than 45 days, then those points will not be trimmed automatically. As mentioned previously under the trim function, if some points are responsible for most of the storage used, those points can be trimmed manually. The default trim percent for the automatic trim is 10 percent but can be changed by writing to the ULONG variable _MXS.TRIM_PERCENTAGE using the correct maxSTORIAN name.
Use this feature to select maxSTORIAN data (spanning a time period) to be copied out of maxSTORIAN to another folder, either local to this station or
4-10
to another station through Windows Explorer Network Neighborhood. This copy can then be saved offline to backup elsewhere. Click the Change Mount button to choose the destination folder that can be either local or shared over the network. Only one export instance is allowed at one time. To export selected data: 1. Click Export to access the following dialog.
2. Under Start Time, click the date and time for the start of the data to be exported. 3. Under End Time click the date and time for the end of the data to be exported. 4. Optionally, a filter file (an ASCII text file) can be used. Check the Use filter files checkbox to export only the point names which appear in the filter file.
5. Under Export speed, select the disk bandwidth assigned to that transfer. If your maxSTORIAN station is a fast machine, you can select normal or fast to speed up the transfer process. 6. Click Change Mount to select the destination folder of the export. In the designated folder, a new folder, MxsStorageRoom, will be created. That folder will have the aisle folders created within it which contain the actual data. If a points data were contained only in the MxsCore file in
4-11
Use this feature to import point data into maxSTORIAN. Click the Import button to access the following dialog.
Click the Start Restore button to restore previously exported data to the current online storage room. Click Change source to choose the source folder that can be either local or shared over the network. The imported storage must be in the folder MxsStorageRoom, with standard aisle_nnnnn\ folders, which is contained within the designated source folder (in the example, the source folder is C:\MCS\History).
Use the cleanup feature to delete unused files (those of points that have been deleted) contained in the storage room. Deleting a point from the configuration doesnt automatically delete all of the points data from the storage room. maxSTORIAN saves, in the aisle file, the most-recent data that was in the core file, before the point is removed
4-12
from the current configuration. This allows you to add the point again to the configuration without losing possible valuable data. If a point is deleted and then added again to a configuration, no point history will be available for the period in which the point wasnt in the configuration, but all the previous collected data will be again available. When you are sure that everything you need is in the current configuration, the storage room can be freed of all the unused files. Click the Cleanup Button. The following dialog box appears:
Click on the Proceed button to start the clean up process; maxSTORIAN will examine the storage room, deleting all the files belonging to points which are not in the current configuration. Checking the prompt box will cause maxSTORIAN to present a confirmation dialog every time a file should be deleted allowing you to do a partial clean up.
Use the Info feature to display information about a selected configured point. To view information for a selected point: Select a point on the maxSTORIAN Control Panel list and click the Info Button. The following dialog box appears:
4-13
Temporary:
4-14
Use the maxSTORIAN Control Panel browse feature to view data collected for a selected point. Data consist of a point value, the date and time it was stored, associated quality, and other useful information. To view data for a selected point: Select one of the points on the maxSTORIAN Control Panel and click the Browse button to open the maxSTORIAN Browse Dialog Box. The dialog presents point data in a scrollable report format. The dialog includes paging buttons, (see Using Browse Dialog Paging Buttons), and a point search feature (see Using the Browse Search Time Feature.)
4-15
4-16
Browse Core
This engineering feature permits the experienced user to browse the core data. Click Browse Core to view core data, the block # displays. Click Back to File to return to normal viewing of this point.
Use the Edit function to view and edit data collected for a selected point. You may edit a point's value, data type, or time/date, or add samples to a point's history data. To edit a point, select a desired point from the maxSTORIAN Statistics display, and click the Edit button on the control panel to access the following dialog:
4-17
The dialog presents you with statistical values for the selected point in addition to other data. When you select Edit, you are shown the most recent data. Fields showing the name of the selected point being displayed and the current block number appear in the upper part of the dialog. Command buttons also appear in this area allowing you to navigate through the list, perform searches, insert new lines and commit to any changes. See Using Edit Dialog Control Buttons for a detailed description of button functions. The list consists of the following fields:
Time: Value: Quality: Type: Data on Disk: Offset Begin: The date and time that a value was stored in the historian for this point The value that was stored at a given time in the historian for this point. The quality associated with the value stored at a given time in the historian for this point. The data type of the value stored in the historian for a given point. The actual hex dump value stored in the historian for a given point. This is used mainly for debug purposes. The actual starting offset for this particular value stored in the historian for a given point. This is used mainly for debug
4-18
Reload file Click the Reload File button to reload the file for editing. You will receive a warning that ALL the uncommitted changes (your edits) will be lost. Insert line Click the Insert Line button to add a line after the selected line.
4-19
4-20
4-21
4-22
When a point time or value is modified its associated Quality field is set to SUBS (substitute). The edit control doesn't allow you change the quality to a value different from SUBS. The fields "Data On Disk, "Offset Begin, "Offset End" are read only. These are the allowed data types that you may enter:
VAR_EMPTY VAR_BYTE VAR_UBYTE VAR_SHORT VAR_USHORT VAR_LONG VAR_ULONG VAR_FLOAT VAR_DOUBLE
Depending on the data type, the program performs checks on the input value range. The value NO_DATA can be assigned to any type. The type VAR_EMPTY MUST have NO_DATA as value.
4-23
When the control starts, it shows the main mount point and the alternate one if specified. For both mount locations, there is a column with the retrieval service associated with it. To add a new mount service: 1. Click New mount point to open the following dialog:
4-24
2. Specify the mount point and the name of the associated service. The mount point must be a named share that is associated with a particular named computer on the network. The mount point must be the parent of the MxsStorageRoom that is to be mounted. In the example, the computer validat3 has its Z: drive (the CD-ROM drive) shared, with the share name CDR. The CD that is in that drive has a folder called validat3, which has a subfolder, the MxsStorageRoom folder. The service name in the example was chosen so as not to conflict with any other Software Backplane exported name. The mount point may be the CD of the computer where maxSTORIAN is running as long as the drive is shared are referred to as in the example above. When a mount is selected, click the Edit or Delete buttons to edit or delete it, respectively.
4-25
Use the Data Identifier for Pen field to add or change a pen. Normally, the syntax is:
Tagname.attribute.statistic
example: fic101.pv.sample When a point is to be added, the complete syntax is: (name of maxSTORIAN)_TREND.<temporary template name.extension>:tagname.attribute.statistic example:
where
_MXSU1_TREND.TEMPLATE.8:fic101.pv.sample
_MXSU1 is the name of the maxSTORIAN TEMPLATE.8 is the name of a temporary template Fic101.pv.sample is as above
Since the template name is optional, the example can be shortened to:
_MXSU1_TREND.:fic101.pv.sample
4-26
provided that template.8 was the first temporary template defined in the configuration. And if the default trend source is already _MXSU1_TREND, the example becomes :fic101.pv.sample. If the point that the operator wants to add is already being trended, the new point will not be added; this avoids duplication of data.
4-27
Appendix A
Registered Services and Command Line Parameters
maxSTORIAN runs an instance of MxsReplica with the default parameter _MXS_REPLICA. The Control Panel runs an instance of MxsReplica using _MXS_EXPORT for the service parameter; these two names must not be used for other purposes. The LSS provides two members of the _LSS service to help these programs in locating the correct historian, DEFAULT_TREND and DEFAULT_STORIAN.
CLEAN_PERCENTAGE
USHORT
CONFIG_POINTS_AT_TIME
ULONG
CONFIG_SEC_LEVEL
ULONG
DELETE_TEMPLATE
PCHAR
DELTA_SAVES DISK_ASSIGNED_SPACE DISK_USAGE_PERCENTAGE DISK_USED_SPACE EXPORT_STOP EXTENDED_STATUS FLUSH_INTERVAL HOSTNAME ITEM_POSITION MAX_INDEX MERGE_STORAGE_ROOM OBSERVATION_TIME OLDEST_TIME OPERATION
ULONG FLOAT ULONG FLOAT ULONG PCHAR ULONG PCHAR PVARIA NT ULONG PCHAR ULONG TIME PCHAR
X X X X
X X X
X X
1-2
X X X
PAUSE
POINT_DELTAS_CNT
1-3
RESTART
ULONG
X X
X X X
TRIM
TIME
1-4
Appendix B
Using SRCheck to Correct Storage Room Errors
Overview
The main function of this program is to check and correct maxSTORIAN aisle files for empty blocks, out of time order blocks, and, on request, it will check individual blocks for date or data corruption. It examines each of the aisle files, as well as the MxsCore file, in a maxSTORIAN storage room for a) blocks which have no useful data in them; b) blocks which are not in time order; and c) blocks which are corrupted. Its input is the location of the storage room to be examined. Its outputs are a copy of the storage room, with all aisle files repaired; and a log file listing each of the aisle files showing whether each file was OK, and if it was not, the numbers of the blocks which were removed, or the block number of any block which was out of time order. A second function of this program is to compress the aisle files after there have been Trim operations. As explained in Chapter 2, after Trims have occurred, there are blank blocks in the Storage Room which have been released to the operating system, but these blocks are still remembered by the operating system. When SRCheck is executed with the update all option, all of the aisle files will have their blank blocks removed, and the Explorer size of each file will again be equal to size on disk, making it possible to copy aisle files to other disk locations or to other disks. A third function of this program is to perform a one-time conversion of a Release 2.x Storage Room to Release 3 compatibility. This need be done only once, after a maxSTORIAN has been upgraded to Release 3 but before the maxSTORIAN is started up. A fourth function, available in Release 3.1 and newer, is the ability to Trim older history data. You can select whether the original Storage Room will be modified by this program. You can designate that you merely want to determine if there are errors; you can overwrite the existing Storage Room data; or you can build a new Storage Room elsewhere.
Strip events older than the specified date Update last config
2-2
Destination Storage Room Do not write to destination Update on error Rebuild all
Show the location of the parent of the destination Storage Room. In the example shown above, the user is repairing the Source Storage Room. This is the check only option. There will be no writing to the Destination Storage Room. The SRCheck.log file will still be generated, however (located in c:\custom\history). This option means that only if SRCheck finds an error in a file will it be written back to the Destination. Do not select this option if you want to compress the Storage Room. This option causes SRCheck to overwrite every Destination file with a corrected, compressed new file. Should be performed during an upgrade from Release 2 to Release 3, as well as before you attempt to move Storage Room files from one location to another. This is a counter that shows the progress of the checking process. It counts up to the number of points in the Storage Room. Initiates the checking process. Stops the checking process. If this button is pushed while checking is underway, then only some of the aisle files will have been checked and updated.
The selections which you see in the example above are those that should be selected if the Storage Room were located on drive C:\, and the conversion from Release 2 compatibility to Release 3 compatibility had already been performed.
2-3
2-4
Appendix C
Wave Generator
Wave Generator, also known as Pointsim or Point Simulator, is a utility used to create local status variables that will oscillate over a selected wave pattern.
To created simulated points: 1. Click the Start button on the Windows Task Bar, point to Programs, maxDNA, maxSTORIAN Utilities, and then click Point Simulator to open the Wave Generator Dialog. Alternatively, start the program Pointsim.exe located in c:\mcs\sbp. 2. Under Saw Tooth click on one of the pattern types to select it. 3. Double-click to select one of the types: Int, Long, Float, or Double. You can also select whether you want the Quality to be returned with the value, and whether the Int or Long will be returned as an unsigned value.
3-2