Home

OpenBSI Harvester Manual (D5120)

1. 24 24 24 24 9 OpenBSI Harvester Configuring Your Controller This process continues until some pre defined number of arrays has been filled at which time the process will start over again This is similar to the wrapping discussed earlier except instead of wrapping around within a single array wrapping occurs to another array When configuring these arrays in ACCOL data should always be stored beginning with Row 1 of the first array When wrapping to another array storage should also always begin with Row 1 Data must be stored at regular intervals which are less than or equal to the specified scan interval IMPORTANT If you decide to modify the standard ACCOL load for the GFC 3308 or you create a load of your own remember that multiple array collection can only be performed if each and every array to be collected has the exact same row column dimensions Any attempt to collect arrays of different sizes through multiple collection will cause the Harvester to terminate its collection In addition when multiple arrays are to be collected they must be numbered consecutively Raw Array A Raw Array collection involves an array where the Harvester simply collects the entire array without regard to timestamps or rows No matter which of the methods are used the Harvester will collect the historical data from the data arrays at a pre defined scan interval and store
2. Name rtu_name rtu_name is the name of the RTU being added to or deleted from the system via this definition rtu_name must either match the name of an RTU already configured in NetView or the RTU must be added to NetView using the Network keyword further on in this definition Delete delete if delete is set to T this RTU will be deleted from the Harvester Node_ID description Enter a textual description of the node that will appear in the Harvester Node Information window Only the first 64 characters you enter will be displayed as the description Write_Station toggle if toggle is set to 0 information from the RTU definition will NOT be written to the station file If set to 1 default it will be written to the station file If set to 1 and no station file exists it will be created NOTE If there are multiple list arrays etc being collected from this controller only the first one will be used to update the station file Default_Config default_RTU_config If specified the Harvester will use the defaults for the RTU named in default_RTU_config for this RTU s configuration NOTE If a default_RTU_config is specified the remaining entries for this RTU are not necessary as they will assume the defaults of the RTU specified by default_RTU_config Disable disable_collections If disable_collections is set to 1 collections for this RTU are disabled If set to O default
3. WrapArray WrapMultipleArray RTU name Illegal Interval specified An incorrect entry was made for the interval The interval must be an integer from 1 to 3600 RTU name Illegal Interval Units specified An incorrect entry was made for the interval units Interval units must be one of the following Hours Minutes or Days RTU name Illegal Scan Type specified An incorrect entry was made for the Scan Type This value must be either 0 1 or 2 RTU name Illegal Start Collection Date The start collection date was invalid The date must be formatted as mm dd yyyy where mm is the two digit month dd is the two digit day and yyyy is the four digit year RTU name Illegal User On Time One of the user one times is invalid These must be in the format hh mm ss PM or hh mm ss AM where hh is the two digit hour mm is the two digit minute and ss is the two digit second RTU name RTU already exists You have attempted to add an RTU that already exists in the Harvester or OpenBSI RTU name Successfully Added to Database The RTU has been successfully added to the Harvester Database RTU name Successfully Deleted from Database The RTU has been successfully deleted from the Harvester Database OpenBSI Harvester F 7 This page is intentionally left blank Addendum to D5082 D5083 D5120 Using the OpenBSI Data File Co
4. e ProgramD ata Bristol O penBS Harvester Location of PI Tag file c ProgramD ata Bristol OpenBSI Harvester rA Floating Point Format Field Delimiter l Create Diagnostics file Cancel The directory folder where the converted files that will be imported into the PI Database are stored Click on the button to specify the directory The path and filename of the tag mapping file The Tag Mapping file specifies the tag names that will be used in the PI Database for the data to be exported Click on the button to specify the path and tag mapping filename Using the Data File Conversion Utility ADD 48 Addendum to D5082 D5083 D5120 Floating Point Click here to call up the Change Floating Point Format dialog box to allow Format you to specify the floating point precision used to display the exported data See Using the Floating Point Format dialog box earlier in this document Field Delimiter Click here to call up the Delimiter dialog box This dialog box allows you to specify what character tab comma etc will be used in the converted file to separate one data field from the next data field The choice of a delimiting character depends upon the application database which will be using the converted file Choose whichever delimiting character is required by your application database and click on OK Delimiter es Tab Semicolon Comma Lo Create When this is checked a log will
5. Coastal DLL Access Database BBODBC DLL This DLL exports signal list data in a format compatible with ODBC compliant applications such as Microsoft Access For information on this DLL see the sub section Exporting Data Using the Access BBODBC DLL Extended Access Database EXBBODBC DLL This DLL exports signal list array archive and audit trail data in a format compatible with ODBC compliant applications such as Microsoft Access For information on this DLL see the sub section Exporting Data Using the Extended Access EXBBODBC DLL OpenEnterprise Export QEEXP DLL This DLL exports data in a format compatible with the historical portion of the database in the OpenEnterprise supervisory software package For information on configuring this DLL see the sub section Exporting Data Using OpenEnterprise Export OEEXP DLL PI Batch Database Conversion PIBDC DLL This DLL exports data in a format compatible with PI Database For information on configuring this DLL see the sub section Exporting Data Using the PI Batch Database Conversion PIBDC DLL PGAS Conversion PGAS DLL This DLL exports data in a format compatible with the PGAS application For information on configuring this DLL see the sub section Exporting Data Using the PGAS DLL Once the required DLLs have been configured they must be selected 7ODBC stands for Open Database Connectivity Using the Data File Convers
6. Data can be collected at scheduled intervals e g hourly or at a specified set of up to ten times during the day or based on a pre defined collection scheme which takes into account various factors affecting communications OpenBSI communications must be active for collections to occur What happens to the data once it is collected The data collected by the Harvester is stored in files at the PC workstation These files can be converted to a variety of formats using the OpenBSI Data File Conversion Utility making them accessible to other programs e OpenEnterprise database e Comma Separated Variable format CSV for use in Microsoft Excel e Coastal Flow Measurement s Flow Cal package e ODBC for use in Microsoft Access Array data files Access Excel etc Export to OpenEnterprise Data File Conversion Utility va e Audit HS data data data files files files Harvester Open BSI Communications Layer Controller Network OpenBSI Harvester Communication Link direct cable connection dial up modem or radio A A ro A Inputs from field instrumentation 2 Introduction What is the Harvester Overview of Steps Which Must be Completed to Successfully Use the Harvester 1 The OpenBSI Network Edition and the Harvester kit must be installed
7. gData File Conversion Utility Oj x File view Export Database Help Blev Z Ae Sl e r2 Date Station Description Source 1 10 2003 10 03 12 1 10 2003 10 03 12 Export Process Started 1 10 2003 10 03 52 Export Process Stopped 1 10 2003 10 04 06 Station Configuration File Modified 1 10 2003 10 04 43 Export Process Started 1 10 2003 10 04 49 BOILER641 Exporting Data Array Records L1513 401 1 10 2003 10 04 49 BOILER641 Exporting Data Array Records L1513 402 1 10 2003 10 04 49 BOILER641 Files Copied to Temporary Directory L1513 For Help press F1 lating STEAMGENT 9 See the OpenBSI Utilities Manual document D5081 for information about configuring and starting OpenBSI communications Addendum to D5082 D5083 D5120 ADD 3 Using the Data File Conversion Utility Specifying Initialization Parameters For the Data File Conversion Utility to function correctly certain information must be specified before exporting is started This information is defined in the Data File Conversion Setup dialog box To call up this dialog box click on the icon shown above or click on File gt Initialization Parameters Page The first page of the dialog box defines initialization parameters and is accessible by clicking on the Parameters file tab The fields on the page are described below Data File Conversion Setup Parameters Files Export Libraries Time Interval 30 seconds Error History Buffer Size
8. WSG files These files are discussed in detail in Appendix A You can type the path in directly or use the Browse button to locate it The OpenBSI Harvester will automatically enter stagger mode if the number of nodes which the Harvester is currently attempting to communicate with is greater than or equal to Number of Active Nodes forcing Stagger Mode If the number of nodes the Harvester is actively trying to collect data from exceeds a user defined number it is said to be in an over run condition and so will enter stagger mode In stagger mode the Harvester will only attempt to collect the full amount of new data from a portion of all of the nodes during any scan interval For each node which the Harvester collects from it will skip a full collection from Number of Nodes to skip in Stagger Mode nodes For example if Number of Nodes to skip in Stagger Mode is set to 5 the Harvester will collect the full amount of data from one node skip full collections from the next 5 nodes then collect the full amount of data from another node then skip another 5 nodes etc In other words the full amount of data is only collected from every 6 node On the next Defining System Information Dial Number of Dial Retries on a busy line Time in seconds to wait between Dial Retries scan interval the Harvester will collect the full amount of data from a different set of nodes again skipping 5 nodes for e
9. di Floating Point Format dialog box will appear Use the Width list box to specify the total F penent number of characters in the field Gncluding the decimal point when displaying a floating point Example 12345 56780 number Use the Precision list box to choose the number of places to the right of the decimal point which should be displayed Use the Exponent list box to choose floating point format f exponential notation e or choose g to have the Data File Conversion Utility choose the best fit format Click on OK when finished Addendum to D5082 D5083 D5120 ADD 15 Using the Data File Conversion Utility Exporting Data Using the Flow Cal Coastal DLL The Flow Cal Coastal DLL converts Harvester data files into a format suitable for import into Coastal Flow Measurement Inc s Flow Cal software COASTAL store_path storepath map_path mappath cfx_path cfxpath unique_map yes no map_file filename period hour day where storepath mappath cfxpath filename is the drive and directory where the compacted files HLY AUD and CFG should be stored for export to Flow Cal These files are used to create a Flow Cal import file The default storepath is C ProgramData Bristol OpenBSI ACCOL is the drive and directory where the mapping file s will reside The default drive and directory is C ProgramData Bristol OpenBSAACCOL Mapping files have the file extension o
10. These names together with a station name of ELMSTRT have been entered in the Station Data dialog box Data File Conversion Setup EG Parameters Export Libraries Next with all exporting stopped the OEEXP OpenEnterprise Export DLL must be highlighted by clicking on it in the Export Export DLLs Selected DLLs DLLs list box of the Data File Conversion Setup dialog box Next click on the Select gt ESV push button and the DLL name will be moved EXBBODBC to the Selected DLLs list box Remove Add New DLL Configure OK Cancel Help 21Information on naming conventions of files created by the Scheduler Data Collector or Harvester as well as information on the directories used to store these files are included respectively in the OpenBSI Scheduler Manual document D5082 the OpenBSI Collection Export Utilities Manual document D5083 and the OpenBSI Harvester Manual document D5120 Using the Data File Conversion Utility ADD 28 Addendum to D5082 D5083 D5120 Open Enterprise Export DLL Setup x Database Data Service RTRD81 Username SYSTEM Password naa Configure Schema m Record Information Use All Array Record s Fields Floating Point Format m Error Logging Log File Browse J Delete error log file at startup Next click on the Configure push button to call up the OEEXP DLL Setup dialog box OK Cancel Help F
11. 0 flow insert into oelogcolumn control name type sourcecolumn values 3 temperature 0 temperature insert into oelogcolumn control name type sourcecolumn values 3 pump_status 0 pump_status insert into oelogcolumn control name type sourcecolumn values 4 pressure_1 0 pressure_1 insert into oelogcolumn control name type sourcecolumn values 4 pressure_2 0 pressure_2 insert into oelogcolumn control name type sourcecolumn values 4 pressure_3 0 pressure_3 commit Determine how often array data should be retrieved from the streams insert into oelogdata rate control buffercount buffersize archdirectory archbuffercount values Os 3 10 1024 c histfiles 9 insert into oelogdata rate control buffercount buffersize archdirectory archbuffercount values 0s 4 10 1024 c histfiles 9 commit Create the Access tables update OELogControl set raw dpul_dest_table where id 3 commit or Create the Access table update OELogControl set raw dpu2_dest_table where id 4 commit Addendum to D5082 D5083 D5120 ADD 45 Using the Data File Conversion Utility Exporting Data Using the PI Batch Database Conversion PIBDC DLL The PI Batch Database DLL converts data from arrays archive files audit files and signal lists to a file that can be imported into the PI Database The user must create a text file that defines the map
12. 1 4 STAIRTD STAI 4 1 5 STAICURRENT STAI 4 2 1 STALOUTPRESSURE STA2 4 1 1 STA2BATT VOLT STA2 4 STA2 4 STAI 4 STAI 4 STAI 4 2 STA2COM REQ 3 STA2INVOL1 STA2 4 1 4 STA2RTD STA2 4 1 5 STA2CURRENT STA2 4 2 1 STAZOUTPRESSURE tag_mapping_file TXT Once the Tag Mapping file has been created you can proceed to set up the DLL Data File Conversion Setup Export Libraries x With all exporting stopped the PIBDC DLL must be highlighted by clicking on it in the Export DLLs list box of the Export Libraries page of the Data File Conversion Setup dialog box It is Parameters Files Export DLLs Selected DLLs PIBDC Select COASTAL ale then moved to the Selected DLLs list box by Sd EXBBODBC z OEEXP _ lt Deselect clicking on the Select gt push button Remove Now click on the Configure button to call up the PIBDC Export DLL Configuration dialog box Add New ou Configure In the PIBDC Export DLL Configuration dialog box complete the fields as described below and then click on the OK push button This causes the changes to be read by the Data File Conversion Utility Then click on OK to exit the Data File Conversion Setup dialog box Finally re start the export process Directory for PIBDC files Location of PI Tag file PIBDC Export DLL Configuration Export Directory for PIBDC format files
13. LIST_0 00 3 GV R1_VOLUME_MONTH Variable sig name for list element 3 LIST_0 01 3 0 Value of list element 3 LIST_0 00 4 GV R1_VOLUME_LMONTH Variable sig name for list element 4 LIST_0 01 4 0 Value of list element 4 LIST_0 00 5 GV R1_ENERGY_MONTH Variable sig name for list element 5 LIST_0 01 5 0 Value of list element 5 LIST_0 00 6 GV R1_ENERGY_LMONTH Variable sig name for list element 6 LIST_0 01 6 0 Value of list element 6 LIST_0 00 7 GV R1_FLOWTIME_TODAY Variable sig name for list element 7 LIST_0 01 7 0 Value of list element 7 LIST_0 00 8 GV R1_FLOWTIME_CURR Variable sig name for list element 8 LIST_0 01 8 0 Value of list element 8 Addendum to D5082 D5083 D5120 ADD 51 Using the Data File Conversion Utility Exporting Data Using the PGAS DLL The PGAS DLL converts data from archive files audit files and signal lists to XML files that can be imported into the PGAS application A PGAS XML file can contain either meter data from an Electronic Flow Meter EFM such as gas volumes events and alarms or it can contain gas quality data from a chromatograph Station1 meter Station2 meter Archive and a Tag Lookup configuration ce aul File for list files z E E 7 Station 1 collected froma controller s amp OPEN BSI by the z Config Config z DATA FILE Harvester List List z CONVERSION Tag Lookup m UTILITY File for F Station 2 Tag Lookup Fi
14. Modify button NOTE For this to work correctly the station file s archive name must follow the format described earlier in this section If you have a Flash Configuration Profile FCP file you can click on this button to load the archive file s column data into the Meter Volume Configuration window thereby simplifying the mapping process since you only need to define the attribute name for each column via the Modify button NOTE For this to work correctly the station file s archive name must follow the format described earlier in this section Map Archive Column to Attribute Name Column s Position in the Archive s Column F1_DENS Attribute Name FLOWING_DENSITY x To map columns of the archive to PGAS attributes identify the column then enter the column name Finally use the Attribute Addendum to D5082 D5083 D5120 ADD 57 Using the Data File Conversion Utility Remove Modify Include Start Date Treat Archive File s Timestamp As Start of Period or At Store Apply Current Configuration to Stations Name selection box to choose the corresponding PGAS attribute Click on OK when finished To delete an entry from the Meter Volume Configuration window click on it then click on Remove To change an entry from the Meter Volume Configuration window click on it then click on Modify The Map Archive Column to Attribute Name dialog box will appear
15. TIMER TRIG 0N TIMER RSET 0N MAINT REQ 0OFF RADIO DAY REQ TIME SP DAY TIME SP TIMOUT SP DAY TIMOUT SP TIMER TRIG 0N TIMER RSET 0N DAY REQ 0FF RADIO HOUR REQ TIME SP HOUR TIME SP TIMOUT SP HOUR TIMOUT SP TIMER TRIG 0N TIMER RSET 0N HOUR REQ 0FF OF RADIO TIMER TRIG TEST K RADIO RESET REQUEST FROM HOST REQUESTED THEN WAIT FOR 1 5 SECONDS TO ALLOW COMMUNICATIONS TO COMPLETE BETWEEN MASTER AND REMOTE 260 CALCULATOR eC CHECK FOR RESET REQUEST 20 IF RADIO RESET REQ IF RESET REQUEST THEN INCREMENT LOOP COUNTER RESET CNT RADIO RESET CNT 1 IF COUNTER 3 1 5 SECONDS AFTER SHUTOFF THEN RESET TIMERS THIS IS NEEDED TO ALLOW THE REMOTE TO RESPOND TO THE TURN COMMAND IF RADIO RESET CNT gt 3 IO RESET CNT 0 IO RESET REQ 0OFF IO TIMER RSET 0OFF F RESET CNT 0 RIGGER COMM TIMER COMMSTAT TRIG RADIO TIMOUT SP RADIO TIMER RSET COMMSTAT TIME RADIO TIMER RSET NO POLLS IN TIME OUT PERIOD THEN RESET BOTH TIMERS AND TURN OFF PORT 30 tC 40 RADIO 50 C OFF 60 70 RAD 80 RAD 90 RAD 100 ENDI 110 ELSE 120 RADIO 130 ENDIF 270 C RET 280 TIMER INPUT SETPOINT RESET TIME OUTPUT_1 290 C IF 300 TIMER INPUT SETPOINT RESET OpenBSI Harvester RADIO TIMER TRIG RADIO TIME SP RADIO TIMER RSET C 5 Appendix C Sample ACCOL Task for Radio Control TIME RADIO TIME REM OUTPUT _1 RADIO ACTIVE 310 XG UPDATE STATUS OF RADIO CONTR
16. What is the Harvester The Harvester is a utility which allows collection of historical data from a network of ControlWave and Network 3000 controllers It combines many of the features of the OpenBSI Scheduler and OpenBSI Data Collector programs available in earlier releases of OpenBSI What types of data can be collected This historical data which can be collected by the Harvester includes e Data array values e Archives e Audit data alarms and or events e Lists typically containing configuration data The Harvester can be used with Network 3000 series controllers DPC 3330 TeleFlow etc as well as the ControlWave series of controllers PC workstation running Open BSI and Harvester i software plus HMI software e g OpenEnterprise Radio connection Cable or dial up A connections del fel a Network 3000 controller controller Network 3000 Flow computers correctors Network 3000 Network 3000 controller controller e222 2 ControlWave controller 1 OpenBSI Harvester Introduction What is the Harvester What determines how often data is collected
17. could have an external program change the user on times User Time 1 through User Time 10 later in this table and activate the new on times simply by setting OnUserTimeChange to Yes If set polling to this unit is stopped and the modem will be hung up after the collections have been completed Scan Type Number The method of collection 0 Scan Interval 1 User entered Interval 2 User entered ON times Interval Number If User entered interval this field contains the interval value Interval Units Text If User entered interval this field contains the user selected units Interval Offset Number Number of seconds to offset collections from the inerval Comm Off Sig Text This signal is set in the node to turn off communications at the node end Maint Sig Text This signal is set in the node to start Maint Mode Collect Audit Sig Text If the signal is within an Audit record all lists for the node are collected OpenBSI Harvester D 2 Appendix D Harvester Database Tables Field Name Data Type Description Skip History Yes No If set Archive Array and Audit collections are skipped on the first collection pass Username Text ControlWave nodes require a username and password be supplied for collections to occur Encrypted Password Text Password must be correct for the Username entere
18. document D508 1 5 OpenBSI Harvester Configuring Your Controller Configuring Your Controller to Work with the Harvester Before attempting to use the OpenBSI Harvester your controller network must already be up and running and collecting data from field instrumentation Instructions for setting up each controller are included in the hardware manual accompanying the device The node name for each and every controller must exist in the Network Definition NETDEF files During later stages of configuration you will need to know the node name local address and expanded node addressing group number if applicable for each controller EGM 3530 10A EGM 3530 50A TeleFlow Users If you are using an EGM 3530 10A or 50A TeleFlow electronic gas measuring computer it is already pre configured with the required signals signal lists Audit Trail and archive structures if you need to alter the configuration please contact our Technical Support Group for assistance DPC 3330 DPC 3335 RTU 3305 RTU 3310 3530B series GFC 3308 ControlWave Users If you are using Network 3000 series DPC 3330 DPC 3335 RTU 3305 RTU 3310 B or newer 3530 series units supporting ACCOL or a GFC 3308 unit the ACCOL load running in the unit must be configured with certain structures Similar structures must also be created if you are using a ControlWave controller running one of the IEC 61131 languages These structures data arrays the EA
19. has been chosen for the converted files as shown in the Station Data dialog box Its associated collection names which are DPC51 for the hourly arrays DPCS5 for the audit trail data and DPC51 for the configuration list data are also entered Jf exporting is currently in process edits cannot be made in this dialog box 12Information on naming conventions of files created by the Scheduler or Collector as well as information on directories used to store these files are included in appendices of the OpenBSI Scheduler Manual document D5082 the OpenBSI Collection Export Utilities Manual document D5083 and the OpenBSI Harvester Manual document D5120 18In the Scheduler collection names are defined based on entries in the RTUDEF TXT file Array Archive and List collection names consist of the node name followed by the run number Audit Trail collection names consist of the node name only since the same Audit Trail buffer is shared by all runs in the node Addendum to D5082 D5083 D5120 ADD 17 Using the Data File Conversion Utility The C WINDOWS EXPDLL INI file is modified COASTAL so that the converted files will be stored in the store_path C COASTAL COASTAL directory A mapping file FCS map_path C COASTAL which is specific to this controller must also be cfx_path C COASTAL created in that directory unique_map NO map_file period DAY Next with all exporting stopped the COASTAL DLL must b
20. in which case the next data will go to row 1 This wrap around method is also referred to as a circular array In this way the oldest data is always overwritten with the newest data When configuring this array data should always be stored beginning with Row 1 In addition data must be stored in the array at regular intervals which are less than or equal to the specified scan interval Scan intervals are discussed later in this manual The pictures below illustrate the wrap array concept by showing three snapshots of a 5 row by 4 column data array Most recent data Timestamp Column Column Column Column 1 2 3 4 In the first snapshot the most recent Row1 09 02 94 12 10 00 69 47 22 54 18 90 data has a time stamp of September 2 pow 09 02 94 13 10 00 66 21 22 87 18 93 1994 at 3 10 PM and is in the fourth Row 3 09 02 94 14 10 00 61 54 24 03 20 25 row Row 4 09 02 94 15 10 00 65 30 21 83 19 21 Row 45 09 02 94 11 10 00 60 11 23 78 19 33 Oldest data OpenBSI Harvester 8 Configuring Your Controller Timestamp Oldest data Column Polym Column Column 1 3 4 j Row 1 09 02 94 12 10 00 59 47 22 54 18 90 k In the second picture new data has Row 09 02 94 13 10 00 66 21 22 87 18 93 been collected at 4 10 PM overwriting the oldest data i e Row 3 09 02 94 14 10 00 61 54 24 03 20 25 11 10 AM data which had beenin Row4 09 02 94 15 10 00 65 30 21 83 19 21 row 5 The 12 10 PM datain row 1 Sows 09 02 94 16 10 00
21. shown above or by clicking on View Debug Messages NOTE Only debugging errors related to the currently selected controller will be displayed Placing a controller into Maintenance Mode Maintenance Mode is a mode of operation in which communications with a controller via radio etc are kept running even when no collections are occurring This may be useful during maintenance or testing or if other programs need access to the controller e g DataView or an HMI package even though the Harvester is between collections To place a controller into Maintenance Mode click on the icon for it then click on the Start Maint button o place a controller into Maintenance Mode click on its icon then click on Start Maint Harvester File Edit View Node Information Start Maint Name Cw T Disabled Descriptor OAK STREET COMPRESSOR STATION Start Poll Session Status Error Comm Send Failure SaPol Time Infomation Demand Coll Nest Nn Time 1 19 2N1N 12 NNN Averane Nn Time N The Harvester will then send a message to turn ON the Maintenance Mode signal inside the controller This signal triggers user defined logic in the control strategy which leaves communications active 47 OpenBSI Harvester Monitoring the Status of Your Collections Once Maintenance Mode has been successfully activated the icon for the controller Fi placed into maintenance will be displayed with a yellow M over
22. 1 is reserved for temporary storage of running totals Most recent data Timestamp Column Column Column Column The pictures at right 1 2 3 4 illustrate this concept by showing two snapshots of a 5 row by 4 column data array Row 2 09 02 94 14 10 00 61 54 24 03 20 25 aoe Row 3 09 02 94 13 10 00 66 21 22 87 18 93 In the first picture the most f f recent data has a time stamp Row 4 09 02 94 12 10 00 59 47 22 54 18 90 of September 2 1994 at 2 10 Row 5 09 02 94 11 10 00 60 11 23 78 19 33 PM and is in row 2 Row 1 Row 1 reserved for storage A Oldest data 7 OpenBSI Harvester Configuring Your Controller Most recent data i Timestamp In the second picture new data has Column been collected at 3 10 PM pushing the 2 10 PM data down Row 1 into row 3 the row 3 data into row l I 4 and the row 4 data into row 5 Row 2 09 02 94 15 10 00 65 30 21 83 19 21 The previous data that had been in Row3 09 02 94 14 10 00 61 54 24 03 20 25 TOW SS disperde Row4 09 02 94 13 10 00 66 21 22 87 18 93 Row5 09 02 94 12 10 00 59 47 22 54 18 90 Column Column Column 2 3 4 Row 1 reserved for storage Oldest data Storage with Wrapping Wrap Arra Storage with wrapping means that if the most recent data is currently in row n of the data array the next data will be stored in row n unless row n is the last row of the array
23. 63 84 19 58 20 86 F is now the oldest Mast recent data In the third picture new data is Most recent data l Timestamp collected again It would be stored Column Column Column Column 1 2 4 in Row 6 except there isn t one so j the array wraps around and itis Row 1 09 02 94 17 10 00 64 45 21 38 19 96 stored in Row 1 Now the oldest T j data which was the 12 10 PM data Row 2 09 02 94 13 10 00 66 21 22 87 18 93 in row 1 has been over written Row 3 09 02 94 14 10 00 61 54 24 03 20 25 with the most recent data from Bo 4 99 02 94 15 10 00 65 30 21 83 19 21 5 10 PM The next collection will A ROW and cool Row 5 09 02 94 16 10 00 63 84 19 58 20 86 Oldest data a Storage in Wrap Multiple Arrays The final method of data array storage is typically used in applications involving large amounts of data such as gas flow metering using the GFC 3308 AccuRate Gas Flow Computer with its standard ACCOL load In this type of application arrays in the GFC 3308 unit s ACCOL load are configured to store data on an hourly basis and each array has 24 rows one for each hour in the 24 hour period corresponding to a gas day When the gas day ends i e the first array is full new data is stored in another array until that array is full and then still another array is used See the fi below igure below Dayn Dayn 1 Dayn 2 Dayn 3 aaa 1 1 1 1
24. Parameters for the collections will be defined in a section of the file with this name Network network_name If this field is included in the RTU_x group Harvester will add this RTU to OpenBSI before adding it to its own database A check for RTUs being added to the system is performed every 5 seconds The network must already exist in OpenBSI Several additional fields RTUType LocalAddr Prim_IP Pred Sec_IP MsgTmo Load Dial WebPage AlarmDest RBEDest FailType TS_Disable Comm_Direct are used to define the RTU some are required some are optional RTUType type type defines the type of RTU being defined Possible types are as follows Type RTU 1 RTU 3305 2 GFC 3308 3 RTU 3310 OpenBSI Harvester E amp Appendix E Harvester Initialization Files 4 DPC 3330 5 DPC 3335 6 3508 TeleTrans 7 3530 series TeleFlow TeleRTU TeleRecorder 9 ControlWave 10 ControlWave LP 12 ControlWave MICRO 13 ControlWave EFM 14 ControlWave GFC 15 ControlWave XFC 16 CW_10 17 CW_30 19 ControlWave Express Local_Addr local_address This is the BSAP local address 1 to 127 Prim_IP aaa bbb ccc ddd Prim_IP aaa bbb ccc ddd If this is an IP node you must define a primary IP address Pred node Pred node For BSAP networks this would be the predecessor RTU If this is the first level of the BSAP network then specify the NHP name Required Sec_IP eee fff ggg
25. STATION column Data Source C_APROGRAMDATA BRIST When Database is selected from the list and you Table Name click on OK the Import Table Definition dialog box will appear This allows you to import a table from an existing relational database that is involved in the __ Cancel export process such as Microsoft Access or SQL Server Enter the Table Name you want to import and click on OK to import the table The first column of the database table will be mapped to field 1 of the UOI record s field Import from Archive Profile ControlWave series ONLY When Archive Profile is selected from the Import Table from list and you click on OK you will be prompted to locate a Flash Configuration Profile FCP file FCP files are created using the Flash Configuration Utility Selection of the requested FCP file will activate the Import from Archive Profile Wizard Select the Archive file whose fields descriptors will be used as the names of the table s columns lt Back Finish Cancel Help In the first page of the wizard simply choose one of the listed Archive Files from which you want to import the table columns Then click on Next The second page of the wizard lists the R k The list below shows the names of the columns of the names of the columns which will be BY table to be imported imported into the database If any fq Archive 4 Archive Name TOTALS modifications are
26. a BSAP network the archive records to be displayed must be 220 bytes or less A total of 4 bytes of the 220 are already used to display the timestamp plus 2 bytes are used for the local sequence number and 2 bytes are used for the global sequence number This leaves 212 bytes for other columns of data This could include up to 53 columns of floating point data Type of Data Number of bytes required Timestamp 4 Local Sequence Number 2 Global Sequence Number 2 Analog Floating Point value 4 Logical BOOL value 1 27 OpenBSI Harvester Adding a Controller and Configuring Collections Defining Modifying an Audit Collection Complete the fields as described below then Collection Configuration click on OK Collection Type Audit z Usage Notes Cancel If Harvester users select a Demand Coll Flags collection all audit records which the Harvester has not already collected will be A brought back If audit records have already i S moo been collected and still exist at the RTU they will not be collected again F Disable If the Init Collection button has been pressed prior to a Demand Coll collection aeons all audit records available at the RTU will be Reset after Collection brought back whether or not they have been collected previously Collection Type This must be set to Audit Flags Disable When checked will stop this collection from occurring Communications Max
27. choice of how to name the column in the new table If Use Signal Name for table s column name is chosen each column of the imported table will be named after its associated ACCOL signal If Use Signal Name for table s column name is chosen each column of the imported table will be named after the archive record column s title After you have done so the Import from ACC File Wizard will be started NOTE Column names are limited to 16 characters If you choose signal names for the column names the signal names will be truncated to the first 16 characters If because of the truncation duplicate column names result because the first 16 characters of more than one signal are the same an error message will result Import table from ACC File Step 1 of 3 x Select the Archive file whose fields descriptors will be used as the names of the table s columns Archive _ Archive Name Fields_ 0 4 In the first page of the wizard simply choose one of the listed Archive Files from which you want to import the table columns Then click on Next 10 TOTLFLOW Finish Cancel Help The second page of the wizard lists the names of the columns which will be imported into the database If you chose signal names for the column names they will appear if you chose column Addendum to D5082 D5083 D5120 ADD 39 Using the Data File Conversion Utility titles for the column names they will appear If you
28. from this controller This is the last time that the Harvester attempted to collect any data from this controller This is the average time in seconds that the Harvester requires to collect all necessary data from this controller This is a running total of the amount of time in seconds that the Harvester has been in communication with this node during all collection passes since the last time the Init Collection button was pressed This indicates the kind of data being collected There are seven collection types Archive Audit List Raw Wrap Push and MWrap The last four refer to different types of array collection This is the number of the structure being collected i e the array number the archive number or the signal list number If multiple arrays are collected this would be the number of the first array in the group of consecutively numbered arrays This field does not apply to Audit Indicates whether or not this collection has been disabled During the last collection of this type of data this was the timestamp collected During the last collection of this type of data this was the status of the collection Success indicates the collection occurred without errors Any other message indicates an error The total number of consecutive errors received during this type of collection The total number of errors received during this type of collection 43 OpenBSI Harvester Monitoring
29. in the course of its execution will be included in the log file Log Path of Execution for If checked debugging information about the PGAS Export debugging DLL s operation will be included in the log file Security Page PGAS Export DLL Configuration The Security page allows you to specify that default security should be used Default security Ee ar oie Oe ere aman allows you to specify a single common password at er eee ey ere ee ee used by all controllers in your network that is sent automatically to an RTU when requesting signal list information thereby avoiding the user having to log Peot in to each controller individually Setup Logging Security NOTE Beginning with OpenBSI 5 8 Service Pack 1 default passwords can be up to 16 characters Earlier versions limited passwords to six characters To activate default security check the Enable Default Security box then provide a common Password that is valid for all controllers on your network Using the Data File Conversion Utility ADD 60 Addendum to D5082 D5083 D5120 Format of Tag Lookup Files TLF IMPORTANT We strongly recommend you only modify the Tag Lookup Files TLF using the Tag Lookup File Configuration dialog box described earlier in this section Advanced users may choose to make some edits directly in the TLF file therefore the syntax is presented here but most users should avoid this approach A TLF is an INI
30. in the list box then making changes in various fields the same fields used to create the column and then clicking on the Modify push button You can also delete a column definition by clicking on the column name in the list box and then clicking on the Remove push button Method 2 Importing the Table Required Method When Using the OEEXP DLL to export array archive or audit trail data IMPORTANT If you are using OpenEnterprise Export OEEXP DLL you must have created both the real time and historical portions of your OpenEnterprise Database For help on the historical portion see Examples For Configuring the OpenEnterprise Historical System later in this addendum To import a pre existing table rather than defining one as described in Method 1 click on the Import Table push button in the Table Definition dialog box You have three different choices as to the source Table will be imported from an from which you want to import the table ACC file ACCOL load ACCOL loads contain information related to archive Database files Archive Profile Use Title for table s column name ACCOL Load Use Signal Name for table s column name Cancel Addendum to D5082 D5083 D5120 ADD 37 Using the Data File Conversion Utility Import Table From Database Before attempting to import tables from a database Import Table Definition you must have already created them in your database and they must include a
31. table for logging them into historical database create table dpul_station PERSISTENT PRIMARY KEY station station char trigger_update integer rectimestamp datetime signal_0O1 real signal_02 real Create a stream for monitoring of data in the source table insert into oelogcontrol id source namecolumn enable triggercolumn values 1 dpul_station station true trigger_update commit Set up the columns of the source table to be monitored insert into oelogcolumn control name type sourcecolumn values 1 rectimestamp 0 rectimestamp insert into oelogcolumn control name type sourcecolumn values 1 signal_O1 0 signal_O1 insert into oelogcolumn control name type sourcecolumn values 1 signal_02 0 signal_02 commit Determine how often array data should be retrieved from the stream insert into oelogdata rate control buffercount buffersize archdirectory archbuffercount values Os 1 10 10240 c histfiles 9 commit Create the Access table Using the Data File Conversion Utility ADD 42 Addendum to D5082 D5083 D5120 update OELogControl set raw dest_table where id 1 commit OpenEnterprise Historical Example 2 The following SQL DDL and DML statements provide an example of the steps that have to be performed in order to configure the historical component of the OpenEnterprise Database for storing audit records into the historical t
32. the Audit Module or the EAudit Module Il OpenBSI Harvester Configuring Your Controller Calculation of Node TurnON Time Actual Collection Time Turn ON Time Start Time Offset Local Address 1 Poll Time Per Node Expanded Node Addressing Group No Poll Time Per Group Actual Start of Collection Turn ON Time Turn on Delay So for example if Start Time Offset 1 second Poll Time Per Node 20 seconds Poll Time Per Group 5 seconds Turn on Delay 5 seconds Then the controller with the group and local address shown will turn ON at the time within the scan interval shown Turn ONtime Actual Start of Collection Group Local Address NNNRrF KH OC OC WNrRWNRWN eR 1 second 21 seconds 41 seconds 6 seconds 26 seconds 46 seconds 11 seconds 31 seconds 51 seconds 6 seconds 26 seconds 46 seconds 11 seconds 31 seconds 51 seconds 16 seconds 36 seconds 56 seconds Logical Signals to Regulate Data Collection amp Modem Control In addition to the signals collected via the signal lists and turn ON time logic each program requires certain logical signals which are either used to notify the Harvester to perform a certain function or are used by the Harvester to indicate it has performed a certain function These signals are as follows OpenBSI Harvester 12 Configuring Your Controller Communications Off Signal This signal is turned ON by the Harvester to notify the controller th
33. the PC and the controller network are functioning properly before trying to configure and use the Harvester 6 Start the Harvester software and sign on 7 If you used lists with the same list numbers and signal names you can configure common lists at this point otherwise skip this step 8 Add new node s and configure the node s using the Node Configuration pages and the Collection Configuration dialog box 9 Edit the system information to specify the locations where Harvester files should be output and if you are using the scan interval for your on time method specify its associated parameters 3 OpenBSI Harvester Introduction What is the Harvester 10 Examine the status of your collections in the monitor window 11 Configure the OpenBSI Data File Conversion Utility to set up export of the Harvester data files to formats which may be exported to OpenEnterprise or various third party packages OpenBSI Harvester 4 Installing the Software Installing the Software The Harvester software is included on the OpenBSI CD ROM To install it choose Install OpenBSI from the choices provided in the CD browser and then select Harvester If it isn t already installed you should also select Network Edition Continue with the installation by following the directions onscreen For more information on the installation process and on other software packages see Chapter 2 of the OpenBSI Utilities Manual
34. the RTU Error Unexpected d Bad data was received from the RTU e Verify that there is not a problem with the communication line noise etc If this OpenBSI Harvester F 5 Appendix F Harvester Error Messages Error Message Cause Possible Remedy problem persists contact Bristol Error Write Modem Request l The modem request signal in the RTU could not be written to e Verify that the modem request signal exists in the RTU that its name matches that defined in the Node Configuration dialog box and that it is not inhibited e Verify that the modem request signal is marked PDD Error Write Signal List Not Found A signal could not be written to in the RTU e Verify that all the signals defined in the Common List or Write List File actually exist in the RTU The following are error and status messages generated as the result of processing the HARV_ADD INI file Error or Status Message Cause Possible Remedy group name RTU Keyword not found The HARV_ADD INI file does not have any sections named RTU_x where x is an integer so no RTUs can be added or deleted RTU name Audit Collection already present RTU name Copy operation RTU not found Because an RTU only has one set of audit buffers there can be only one collection defined for a particular RTU that collects audit data The RTU specified by the Default_Config keywor
35. then logged into the Historical portion of the database The EXPDLL INI file does not have to be configured for the OpenEnterprise Export OEEXP DLL Configuration of station names and the steps described below must be performed There are six major steps which must be accomplished in order to use the OpenEnterprise Export OEEXP DLL 1 If you are exporting signal list data and you have not done so already you must configure the real time portion of the OpenEnterprise database by creating a table To do this enter the following statements in a text file named mytable SQL where mytable is a name of your choice CREATE TABLE mytable PERSISTENT PRIMARY KEY STATION signal_name STATION CHAR signal_name CHAR signal_value CHAR The signal_name and signal_value can be replaced with names of your own choosing Now enter the following command at the SQL prompt include mytable 2 If you are exporting array archive and or audit trail data to the historical portion of the OpenEnterprise Database you must first configure the real time portion of the database and then configure the historical portion of the database See Examples for Configuring the OpenEnterprise Historical System later in this addendum 3 Start the OpenEnterprise Database as described in the user documentation accompanying OpenEnterprise 4 Select the OEEXP DLL from the Export DLLs list box of the Data File Conversion Setup dialog box 5 C
36. three separate station names one for each run should be defined such as RPU21 RPU22 and RPU23 The 1 2 or 3 on the end of RPU2 indicates the run number Collection names are the file base names of the data files originally generated by the Harvester Collector or Scheduler In general for each and every meter run within the controller there is a collection name for the Audit Trail collection data files the Array Archive collection files and the signal List collection files Station names and collection names are specified in the Station File Configuration dialog box To access this dialog box click on the icon shown above or click on File gt Station The Station File Configuration dialog box will appear Station File Configuration x lS Use the list below to create stations and associate them with files collected with the Harvester tool Station Array Archive Modify Delete Cancel OK Click here to define a station Click on the Add button to begin defining the station NOTE Harvester users can have the station file created automatically by selecting the Write to Station File option in the Harvester s Node Configuration dialog box 8Information on file naming conventions is included in appendices of the OpenBSI Scheduler Manual document D5082 OpenBSI Collection Export Utilities Manual document D5083 and OpenBSI Harvester Manual document D5120 Addendum to D5082 D5
37. to D5082 D5083 D5120 Printing Error History and Monitor Entries To print textual entries from the Error History area or the Monitor Area click on the icon shown above Text will be printed on the default printer Logging Errors Appearing in the Error Log File OEEXP and EXBBODBC The following tables list possible errors which may appear in user specified log files when attempting to export data using the OEEXP or EBBODBC DLLs Error Description Failed to load the Database Schema Map file DSM No Data Source File DSN File specified Failed to create Database Interface Object Cannot map UOI field number to table column Field number is invalid for this data record Table definition does not exist Cannot insert update record Number of values in the UOI record exceeds number of table s columns Record will not be inserted Addendum to D5082 D5083 D5120 ADD 67 The file that keeps information about the station schema does not exist Use the Data Storage Configuration utility to create it No DSN file has been specified Use the EXBBODBC DLL Setup dialog box to specify one OEEXP Users ONLY This is an internal DLL error and usually occurs if the OpenEnterprise Database had not been started or the specified service name does not exist In either case there is no established connection to the OpenEnterprise Database An invalid field number was configured in the station schema Check the entries m
38. you want to proceed with deletion of this station configuration Click on OK to proceed or Cancel to cancel the deletion request Then click on OK to exit the Station File Configuration dialog box and save changes The station configuration as well as all entries for that station in the Error Recovery Database if used will be deleted Note If you click on Cancel to exit the Station File Configuration dialog box the deletion request will be canceled Addendum to D5082 D5083 D5120 ADD 9 Using the Data File Conversion Utility Configuring and Selecting Export DLLs In order to convert Collector or Scheduler data to a format suitable for export the Data File Conversion Utility uses a series of Export Dynamic Link Libraries DLL Each of these DLLs consist of the software procedures and sub routines necessary to convert data to another format Currently the Data File Conversion Utility supports the following DLLs Comma separated variable CSV DLL This DLL exports data as a set of values separated by commas This format is suitable for import by Microsoft Excel For information on configuring this DLL see the sub section Exporting Data Using the Comma separated Variable CSV DLL Flow Cal COASTAL DLL This DLL exports data in a format compatible with Coastal Flow Measurement Inc s Flow Cal gas flow calculation package For information on configuring this DLL see the sub section Exporting Data Using the Flow Cal
39. 083 D5120 ADD 7 Using the Data File Conversion Utility To Define A New Station Name and Specify its Associated Collection Names Click on the Add push button in the Station File Configuration dialog box see previous page The Station Data dialog box will appear Complete the fields as described below Station Name RPA Array Archive RPCIARCH ecusT Audit JRPCIAUD List Station Name Array Archive List Audit is the file base name that will be used for the converted exported data file s In OpenBSI 5 1 or newer the station name can be up to 126 characters Previous versions were limited to 8 characters is the collection name for array archive data for this station The name entered must be the file base name of this station s array archive files as created by the Harvester Collector or Scheduler is the name of the signal list collection file either Real Time List or Configuration List for this station The name entered must be the file base name of this station s list files as created by the Harvester Collector or Scheduler is the name of the audit trail collection for this station The name entered must be the file base name of this station s audit trail files as created by the Harvester Collector or Scheduler Note If this is a multi run unit and you intend to export to Flow Cal using the COASTAL DLL the audit_collection_name should be entered for only one of the stations for that unit
40. 3 Headquarters Emerson Process Management Remote Automation Solutions 6005 Rogerdale Road Houston TX 77072 U S A T 1 281 879 2699 F 1 281 988 4445 www EmersonProcess com Remote Europe Emerson Process Management Remote Automation Solutions Unit 8 Waterfront Business Park Dudley Road Brierly Hill Dudley UK DY5 1LX T 44 1384 487200 F 44 1384 487258 Remote Automation Solutions a business unit of Emerson Process Management shall not be www EmersonProcess com Remote liable for technical or editorial errors in this manual or omissions from this manual REMOTE AUTOMATION SOLUTIONS MAKES NO WARRANTIES EXPRESSED OR IMPLIED INCLUDING THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE WITH RESPECT TO THIS MANUAL AND IN NO EVENT SHALL REMOTE AUTOMATION 2013 Remote Automation Solutions a business unit of Emerson Process Management All rights reserved North American Latin America Emerson Process Management Remote Automation Solutions 6005 Rogerdale Road SOLUTIONS BE LIABLE FOR ANY INCIDENTAL PUNITIVE SPECIAL OR CONSEQUENTIAL Houston TX USA 77072 DAMAGES INCLUDING BUT NOT LIMITED TO LOSS OF PRODUCTION LOSS OF PROFITS LOSS T 1 281 879 2699 F 1 281 988 4445 OF REVENUE OR USE AND COSTS INCURRED INCLUDING WITHOUT LIMITATION FOR CAPITAL www EmersonProcess com Remote FUEL AND POWER AND CLAIMS OF THIRD PARTIES Middle East Africa Bristol Inc Bristol Canada BBI SA de CV and Emerson Process M
41. 30 errors Monitor Size 1 40 messages Copy Path C PROGRAMDATA BRISTOL Station Interval f seconds Cancel Help Time Interval specifies the interval in seconds at which the Data File Conversion utility will check to see whether Collector Scheduler Harvester data files exist which require conversion This interval must be short fast enough to prevent files from being used up See IMPORTANT note below IMPORTANT No more than 99 999 for Harvester data files of a given file type are saved for a given collection name node name Once they have been used data will wrap around and overwrite the existing files IT IS THE RESPONSIBILITY OF THE USER TO RETRIEVE DATA BY USING THE DATA FILE CONVERSION UTILITY BEFORE THESE FILES ARE OVERWRITTEN OTHERWISE IMPORTANT DATA MAY BE LOST Using the Data File Conversion Utility ADD 4 Addendum to D5082 D5083 D5120 Error History Buffer Size Monitor Size Copy Path Station Interval specifies the number of errors which may be saved in each station s dedicated error history buffer Any change to this parameter will cause the Error History to be cleared losing all previous error messages defines the number of status messages which may exist in the monitor area at any one time specifies the file path where the original unconverted data files should be copied after conversion exporting has been completed This is to prevent them from being re used during the next file co
42. All stations representing other runs for the same unit should leave the Audit field blank Using the Data File Conversion Utility ADD 8 Addendum to D5082 D5083 D5120 Click on the OK push button to save changes and exit the Station Data dialog box The station data will appear in the Station File Configuration dialog box Station File Configuration Ed el Use the list below to create stations and associate them with files collected with the Harvester tool Station Aray Archive RPC1 RPCIARCH RPCILIST RPCIAUD a Modify Delete Cancel OK Exiting the Station File Configuration Dialog Box Click on OK to save changes and exit or click on Cancel to discard the changes and exit To View Modify A Station Configuration In the Station File Configuration dialog box select the name of the station you want to modify then click on the Modify button or just double click on the selected station name The Station Data dialog box will re appear and you can edit the station s associated collection file names Make any changes and click on the OK push button to save changes and exit the Station Data dialog box or click on Cancel to discard the changes Note Once defined the station name cannot be modified To Delete A Station Configuration In the Station File Configuration dialog box select the name of the station you want to delete Click on the Delete push button you will be prompted to confirm that
43. C Confawe Data Source Administrator and click on the Add button Set Directoy An ODBC File data source allows you to connect to a data provider File DSNs can be shared by users who have the same drivers installed Cancel Apply Help Create New Data Source xj Select a driver for which you want to set up a data source Microsoft FoxPro VFP Driver dbf Microsoft ODBC for Oracle Microsoft Paradox Driver db Microsoft Paradox T reiber db Microsoft Text Driver txt csv Microsoft Text Treiber txt csv Microsoft Visual FoxPro Driver Microsoft Visual FoxPro Treiber The Create New Data Source dialog box will appear Scroll though the list of drivers until you locate SQL Server then select it and click on the Next button VO fee eM lt Back Cancel Addendum to D5082 D5083 D5120 ADD 71 Using the Data File Conversion Utility Create New Data Source e x Type the name of the file data source you want to save this connection to Or find the location to save to by clicking Browse kawcosn Browse Enter the name of the file data source then click on Next NOTE This name must match the name entered previously in the Select File DSN field on the Data Source page of the EXBBODBC DLL Setup Dialog Box lt Back Cancel Create New Data Source x When you click Finish you will create the data source whi
44. Delete To create a common list click on the Add List button The Enter Common List Number dialog box will appear Enter a number which will identify the common list then click on OK 15 OpenBSI Harvester Defining Common Lists That list number will now appear in the List window on the left side of the Common List Configuration dialog box Click on it and then click on either the Insert After or Insert Before buttons to begin inserting signal names in the list The Enter Common List Enter Common List Signal Name Signal Name dialog box will appear Enter the name of the METER_NUMBER first signal of the list and Cancel click on OK That signal name will now appear in the Signals window on the right side of the Common List Configuration dialog box Repeat this process using the Insert After button to insert additional signals in the list NOTE The signal names and ordering of signals must match exactly the corresponding signals in the controller s signal list The common list you define can be used later when you are defining a Signal List collection in the Collection Configuration dialog box Changing a signal Name already in a Common List To change the signal name of a signal already in the list click on the signal then click on the Modify button The Enter Common List Signal Name dialog box will re appear and you can edit the signal name Deleting a signal Name already in a Common List To de
45. NRT to each controller This prevents a loss of time synchronization between the PC and controllers C 1 OpenBSI Harvester Appendix C Sample ACCOL Task for Radio Control 190 ENDIF Later after various checking is performed the radio is actually activated using the Turn DTR ON feature of the Portstatus module 30 C CHECK TO SEE IF REQUIRED TO BE ON 40 IF RADIO ACTIVE 50 MASTER RADIO MODE 5 60 ENDIF 330 PORTSTATUS PORT MASTER PORT MODE MASTER RADIO MODE STATUS MASTER RADIO STAT Modes of Operation This ACCOL task supports 5 different modes of operation Most of the modes also include user defined setpoints which are fed into Timer Module logic to determine how long the radio stays ON Each mode is summarized briefly in the table below Local Turn ON Mode This mode is enabled by turning ON the signal RADIO LOCAL ENBL This mode allows the radio to be activated manually by an operator using a keypad device The signals LOCAL TIME SP and LOCAL TIMOUT SP are used to define the length of the ON time and timeout periods for this mode Daily Turn ON Mode This mode supports turning on the radio daily and is enabled by setting valid values on the DAY HOUR DAY MIN and DAY SEC signals These turn ON time values are checked against the TIME 005 hours TIME 006 minutes and TIME 007 seconds system signals respectively The signals DAY TIME SP and DAY TIMOUT SP are used to define the length of the ON time
46. OL OUTPUT 320 CALCULATOR L0 3 SET MODE COMMAND STATE FOR RADIO OFF 20 MASTER RADIO MODE 6 302 SE CHECK TO SEE IF REQUIRED TO BE ON 40 IF RADIO ACTIVE 50 MASTER RADIO MODE 5 60 ENDIF 330 PORTSTATUS PORT MASTER PORT MODE MASTER RADIO MODE STATUS MASTER RADIO STAT OpenBSI Harvester C 6 Appendix D Harvester Database Tables The Harvester uses several database tables for storing configuration information These tables can optionally be read from written to by third party applications specifically written for this purpose System Information Table The System Information Table contains information about the overall configuration of the Harvester calculation parameters for the scan interval and directory paths Field Name Data Type Version Number Version of the Harvester Database This controls updates to CE l tables on new releases Scan Number User configured scan interval in seconds er a Nodes Stagger Number When this number of nodes is active Stagger Mode is PE De The number of seconds to delay after the calculated ON time Delay Start Time Number Offset in seconds into the Scan Interval when polling should Offset start Node Poll The time required in seconds to collect data from a node Time Group Poll The Offset in seconds to separate EBSAP groups throughout Time the interval File Storage Text The directory path in which the Harvester will store data files collected fr
47. OpenBSI Harvester the Data Collector does not generate these files Information on naming conventions of files created by the Scheduler Data Collector or Harvester as well as information on the directories used to store these files are included respectively in the OpenBSI Scheduler Manual document D5082 the OpenBSI Collection Export Utilities Manual document D5083 and the OpenBSI Harvester Manual document D5120 10 f exporting is currently in process edits cannot be made in this dialog box Using the Data File Conversion Utility ADD 12 Addendum to D5082 D5083 D5120 Next with all exporting stopped the CSV comma separated variable DLL must be highlighted by clicking on it in the Export DLLs list box of the Data File Conversion Export DLLs Selected DLLs Setup dialog box It is then moved to the Selected DLLs list box by clicking on the Select gt push button Parameters Files Export Libraries lt Deselect Now click on the Configure push button to call up the CSV Export DLL Configuration Add New DLL _Configue dialog box dialog box complete the fields described below then click on the OK push button Directory for CS files This causes the changes to be read by the esada Data File Conversion Utility i Then click on OK to exit the Data File V Include Header in CSV Array Files Header Text Local Time Floating Point Format Conversion Setup dialog box Final
48. R STATION This will appear in the Harvester Node Information window Only the first 64 characters you enter will be displayed as the description Flags Disable Collections When checked the Harvester will NOT attempt to make any collections from this controller This would typically be checked if a controller has been temporarily taken out of service for repairs or if there are communication problems which must be fixed prior to attempting collections Skip Historical Collections When checked the Harvester will NOT attempt to perform an on First Pass initial array archive collection on startup Instead it will wait for the next calculated interval Turn Off Polling after Normally if communications with a particular controller are via a Collections dial up modem or radio as soon as the Harvester completes its collections polling would be turned off and the modem would be 19 OpenBSI Harvester Adding a Controller and Configuring Collections Write to Station File Communications Signals Communications Off Signal Maintenance Mode Signal Force List Collection Signal ControlWave Security Username Password Modem Control hung up because there is no reason to continue requesting data If this box is NOT checked however polling will continue even after a collection has been completed This can be useful if the controller has a direct cable connection i e it is always connected When checked w
49. RE 09 OCT 2006 09 45 00 0 TEMPERATURE 09 OCT 2006 09 45 00 0 FREQUENCY 09 OCT 2006 09 45 00 0 Audit Files Typical contents of an audit PI Database file are shown below AudTag 01 1 12 OCT 2006 14 01 31 Date Timestamp for first record AudTag 02 1 SYSTEM TIME Signal or Event Name for first record AudTag 03 1 Descriptor for first record AudTag 04 1 333 Global Sequence number for first record AudTag 05 1 1014 Local Sequence number for first record AudTag 01 2 12 OCT 2006 14 51 37 Date Timestamp for second record AudTag 02 2 SYSTEM TIME Signal or Event Name for second record AudTag 03 2 Descriptor for second record AudTag 04 2 334 Global Sequence Number for second record AudTag 05 2 1037 Local Sequence Number for second record AudTag 01 3 12 OCT 2006 15 41 45 Date Timestamp for third record AudTag 02 3 SYSTEM TIME Signal or Event Name for third record AudTag 03 3 Descriptor for third record AudTag 04 3 335 Global Sequence Number for third record AudTag 05 3 1063 Local Sequence Number for third record Format of List File The format of a typical list PI Database file is shown below Using the Data File Conversion Utility ADD 50 Addendum to D5082 D5083 D5120 LIST_0 00 1 GV R1_VOLUME_ACCUM Variable sig name for list element 1 LIST_0 01 1 0 Value of list element 1 LIST_0 00 2 GV R1_ENERGY_ACCUM Variable sig name for list element 2 LIST_0 01 2 0 Value of list element 2
50. Retries Per Pass This specifies the total number of attempts the Harvester will make to collect data from this controller on a given collection pass A retry occurs if there is a communication timeout Special Parms Reset after Collection If checked once audit records have been collected by the Harvester they will be deleted from the controller 1 Prior to OpenBSI 5 6 Service Pack 1 Harvester would collect all available audit records whether or not they had been collected earlier unless the audit buffer had been reset using the Reset after Collection option to delete records already collected OpenBSI Harvester 28 Adding a Controller and Configuring Collections Defining Modifying a Signal List Collection Complete the fields as described below then click Collection Configuration on OK Collection Type Signal List ltem Number fo NOTE Signal lists collected via the Harvester Flags cannot have more than 1000 signals Collection Type Item Number Flags Disable Communications Max Retries Per Pass Special Parms Common List Number Collect via Common List Disable Communications Max Retries Per Pass Special Parms Common List Number Collect via Common List This must be set to Signal List This is the number of the signal list When checked will stop this collection from occurring This specifies the total number of attempts the Harvester will make to coll
51. SN contains details about how data collected from Harvester data files should be exported to an external database If you have already configured a DSN file click on this button and specify the path and filename of the DSN file associated with your database or use the Browse button to locate the file If the DSN filename you specify does NOT exist the DLL will create a Microsoft Access database and display an MDB filename with the same basename as the DSN in this field Select User System DSN If you have an existing ODBC compliant database created with some external application and you would like to use it with the EXBBODBC DLL you must first use the Windows ODBC Administrator software to generate a Data Source Name DSN user system entry for it Then click on the Select User System DSN button and select that entry from the list box Compact Database After Over time the database can become fragmented To de fragment n passes the database and thereby save on disk space select the Compact Database check box and enter the number of passes between compactions See the Time Interval field on the Parameters page of the Data File Conversion Setup dialog box to see how often a conversion pass occurs Using the Data File Conversion Utility ADD 24 Addendum to D5082 D5083 D5120 Configure Schema The Configure Schema push button calls up the Data Storage Configuration utility to allow you to configur
52. Stations To do this click on this button and select the station configuration you want to apply to the current station you will be prompted to confirm this since it will overwrite any entries already made for the current station Logging Page The Logging page allows you to PGAS Export DLL Configuration specify whether logs should be kept of ssu Logona securty PGAS Export operations Log files are p s useful primarily for debugging purposes Folder for Log Files c ProgramData Bristo Open8sh BOSE I Delete Log Files at Startup IT Log Warnings To set up logging check the Enable Logging box then use the Browse button to identify the folder on the PC where log files should be stored You cancel tony Help can then specify various options for the logging I Log Path of Execution for debugging The fields are discussed in more detail below Addendum to D5082 D5083 D5120 ADD 59 Using the Data File Conversion Utility Enable Logging Check this box to activate the logging feature Folder for Log Use the Browse button to specify the location on the PC where PGAS log files should be stored Log files have the base name of the station name with the extension of log Delete Log Files at Startup If checked any existing log files are deleted whenever the Data File Conversion Utility is started Log warnings If checked any warning messages generated by the PGAS Export DLL
53. TIM E2 time2 STARTTIM E3 time3 STARTTIM E4 time4 where config_time monitor_time rtu_time demand_time station is the rate in milliseconds at which the configuration pane on the right hand top of the window is updated is the default rate in milliseconds at which the monitor pane of the window is updated is the default rate in milliseconds at which the tree of RTUs pane of the window is updated is the default rate in milliseconds at which the Harvester will check for an on demand request for data when set to T will write RTU configuration data to the station file E 1 OpenBSI Harvester Appendix E Harvester Initialization Files broadcast if set to 1 broadcasts a message at the start and end of a collection critical while the Harvester is normally considered to be a critical message exchange mex thereby preventing OpenBSI from being shut down When this is set to 0 however Harvester is not considered critical and so OpenBSI can be shut down silent when set to 1 will allow the Harvester to be closed without a confirmation prompt In addition when set to T Harvester startup will be in a minimized state enable set to T to activate debug mode or 0 to turn off debug mode In Debug mode the contents of the monitor window is written to the file harv_log txt in the ProgramData Bristol OPENBSI directory interval is the default interval used w
54. TION 170 CALCULATOR LO sE CHECK FOR KEYPAD SENSE OF OPERATOR 20 IF RADIO LOCAL ENBL 30 IF KEYPAD STATE 40 C KEYPAD SENSOR ON TURN ON LOCAL REQUEST TURN OFF KEYPAD 50 RADIO LOCAL REQ 0ON 60 KEYPAD STATE 0FF 70 ENDIF 80 ENDIF 180 C RADIO COMMANDED ON CHECK TIMEOUT 190 C CHECK OF DATA REQUESTS 200 PORTSTATUS PORT MASTER PORT MODE STATUS MODE LIST COMMSTAT LIST 210 C DETERMINE WHAT SETPOINT TO USE 220 CALCULATOR 10 C CHECK FOR POLLS FROM THE MASTER IS COMM ESTABLISHED 20 COMMSTAT TRIG COMMSTAT POLL COMMSTAT POLL LAST COMMSTAT RX COMMSTAT RX LAST RADIO LOCAL REQ RADIO MAINT REQ RADIO DAY REQ RADIO HOUR REQ 30 COMMSTAT POLL LAST COMMSTAT POLL 40 COMMSTAT RX LAST COMMSTAT RX OpenBSI Harvester C 4 Appendix C Sample ACCOL Task for Radio Control 50 60 70 80 90 100 110 120 130 140 150 160 170 180 190 200 210 220 230 240 250 260 270 280 290 300 RADIO RADIO RADIO RADIO RADIO ELSEIF RADIO RADIO RADIO RADIO RADIO ELSEIF RADIO RADIO RADIO RADIO RADIO ENDIF 230 ENDIF 240 C 250 C 10 END CHEC IF ae CHECK FOR TURN ON REQUEST BY PRIORITY IF RAD RADIO RADIO RADIO RADIO RADIO ELSEIF IO LOCAL REQ TIME SP LOCAL TIME SP IMOUT SP LOCAL TIMOUT SP IMER TRIG 0N IMER RSET 0N OCAL REQ 0FF RADIO MAINT REQ TIME SP MAINT TIME SP TIMOUT SP MAINT TIMOUT SP
55. User Manual Document D5120 Part D301421X012 May 2013 OpenBSI Version 5 9 OpenBSI Harvester Manual Remote Automation Solutions S EMERSON www EmersonProcess com Remote IMPORTANT READ INSTRUCTIONS BEFORE STARTING Be sure that these instructions are carefully read and understood before any operation is attempted Improper use of this device in some applications may result in damage or injury The user is urged to keep this book filed in a convenient location for future reference These instructions may not cover all details or variations in equipment or cover every possible situation to be met in connection with installation operation or maintenance Should problems arise that are not covered sufficiently in the text the purchaser is advised to contact Emerson Process Management Remote Automation Solutions for further information EQUIPMENT APPLICATION WARNING The customer should note that a failure of this instrument or system for whatever reason may leave an operating process without protection Depending upon the application this could result in possible damage to property or injury to persons It is suggested that the purchaser review the need for additional backup equipment or provide alternate means of protection such as alarm devices output limiting fail safe valves relief valves emergency shutoffs emergency switches etc If additional information is required the purchaser is advised to contact Remote Automation So
56. Using the Data File Conversion Utility ADD 82 Addendum to D5082 D5083 D5120 Table Definition Dialog Box The Table Definition dialog box is accessed by clicking on a table name in the Table Definitions list box of the Schema Definition dialog box and then clicking on either the New or Modify push buttons Table Definition x Table Name ToTALs Cancel ma STATION STRING 0 Help DATETIME DATETIME 1 GSN ANALOG 2 T l Import Table ANALOG 5 LEVEL ANALOG 6 FAILURES ANALOG 7 Insert Remove Modify UGl Records Coum N ame Column Data Type Feld omber FLOW ANALOG 7 f I Designate Column as Primary Key V Generate Field Numbers Automatically There are two basic methods to define a table One way is to create an all new table and define its individual columns This is the recommended method if you are using the Extended Access DLL EXBBODBC DLL The other method required when using the OEEXP DLL is to import an existing table from a database and use its pre defined columns If you are using the OpenEnterprise Export DLL OEEXP DLL you MUST import the table definitions from your historical portion of your OpenEnterprise Database Because of this you must have already configured both the real time and the historical portion of your database before you attempt to configure station schema Addendum to D5082 D5083 D5120 ADD 88 Using the Data File Conversion Utility Method 1 To Define Column s of th
57. Y TURN ON HOUR SEC SEC OF MIN FOR HOURLY TURNON RADIO DLIGHT STRT START HOUR OF DAY LIGHT RADIO DLIGHT END END HOUR OF DAY LIGHT OpenBSI Harvester C 3 Appendix C Sample ACCOL Task for Radio Control RADIO HOUR ENBL ENABLE SIGNAL FOR HOURLY TURN ON 130 CALCULATOR 10 C CHECK TO SEE IF TIME OF DAY ENABLE 20 IF RADIO DLIGHT ENBL 30 C IF DAYLIGHT THEN CHECK TIME OF DAY FOR ENABLE OF HOURLY COMM 40 IF TIME 005 gt RADIO DLIGHT STRT amp TIME 005 lt RADIO DLIGHT END 50 RADIO DLIGHT OK 0ON 60 ELSE 70 RADIO DLIGHT OK 0OFF 80 ENDIF 90 ELSE 100 C DAY LIGHT NOT ENABLED THEREFORE ALWAYS OK 110 RADIO DLIGHT OK 0ON 120 ENDIF 130 C DAYLIGHT TEST DONE CHECK FOR HOURLY TURN ON 140 IF RADIO DLIGHT OK 150 C CHECK IF MIN AND SECOND START RADIO 160 LF TIME 007 HOUR SEC amp TIME 006 HOUR MIN 170 IF RADIO HOUR ENBL 180 RADIO HOUR REQ 0N 190 ENDIF 200 ELSE 210 RADIO HOUR REQ 0OFF 220 ENDIF 230 ENDIF 140 C CHECK TO SEE IF TIME FOR DAY ONCE PER DAY AS DEFINED BY DAY HOUR DAY MIN DAY SEC 150 CALCULATOR 10 C CHECK TO SEE IF TIME TO TURN ON ONCE PER DAY COMMAND 20 C TO ELIMINATE DAILY POLL MAKE DAY HOUR gt 24 30 IF TIME 007 DAY SEC amp TIME 006 DAY MIN amp TIME 005 DAY HOUR 40 RADIO DAY REQ 0ON 50 ELSE 60 RADIO DAY REQ OFF 70 ENDIF 160 C CHECK TO SEE IF LOCAL USER RADIO LOCAL ENBL MUST BE ON FOR LOCAL SELEC
58. a File Conversion Utility Fields in the EXBBODBC DLL Setup Dialog Box General Page EXBBODBC DLL Setup i x Data Source ErorLog General m Record Information IV Use All Aray Record s fields JV Ignore mapping of non existent array record fields Floating Point Format Cancel Help Use All Array When checked this field enforces a requirement that there must be Record s fields an exact match between the number of fields in the array record and number of columns in the database When unchecked the number of array columns need NOT match the number of fields in the database Ignore mapping of non When this button is checked any mapping between non existent existent array record array record fields and table columns that was set up by the Data fields Storage Configuration Utility will be ignored This button should be checked if you want to use the same table definition for arrays whose records are different sizes and are exported to the same table in the database Floating Point Format Calls up the Change Floating Point Format dialog box to allow you to specify the floating point precision used to display array archive exported data See Using the Floating Point Format dialog box earlier in this section When you have finished defining your database name configured its schema via the Data Storage Configuration utility etc click on the OK push button to save changes or the Cancel push b
59. a File Conversion Utility searches for Collector Scheduler Harvester data files that should be converted If it finds such files the utility converts the files into one or more specified file formats by calling sets of special export filters called dynamic link libraries DLLs The utility comes with several DLLs to choose from If errors occur during the conversion process error messages will appear in a window on the screen Optionally the data which caused the errors may be saved in an error recovery database to allow for a later conversion attempt to be made How Is the Data File Conversion Utility Configured The configuration process varies somewhat depending upon whether you are using the Data Collector Scheduler or Harvester and which software package s you will be exporting data to Changes to the configuration of the utility require all exporting to be stopped and then re started for the changes to take effect Once the Data File Conversion Utility DLL and related configuration is complete and the export process has been activated data conversions occur automatically and are essentially transparent to the user There are six major steps involved in configuring this utility Step 1 Start the Data File Conversion Utility In order to configure the various parameters of this utility it must be running See Starting the Data File Conversion Utility for details Step 2 Specify Initialization Parameters In al
60. ables Statements appearing in italics are comments Create the source table OEEXP DLL will insert update audit records in this table for logging them in the historical database create table audit_event_source PERSISTENT PRIMARY KEY station station char eventtimestamp datetime signal_name char remote_event char Create a stream for monitoring of data in the source table insert into oelogcontrol id source namecolumn enable values 2 audit_event_source station true commit Set up the columns of the source table to be monitored insert into oelogcolumn control name type sourcecolumn values 2 eventtimestamp 0 eventtimestamp insert into oelogcolumn control name type sourcecolumn values 2 signal_name 0 signal_name insert into oelogcolumn control name type sourcecolumn values 2 remote_event 0 remote_event commit Determine how often audit events should be retrieved from the stream insert into oelogdata rate control buffercount buffersize archdirectory archbuffercount values Os 2 10 1024 c histfiles 9 commit Create the Access table Addendum to D5082 D5083 D5120 ADD 48 Using the Data File Conversion Utility update OELogControl set raw dest_table where id 2 commit Example 3 The following SQL DDL and DML statements provide an example of the steps that have to be performed in order to configure the historical componen
61. ach node collected and so on This effectively staggers collections over Number of Nodes to skip in Stagger Mode 1 scan intervals When and if the Harvester catches up and has collected all data not collected on previous passes it will return to its normal collection method as defined by the scan interval Setting Number of Nodes to skip in Stagger Mode to 0 effectively prevents the use of stagger mode If when attempting to dial a busy signal is encountered this is the number of dial retry attempts which will be made This is the length of time in seconds between dial retry attempts DIALING APPLICATION NOTE If you have multiple controllers multi dropped on the same dial up line once OpenBSI has successfully connected to the first node you can configure it to also continue to poll in sequence all other nodes on that same dial up line To do this you must set the SpecialDial parameter in the BSBSAP INI initialization file to 1 OpenBSI Harvester Monitoring the Status of Your Collections Monitoring the Status of Your Collections The right hand side of the Harvester main window displays information about the status of collections Simply click on a node s icon in the tree on the left and its corresponding collection status information will appear in the right window pane lick on a node to see information on the status of its collections Harvester File Edit View Help BBB wav o amp Co
62. ad supplemental document 14006 for proper care and handling of ESD sensitive components OpenBSI Harvester Manual Contents Introduction What is the Harvester 1 What types of data can be collected sssccsssssssssccsssscssssssessccssssesssscsssesssssnssseses 1 What determines how often data is Collected ccccccccccccssssscssssccccccsccsscssscssooes 2 What happens to the data once it is collected sooesooessoesscesssccssocssocsccocesseessecesoses 2 Overview of Steps Which Must be Completed to Successfully Use the Harvester 3 Installing the Software 5 Configuring Your Controller to Work with the Harvester 6 EGM 3530 10A EGM 3530 50A TeleFlow UsSerS e soesesocsoesesccscssesocssesosscssesossoe 6 DPC 3330 DPC 3335 RTU 3305 RTU 3310 3530B series GFC 3308 COMEEOT VY BVO Ust Ssusse a aA 6 Data Arrays ccc daneine une 7 Storage without Wrapping Push Down Array eesssessssecssecssocssocssoocsssecssecesocesooseo 7 Storage with Wrapping Wrap Array ccsccssssccssssccssssscsssscsssssssesssssssssssesessssesseses 8 Storage in Wrap Multiple ArTAyS cniscncninanunimnionnnniiniemaneinieanaes 9 Raw Array ssssssiciiinbiscssiossscs sosssoisontsddabbko ddod ne been 10 Archive PIGS ccincunncnwneneee eine 10 EAudit Module Audit Function Block sscccssssssssssssssscsssssccccssssscccsssscccccssssccsssssscees 11 Signal Lists Configuration Signal List ccs ccsiccss cess
63. ade in the Data Storage Configuration Utility for improper mapping An error occurred while trying to create a table based on an incorrect table definition A previous error may indicate the source of the problem The UOI record array archive audit list data has more fields than the number of columns in the table Edit the database table to include the correct number of columns Using the Data File Conversion Utility Viewing and or Deleting Entries From the Error Recovery Database If the Error Recovery Database files were loaded during system installation then data which cannot be converted is saved in the database and the utility will automatically attempt to convert it during another conversion export cycle Occasionally users may want to view entries in the Error Recovery Array Database x database to see what entries weren t converted or they may want to purge some data entries from the Tables J Confirm deletion database so further attempts at converting them will BOILER681 Delete Tables be abandoned To do this click on Database in the BOILERE AL BOILER631 HPPREHEAT1 menu bar and choose either Array Audit or STESMGEN1 OK List from the pull down menu The Error Recovery Database dialog box for that type of data will appear Viewing Entries The Error Recovery Database is organized into tables Use the Tables list box to select which table you want to view Tables are named afte
64. adio may be turned OFF This is part of normal Harvester communications and is handled by the signal RADIO RESET REQ This signal must also be defined in the Harvester as the Communications OFF Signal ACCOL Task Code TASK 6 10 C THIS TASK IS TO CONTROL THE RADIO VIA THE DTR SIGNAL ON THE NETWORK PORT PORT C THE SIGNAL RADIO ACTIVE CONTROLS THE PORT STATUS MODULE THE SIGNAL RADIO TIMER RSET IS USED TO TURN OFF RADIO 20 C THE PORT IS CONTROLLED VIA A TIMER SO THAT IF THERE IS NO COMMUNICATION TO THE UNIT THE RADIO IS THEN TURNED OFF 30 SC CHECK TO SEE IF TIME TO CALCULATE HOURLY AND DAILY ENABLE TIMES 40 IF NODE CALC 50 C DETERMINE NODE OFFSET COLLECTION TIME SECONDS PAST HOUR NODE ADDR 1 26 GROUP 5 OFFSET NOTE GROUP ADDR GROUP MUST BE MANUALY CONFIGURED 60 CALCULATOR 10 IF NODEADR 127 20 NODE TIME NODEADR 1 26 GROUP ADDR 5 60 30 HOUR MIN INT NODE TIME 60 40 HOUR SEC NODE TIME 60 HOUR MIN 50 DAY MIN HOUR MIN 60 DAY SEC HOUR SEC 70 NODE CALC 0FF 80 ENDIF 70 ENDIF 80 C CHECK FOR TIMER TRIGGER SIGNAL IF ON THEN SKIP HOUR TESTS AND TURN OFF TRIGGER TO ALLOW FOR RE TRIGGER OF TIMER 90 IF RADIO TIMER TRIG 100 CALCULATOR RADIO TIMER TRIG 0FF 110 ELSE 120 C CHECK FOR TIME OF HOUR TURNON WITH DAYLIGHT OPTION SIGNALS RADIO DLIGHT ENBL ON IF ACTIVE ONLY DURING DAYLIGHT HOURS HOUR MIN MINUTE FOR HOURL
65. al maint_mode_sig Force_List_Signal force_list_sig Modem_Req_Signal modem_req_sig Modem_Confirm_Signal modem_confirm_sig Modem_Retries retries Modem_Wait wait_time Scan_Type scantype Interval interval Interval_Units interval_units Interval_Offset interval_offset Start_Coll_Date start_date User_Time_1 user_timel OpenBSI Harvester E 3 Appendix E Harvester Initialization Files User_Time_ 2 user_time2 User_Time_10 user_timel0 Collection1l coll_ 1 Collection2 coll_ 2 Collectionn coll_n Network network_name RTUType type Local_Addr local_address Prim_IP aaa bbb ccc ddd Pred node Sec_IP eee fff ggg hhh MsgTmo timeout Load filename Dial dial_string WebPage startup_page Alarm Dest1 aaa bbb ccc ddd Alarm Dest2 eee fff ggg hhh AlarmDest4 mmm nnn ooo RBEDest1l aaa bbb ccc ddd RBEDest2 eee fff ggg hhh RBEDest4 mmm nnn ooo ppp FailType ip_fail_choice TS_Disable toggle Comm_Direct proxydirect Coll_n Type collection_type Item item_num Disable disable View_Timestamp show_timestamp Max_Retry num_attempts Max_Rows max_rows Collect_Al max_coll Audit_Reset delete_records Push_First number Common_List list_number Wrap_Number num_arrays OpenBSI Harvester E 4 Appendix E Harvester Initialization Files where RTU_x x is an integer referring to which RTU definition is being added or deleted For the first RTU definition in the file x would be 1 for the second definition in the file it would be 2 etc
66. allowing you to change the entry If checked the start date will be included in the XML file The timestamp for archive records in a file can represent the moment the record was stored in the file i e At Store or they can represent the start of the interval over which the data was collected i e Start of Period Choose one of these based on your system requirements If you have multiple stations for which you want to have similar configurations click on this button In the Station Selection dialog box hold down the Ctrl key and select all the stations for which you want to set up a common configuration then click on OK and the configuration of the station will be applied to all of the selected stations which you can then modify as needed From the list below select the stations that will be configured as the current selected station Hold down the Ctrl key to select multiple stations Available Stations RPC2 RPC3 OK Cancel Using the Data File Conversion Utility ADD 58 Addendum to D5082 D5083 D5120 Import Configuration From Station If you have already configured a station which has a configuration similar to the one you are creating you can apply that station s configuration for the current station You can then modify the station as needed From the list below select the station whose Tag Lookup File Configuration will be applied to current selected station Available
67. ame then click on the Modify push button In either case the Table Definition dialog box will appear from which you can create or modify a table See Table Definition Dialog Box later in this addendum for details To delete a table click on the table name then click on the Delete push button This section of the dialog box lets you specify which of the tables previously defined via the Table Definition dialog box will hold array archive data for this station To specify the table click on the table s name in the Table Definitions list box then click on the gt gt push button To remove the table currently shown in the Array Archive section click on the X push button This section of the dialog box lets you specify which of the tables previously defined via the Table Definition dialog box will hold audit trail data for this station To specify the table click on the table s name in the Table Definitions list box then click on the gt gt push button To remove the table currently shown in the Audit section click on the X push button This section of the dialog box lets you specify which of the tables previously defined via the Table Definition dialog box will hold signal list data for this station To specify the table click on the table s name in the Table Definitions list box then click on the gt gt push button To remove the table currently shown in the List section click on the X push button
68. anagement Ltd Remote Emerson Process Management Automation Solutions UK are wholly owned subsidiaries of Emerson Electric Co doing Remote Automation Solutions business as Remote Automation Solutions a business unit of Emerson Process Management Emerson FZE FloBoss ROCLINK Bristol Bristol Babcock ControlWave TeleFlow Helicoid OpenEnterprise P O Box 17033 and METCO are trademarks of Remote Automation Solutions AMS PlantWeb and the Jebel Ali Free Zone South 2 PlantWeb logo are marks of Emerson Electric Co The Emerson logo is a trademark and service Dubai U A E mark of the Emerson Electric Co All other marks are property of their respective owners T 971 48118100 F 971 4 8865465 The contents of this publication are presented for informational purposes only While eve www EmersonProcess com Remote p P peP y 2 effort has been made to ensure informational accuracy they are not to be construed as Asia Pacific warranties or guarantees express or implied regarding the products or services described Emerson Process Management herein or their use or applicability Remote Automation Solutions reserves the right to modify Remote Automation Solutions or improve the designs or specifications of such products at any time without notice All sales 1 Pandan Crescent are governed by Remote Automation Solutions terms and conditions which are available Singapore 128461 upon request Remote Automation Solutions does not assume responsibility
69. and timeout periods for this mode Hourly Turn ON Mode This mode is the normal method of communication with the Harvester as discussed above under Turn ON Logic Highlights This mode is enabled by turning ON the signal RADIO HOUR ENBL The actual turn ON time is defined in the signals HOUR MIN and HOUR SEC The signals HOUR TIME SP and HOUR TIMOUT SP define the length of the ON time and timeout periods for this mode A daylight hours mode option is also provided This option is enabled by turning ON the signal RADIO DLIGHT ENBL When ON this mode limits the Hourly Turn ON Mode to hours between the value of RADIO DLIGHT STRT and RADIO DLIGHT END If the time of day in hours as indicated on the system signal TIME 005 is not between those two values Hourly Turn ON Mode will be disabled OpenBSI Harvester C 2 Appendix C Sample ACCOL Task for Radio Control Maintenance Mode Maintenance Mode allows a radio to be left ON for longer than the normally scheduled time period This may be useful during radio maintenance or system debugging This mode is enabled by the operator by turning ON the signal RADIO MAINT REQ This signal must also be defined in the Harvester as the Maintenance Mode Signal The signals MAINT TIME SP and MAINT TIMOUT SP define the length of the ON time and timeout periods for this mode Radio Turn OFF Mode This mode allows the Harvester to notify the controller that it has finished collecting data and that the r
70. at it has finished collecting data for this scan interval This can trigger user defined logic which turns OFF the radio Maintenance Mode Signal This signal is set ON by the Harvester monitor as a notification that the radio should not be turned OFF even if no collections are currently occurring This might be done so maintenance or testing can be performed Force List Collection Signal This signal is set ON by user defined logic in the program as a notification to the Harvester that the configuration list has changed somehow and so it should be re collected by the Harvester This signal MUST be designated for audit trail collection via the EAudit Module or AUDIT function block Modem Control Signals If the Harvester is collecting data from a slave controller which communicates to its master controller in the network via a dial up modem the master must have a pair of logical boolean signals for modem control One signal is turned on by the Harvester Request signal to signify that the master controller should dial up its slave controller The second signal Confirm signal is turned on by the master controller to indicate that the dial up connection with the slave node has been established thereby signifying to the Harvester that collections can begin 13 OpenBSI Harvester Starting the Harvester Starting the Harvester In order to start the Harvester communications with the controller network must already be active via Ne
71. ay be viewed in the upper area of the Data File Conversion Utility window Errors are displayed in the order in which the stations appear in the Station File Configuration dialog box The size of the error history buffers is determined based on the Error History Buffer Size value in the Data File Conversion Setup dialog box 4Before attempting to start the export process one or more Export DLLs must have already been selected from the Export Libraries page of the Data File Conversion Setup dialog box 25Any changes to this value will clear the Error History entries from the screen and delete all messages from the Error History buffers Therefore this value should only be changed after you have viewed all of the current errors Addendum to D5082 D5083 D5120 ADD 65 Using the Data File Conversion Utility Error messages appear as follows date time station_name_ error_text export_adll where date is the date the error occurred time is the time the error occurred station_name is the station which had the error error_text is a description of the error export_dll is the first 3 letters of the name of the DLL which had the error It is one of the following BBO BBODBC COA Coastal CSV EXB EXBBODBC PIB PIBDC OEX OEEXP or PGA PGAS If the error history buffer entries are not visible in the window click on the icon shown above or click on View gt Error History If no errors are displayed then the error history buffer
72. be maintained concerning the PI Batch Diagnostics file Database DLL s operation Format of Files Generated for the PI Database Each file generated for export to the PI Database is named according to a convention that indicates the timestamp when the file was created PIBDCYYYYMMDDhhmmssxxx TXT where YYYY is the four digit year MM is the two digit month DD isthe two digit day hh is the two digit hour in 24 hour format mm is the two digit second SS is the two digit second xxx is the three digit milliseconds Example PIBDC20061025075103967 TXT is the PI Database file created on October 25 2006 at 07 51 03 967 The contents of the files generated for the PI Database vary depending upon the original type of data being converted Addendum to D5082 D5083 D5120 ADD 49 Using the Data File Conversion Utility Array and Archive Files Typical contents of an array or archive PI Database file are shown below Tag Name Date Time Stamp Value DIFF_PRESSURE 09 OCT 2006 09 00 56 0 STATIC_PRESSURE 09 OCT 2006 09 00 56 0 TEMPERATURE 09 OCT 2006 09 00 56 0 FREQUENCY 09 OCT 2006 09 00 56 0 DIFF_PRESSURE 09 OCT 2006 09 15 00 0 STATIC_PRESSURE 09 OCT 2006 09 15 00 0 TEMPERATURE 09 OCT 2006 09 15 00 0 FREQUENCY 09 OCT 2006 09 15 00 0 DIFF_PRESSURE 09 OCT 2006 09 30 00 0 STATIC_PRESSURE 09 OCT 2006 09 30 00 0 TEMPERATURE 09 OCT 2006 09 30 00 0 FREQUENCY 09 OCT 2006 09 30 00 0 DIFF_PRESSURE 09 OCT 2006 09 45 00 0 STATIC_PRESSU
73. ber of the array Flags Disable When checked will stop this collection from occurring View TimeStamp in RTU When checked will display the most recently collected Tree timestamp Last Timestamp from this controller in the tree of nodes on the left hand side of the main Harvester window NOTE Even if there are multiple collections for a controller only one collection timestamp will be displayed Communications Max Retries Per Pass This specifies the total number of attempts the Harvester will make to collect data from this controller on a given collection pass A retry occurs if there is a communication timeout Max Rows Collected Per Pass This specifies the maximum number of array rows which the Harvester will attempt to collect from the controller on a given collection pass OpenBSI Harvester 30 Adding a Controller and Configuring Collections Special Parms Push Rows Collected First Pass This is the number of array rows to collect during the first collection pass This should be set to match the number of rows of data generated within the controller that need to be collected on a given collection pass Defining Modifying a Raw Array Collection For an explanation of what a Raw Array is please KEJESTIIS ITE see the Configuring Your Controller section figuring Colecion ye n S Cancel Complete the fields as described below then click Item Number Flags on OK I Disable Commun
74. ccsscenscvsasevacececevanessesveecnasonsavesvonnacsnenniensss 11 Radio Turn ON Time LofiC ssnin R S 11 Logical Signals to Regulate Data Collection amp Modem Control ssesssecssocssoosssosssscsssee 12 Communications OFF Signal sisssrississosissiiseis siss oninseriosnnonisoonissnoo an sedno oku SEs orane daS VE one 13 Maintenance Mode Sinal sieresessnenoninan oni an RREN 13 Force List Collection Signal ciississssssasssescsssvsssasasincsssossscsessvnesivessnviicessnnsdesvansicasassivans 13 Modem Control Simili sisaan E 13 Starting the Harvester 14 Defining Common Lists 15 Changing a signal Name already in a Common List e sesesooessscsssocsssecssocesoossoosssse 16 Deleting a signal Name already in a Common List seessoessocsscoessccssocssocsscosesseessee 16 Deleting an entire Common List e sseessosssocsccosccoeesococsoccsocscooesssoesocoscooscosscossecseessse 16 Exiting the Common List Configuration dialog DOX s ssoessocssscessccssocesoossoossssesssee 16 Adding a Controller and Configuring Collections 17 Addin The Controllir ccc cuisine ane ee 17 Node Configuration General Page cssccccsssscssssscsessccssscsssssssesssssssssssssessesees 19 Node Configuration Scheduling Page cssscccsssssssscssssscscssscesssscessescessecsesees 22 Node Configuration Collections Page scssscccssssscssssccsssssssscccssscssssssssssssssense 25 Adding a new Collection for this Controller cssccsss
75. ce Modem_Retries retries After setting the modem_req_sig to ON this is the number of times the Harvester will check to see that the modem_confirm_sig has been turned ON This number can range from 0 to 5 The default is 1 Modem_Wait wait_time After setting the modem_req_sig this is the length of time in seconds the Harvester will wait before checking to see that the modem_confirm_sig has been turned ON This same period applies to all Modem_Retries as well This can range from 1 to 5 The default is 1 Scan_Type scantype Specifies how data scanning is performed Choose from the following 0 Scan Interval default 1 User Interval 2 User On Times Interval interval This applies when scantype is either 1 or 2 scan interval or user interval The interval is a period of time that may range from 1 to 3600 The units of time are specified by Interval_Units The default is 1 When used as the scan interval the Harvester attempts to communicate with a particular node based on its location in the network as determined by an address calculation When used as a user interval the Harvester attempts to communicate with a particular node every time a particular period of time has expired for example every hour For example if the interval is set to 1 and interval_units is set to hours then collections will occur every hour Interval Units interval_units This defines the units of the inter
76. ch you have just configured The driver may prompt you for more information Now click on Finish The Create a New Data Source to SQL x This wizard will help you create an ODBC data source that you can use to connect to SQL Server What name do you want to use to refer to the data source Name AWC DSN How do you want to describe the data source Description Sa Which SQL Server do you want to connect to Server kawckRsws3 7 Server dialog box will appear Enter a textual description of the data source file in the Description field then choose from the list of SQL server s in the Server field am e Using the Data File Conversion Utility ADD 72 Addendum to D5082 D5083 D5120 Create a New Data Source to SQL Server i xj How should SOL Server verify the authenticity of the login ID Choose the method by which the SQL Server will verify logins then click on Next With SQL Server authentication using a login ID and password entered by the user W To change the network library used to communicate with SOL Server byes B ex click Client Configuration Client Configuration a mic K Connect to SOL Server to obtain default settings for the additional configuration options Login ID aministrator Password coc e x he I Change the default database to JHARVESTER_DATAl X Assign a name for the database within JT Attach database file
77. collections remain active This would typically be used only if a controller has been temporarily taken out of service for repairs or if there are communication problems which must be fixed prior to attempting collections Skip_Hist skip If skip is set to 1 collection of array archive data for this RTU is disabled during the first collection OpenBSI Harvester E 5 Appendix E Harvester Initialization Files pass and instead it will wait for the next calculated interval If set to 0 default the Harvester will attempt to collect historical data during the first collection pass Turn_Off_Poll no_poll If communications with a particular controller are via a dial up modem or radio as soon as the Harvester completes its collections it may be desirable to turn polling off because there is no reason to continue requesting data If the controller has a direct cable connection i e it is always connected it may make sense to continue polling If no_poll is set to 1 polling will cease after a collection is completed If set to 0 default polling continues after a collection is completed Comm_Off_Signal comm_off_sig comm_off_sig is a signal that the Harvester will turn ON in the RTU when collection is complete This may be used to trigger user defined logic in the RTU to turn off a radio Maint_Mode_Signal maint_mode_sig maint_mode_sig is a signal in the RTU If set ON T
78. conds to wait between Dial Retries The System Information dialog box allows you to specify several things e Where the Harvester will store the data files generated from its data collections e Where the Harvester will look for Write List Files and Write Signal Files e What the configuration parameters are if you choose the scan interval as the On Time Method See Scan Interval Address Calculations choice on the Node Configuration Scheduling page OpenBSI Harvester 38 Scan Interval Method Configuration Scan Interval Start Time Offset Poll Time per Node Poll Time per Group Turn On Delay Defining System Information 39 This value defines the period of time in seconds over which the Harvester will attempt to collect data from each and every node in the network Typically this would be set to 3 600 seconds to indicate that collections occur hourly however the value can range from 600 to 172 800 seconds and should be set large enough to accommodate collection of data from all of the nodes under normal operating conditions The initial scan interval is measured from 00 00 00 midnight of the current day therefore it is recommended that the scan interval be chosen so as to divide a 24 hour period into equal parts without remaining time left over This value defines the offset into the scan interval at which the polling should start If for example the scan interval is 3 600 seconds 1 hour a
79. d Remove Modify Meter Volume Configuration Column Column Name Attribute Name ial Apply current Configuration to Stations wa Include Start Treat Archive File s Timestamp as Date Start of Period At Store Import Configuration From Station Cancel Stations This lists all stations Stations identify for the utility the file basenames of the archive audit and list files used in the conversion Type of Data Type of data may be either METER or Addendum to D5082 D5083 D5120 ADD 55 Using the Data File Conversion Utility Period Include Local Sequence Number Meter Configuration List Upload Configuration List From Rtu Add Using the Data File Conversion Utility GAS_QUALITY If this is a METER type file Period can be either MTR_VOLUME hourly data or MTR_VOLUME_DAILY daily data Meter data can come from both signal lists and archive files If this is a GAS_QUALITY type file Period can be GQ_PERIODIC Gas quality data only comes from archive files If checked the local sequence number of the archive is included in the XML file This is a list of signals that will be mapped to PGAS meter attributes If you are currently communicating with the controller you can click on this button to upload an existing configuration list into the Meter Configuration List window thereby simplifying the con
80. d an extension of TLF If you have an existing station configuration that you want to re use for this station click on the Import Configuration from Station button to load the station data then modify it as necessary Using the Data File Conversion Utility ADD 54 Addendum to D5082 D5083 D5120 If you do NOT have an existing station configuration to re use first select the Type of Data and the Period then configure the Meter Configuration List mapping or Meter Volume Configuration mapping Meter Configuration List If you choose METER as the type and you are currently communicating with the controller click on the Upload Configuration List From Rtu button to select the list and bring it into the Meter Configuration List window Then use the Modify button for each signal to call up the Map Signal to Archive Attribute Name dialog box and assign the corresponding attribute to the signal If you are not currently communicating with the controller use the Add button to call up the Map Signal to Archive Attribute Name dialog box to identify each signal in the configuration list via its position in the list and its name and then assign the corresponding attribute to the signal Tag Lookup File Configuration RPC1 Type of Data METER v Period MTR_VOLUME_DAILY v iv Include Local Sequence Number Meter Configuration List Index Signal Name Attribute Name 1 START_HOUR CONTRACT_HOUR Ad
81. d above Encrypted Start Collection Date Date Time If set indicates from what Date Time to start collecting Archive and or Array data Avg On Time Number Average time in seconds the node is online and collecting Num On Times Number The number of times data has been collected from this node Last On Time Date Time The last time data was collected from the node Total On Time Number The total time in seconds the node has been on line Modem Request Sig Text Signal in node s master that turns on modem to target node Modem Confirm Sig Text Signal in node s master that confirms node is online Modem Retries Number The number of times the modem connection will be attempted Modem Wait Number The number of seconds to wait before checking the Modem Confirm signal User Time 1 Date Time User Configured On Time 1 User Time 2 Date Time User Configured On Time 2 User Time 3 Date Time User Configured On Time 3 User Time 4 Date Time User Configured On Time 4 User Time 5 Date Time User Configured On Time 5 User Time 6 Date Time User Configured On Time 6 User Time 7 Date Time User Configured On Time 7 User Time 8 Date Time User Configured On Time 8 User Time 9 Date Time User Configured On Time 9 User Time 10 Date Time User Configured On Time 10 OpenBSI Harvester D 3 Appendix D Harvester Database Tables Crop Table The crop table contains information about what type of data will be collected from the controller Field Name Da
82. d does not exist Check for a misspelling RTU name Delete operation RTU not found The delete keyword specifies that an RTU should be deleted but the RTU name does not exist in the Harvester RTU name Duplicate Collection Type More than one collection has been defined with the same name RTU name Failure to access OpenBSI API Error nnn OpenBSI Harvester There was an error with the OpenBSI Application Programmer s Interface API while trying to add an RTU to the system The error codes nnn are as follows 142 RTU name already in use F 6 Appendix F Harvester Error Messages Error or Status Message Cause Possible Remedy 145 No Communications Line found for this address 158 Network not in OpenBSI Definition 159 Message Timeout not within 1 1800 range 160 Bad RTU Type specified 161 Ilegal Predecessor specified 162 Ilegal Local or IP Address specified RTU name Failed to write to the Harvester Database Parameters could not be written to the Harvester database tables RTU name Illegal Collection Item Number The numbered structure array archive list does not exist or the number is out of range RTU name Illegal Collection Type An incorrect entry was made for the collection type The collection type must be one of the following Archive Audit PushDownArray RawArray SignalList
83. don t want to rename the table you can click on Finish and the table will be imported If you want to rename the table click on Next to bring up the third page The list below shows the names of the columns of the table to be imported Archive 10 Archive Name TOTLFLOW 1 DateTime DATETIME 2 GSN ANALOG 3 LSN ANALOG 4 PUMP1_FLOW_T ANALOG 5 PUMP2_FLOW_T ANALOG 6 PUMP3_FLOW_T ANALOG E PUMP4_FLOW_T ANALOG Import table from ACC File Step 2 of 3 x table to be imported Archive 10 Archive Name TOTLFLOW The list below shows the names of the columns of the 1 DateTime DATETIME 2 GSN ANALOG 3 LSN ANALOG 4 STATION1 ANALOG 5 STATION2 ANALOG 6 STATIONS ANALOG E STATION4 ANALOG In the third page of the wizard you have the option of renaming the table prior to importing it If you want to rename it enter a new name in the Import to table field otherwise just leave it at the default name which is the Archive file name Finally click on Finish to actually import the table Cancel Hep That s all the information the wisard needs to import your table lt Back New gt Finish Cancel Help The column names of the imported table will be entered in the list box of the Table Definition dialog box overwriting any columns you defined yourself Since in this case the mapping between the column names and the fields in the Collecto
84. e Table 1 Enter a name for the column in the Column Name field Although the choice of names is at the discretion of the user we strongly recommend that _TABLE be added to the end of whichever name you choose 2 Select ANALOG DATETIME LOGICAL or STRING from the Column Data Type list box The choice you make depends upon what type of Collector Scheduler Harvester data you are storing in this column IMPORTANT Do NOT assume for example that numbers should always be stored as ANALOG Please review the notes below for directions as to which data type to choose for a given type of file NOTES ABOUT STORING SIGNAL LIST DATA e You must create at least a two column table e Column 1 should be used to hold signal names Choose a column name for it Choose STRING for the Column Data Type Enter 1 for the UOI Record Field Number Select Designate Column as Primary Key the signal name together with the station name will be used to form a unique primary key for each record in this table of the database e Column 2 should be used to hold signal values Choose a column name for it Choose STRING for the Column Data Type we choose STRING because the signal s value could be analog logical or string depending upon the signal type and STRING can store all three Enter 2 for the UOI Record Field Number e If you want to use STATION names Column 3 should be used to hold the STATION name choose a name for th
85. e a schema which maps fields in your Collector Scheduler Harvester data files to columns in tables of your ODBC compliant database See the Using the Data Storage Configuration Utility later in this addendum for details EXBBODBC DLL Setup Dialog Box Error Log Page EXBBODBC DLL Setup x Data Source Error Log General Enor Log File C WORK MYTEST LOG T Delete error log file at startup Write warnings to the error log file OK Cancel Help Error Log File Delete error log file at startup Write warnings to the error log file Specifies the name of a file which will be used to store error messages generated during the file conversion process Use the Browse push button to search for an existing error log file or enter the name of a new one while browsing If conversions are unsuccessful check the error log file for errors A list of error messages and their meanings is included later in this addendum When this option is checked the contents of the error log file will be deleted whenever the Data File Conversion Utility is re started When it is not checked the contents of the error log file will be appended When this option is checked warnings such as messages about duplicate records are written to the error log file When not checked warnings are not written to the error log file thereby reducing the size of the error log file Addendum to D5082 D5083 D5120 ADD 25 Using the Dat
86. e highlighted by clicking on it in the Export DLLs list box of the Data File Conversion Setup dialog box Next click on the Select gt push button and the name will be moved to the Selected DLLs list box Finally click on the Configure push button and then on the OK push button This causes the changes in the EXPDLL INI file to be read by the Data File Conversion Utility Data File Conversion Setup Eg When exporting is started the Data File Conversion Parameters Files Export Libraries utility will generate compacted versions of the array archive audit trail and list files in the COASTAL Export DLLs Selected DLLs directory as shown in the figure on the next page PBO rey Add New DLL New DLL __Configue OK Cancel Help If a valid directory was specified in the Copy Path field of the Data File Conversion Setup dialog box the original unconverted files array_collection_name Ann audit_collection_name Enn and list_collection_name Lnn will be copied to the specified path where they will remain until they are either overwritten by additional files or are deleted by the user If no Copy Path is specified the original files will be deleted after conversion occurs to prevent the same files from being converted on subsequent conversion passes If during installation of the OpenBSI software the Error Recovery Database files were installed then any data which is unable to be converted becau
87. e using the EXBBODBC DLL follow these instructions e If Use All Array Record s Fields is checked in the EXBBOCBC DLL Setup dialog box the number of columns you define must match exactly the number of columns in your array archive file s e Ifa timestamp is included in your array archive file s it should be mapped to column 1 of the table Choose a column name for it Choose DATETIME for the Column Data Type Enter 1 for the UOI Record Field Number Select Designate Column as Primary Key the date and time value together with the station name will be used to form a unique primary key for each record in this table of the database e The other columns you define will be used to hold array archive values For each choose a column name and choose ANALOG for the Column Data Type You can use the Generate Field Numbers Automatically method for these columns e If you want to use STATION names you must define an extra column which will be used to hold the STATION name choose a name for this column i e column can be named something other than STATION The STATION column must be made part of the primary key by selecting Designate Column as Primary Key Enter 0 for the UOI Record Field Number since there is no station field in the UOI record only in the database 3 Enter a UOI Record Field Number to map the column of the table to the appropriate field from the Data Collector Scheduler Ha
88. ect data from this controller on a given collection pass A retry occurs if there is a communication timeout If you have more than one controller which uses the same set of signal names and you want to be able to collect those signals via the Harvester you can optionally define a common list This allows you to define the list of signals in one place the Harvester and then enter that list number here This avoids the need of having a dedicated list of those signals in each controller and also allows on line changes to the common list without editing the control strategy in the controller See Defining Common Lists earlier in this manual When selected specifies that the common list specified above will be collected using signal names specified in the common list 29 OpenBSI Harvester Adding a Controller and Configuring Collections Defining Modifying a Pushdown Array Collection F Collection Confi ti For an explanation of what a Pushdown Array EECHER ONN BELMA 1 e 13 pl ease see the Configuring Your Controller Collection Type Pushdown Aray Array X section Item Number 0 Cancel Complete the fields as described below then Flags click on OK T Disable View TimeStamp in ATU Tree Communications Max Retries Per Pass 1 Max Rows Collected Per Pass 24 Special Parms Push Rows Collected First Pass 2 Collection Type This must be set to Pushdown Array Item Number This is the num
89. ection is disabled O collect default 1 disable collection View_Timestamp Can be set to display the most recently collected OpenBSI Harvester E 10 Appendix E Harvester Initialization Files show_timestamp timestamp Last Timestamp from this controller in the tree of nodes on the left hand side of the main Harvester window NOTE Even if there are multiple collections for a controller only one collection timestamp will be displayed Choices are O timestamp not displayed default 1 last timestamp displayed Max_Retry num_attempts This specifies the total number of attempts the Harvester will make to collect data from this controller on a given collection pass A retry occurs if there is a communication timeout This can range from 0 to 10 The default is 1 Max _Rows max_rows This specifies the maximum number of array rows which the Harvester will attempt to collect from the controller on a given collection pass This can range from 1 to 99999 The default is 24 Collect_Al max_coll Determines whether the Harvester will try to collect only some rows or the maximum number of rows 0 Normal collection default 1 Collect all using Max_Rows as max per message Audit_Reset delete_records Specifies whether audit records that have been collected by the Harvester will be deleted from the controller 0 Don t delete audit records in the RTU default 1 Delete a
90. ectory specified by path Converted Files of THIS Type Will Have THIS file extension Array Archive ARR Audit Trail AUD Configuration List LST Real Time List RST After defining the station data go to the Export Libraries page of the Data File Conversion Setup dialog box then highlight CSV in the Export DLLs list box and then click on Select gt CSV will now appear in the Selected DLLs list box Click on CSV then click on the Configure push button The CSV Export DLL Configuration dialog box will appear Complete the fields as described in the example below then click on OK to exit the dialog box then exit the Data File Conversion Setup dialog box You can now re start the export process Example There is a Network 3000 controller with the node name of DPU9 located on a natural gas pipeline at the Valley Road ooo eS Compressor Station The OpenBSI Data Aray Archive prrs SSS Collector collects array audit trail and configuration list data from DPU9 The ms sts collection names as defined in the Define Audit fuorg SSS New Collection dialog box of the Collector are array9 audit9 and list9 Ores respectively Cancel A station name of VALLEY is chosen for the converted files as shown in the Station Data dialog box and array audit and list file collection names are entered 8Real Time List data files are ONLY used by the OpenBSI Scheduler and
91. ed by SIGNAL TYPE Signal type 0 Analog or Logical 1 String signal The EXPDLL INI file does not have to be configured for the Access BBODBC DLL Configuration of station names and selection of the DLL in the Data File Conversion Setup dialog box however is required Example There is a controller with the node name of RPC7 which collects real Ny cari time level information about oil tanks in a tank farm The OpenBSI Data Anay Archive E Collector collects this list data from RPC7 and uses a collection name of List JRPCLUST RPC7LIST Audit A station name of TANKFARM has been chosen in the Station Data dialog box 4ODBC stands for Open Database Connectivity SAny errors occurring during the data transfer are logged in the file BBODBC LOG Information on naming conventions of files created by the Scheduler Data Collector or Harvester as well as information on the directories used to store these files are included respectively in the OpenBSI Scheduler Manual document D5082 the OpenBSI Collection Export Utilities Manual document D5083 and the OpenBSI Harvester Manual document D5120 If exporting is in process edits cannot be made in this dialog box Using the Data File Conversion Utility ADD 20 Addendum to D5082 D5083 D5120 Next with all exporting stopped the BBODBC Access DLL must be highlighted by clicking on it in the Export DLLs list box of the Data File C
92. efined logic should set the confirm signal to ON as a notification to the Harvester that collections from the slave node can proceed The Harvester will check the confirm signal at a OpenBSI Harvester 20 Adding a Controller and Configuring Collections user specified interval see Confirm Wait and Retries below p Request Signal The Harvester turns on the Request Signal in the Master node to activate user defined logic in the control strategy file that will initiate a dial up operation to the Slave node Confirm User defined logic in the control strategy file must turn this signal on to notify Signal the Harvester that the Slave node has been successfully dialed and collections can commence Retries After setting the Request Signal this is the number of times the Harvester will check to see that the Confirm Signal has been turned ON Confirm Wait After setting the Request Signal this is the length of time in seconds the Harvester will wait before checking to see that the Confirm Signal has been turned ON This same period applies to all Retries as well 21 OpenBSI Harvester Adding a Controller and Configuring Collections Node Configuration Scheduling Page NOTE If you are using Distributed User On Times different from User On Times shown below skip the Scheduling page Distributed User On Times is discussed later in this manual in the Specifying Distributed User On Times sectio
93. en the file extension CFG the older signal list files are not used To configure this DLL use any text editor to edit the file C WINDOWS EXPDLL INI The table below shows the file extensions which will be used for the newly created files in the directory specified by storepath Converted Files of THIS Type Will Have THIS file extension Array Archive HLY Audit Trail AUD Configuration List CFG NOTE Beginning with OpenBSI 5 8 Service Pack 1 you can optionally change the configuration list extension to something other than the default of CFG If you want to do this include the line LIST_EXT ext where ext is the three letter extension in the COASTAL section of your EXPDLL INI file Once you have configured the COASTAL DLL call it up in the Selected DLLs list box of the Data File Conversion Setup dialog box and click on the Configure push button then click on OK to exit the dialog box You can now re start the export process Example oo ee Sak hoe station there is a single run Network 3000 controller with a Station Name PARKROAD node name of DPC5 DPC5 collects hourly gas flow data into a set of ay Archive DPCSt data arrays The OpenBSI Harvester is configured to collect data from on Pcs this controller At a scheduled Audit pe interval it will collect hourly array data Audit Trail data and configuration list data and store the Fa data in files A station name of PARKROAD
94. erway at this moment click on the Active Nodes icon shown above or click on View gt Active Collections Last Status Active Nodes Current Status List of the controllers for Status of the Status of the which collections are collection that is previous collecton currently underway underway from this controller If desired you can stop the collection underway by right clicking on the node name and choosing Stop Collections from the pop up menu Collecting 45 OpenBSI Harvester Monitoring the Status of Your Collections Viewing a List of Controllers which are experiencing Communication Errors or other Failures To view a list of the controllers which are experiencing communication errors or other errors on one or more of their last scheduled collections click on the Node Errors icon or click on View gt Collection Errors This is a list of the controllers which are having This is th This is a list of the error errors while Is Is the on the last collection trying to collect current status attempt data of collections OpenBSI Harvester 46 Monitoring the Status of Your Collections pi Viewing a list of Debugging Messages The Harvester reports various debugging messages which relate to how collections are occurring and what errors are encountered These messages are primarily for use by Bristol development and support personnel however they may be viewed by clicking on the Debug Msgs icon
95. eted after conversion occurs to prevent the same files from being converted on subsequent conversion passes Using the Data File Conversion Utility ADD 30 Addendum to D5082 D5083 D5120 Using the Data Storage Configuration Utility For Use With EXBBODBC DLL or OEEXP DLL only The Data Storage Configuration utility is accessed via the Configure Schema push button in either the EXBBODBC DLL Setup dialog box or the OpenEnterprise Export DLL Setup dialog box It is currently used only with those two DLLs The purpose of the Data Storage Configuration utility is to define a schema for the ODBC compliant database into which data will be exported The schema defines a mapping between the fields in the original OpenBSI Data Collector Scheduler Harvester files and the columns in tables of the database EG Data Storage Configuration Utility Ea Contiguration for EXBBODBC export DLL Station List Stations with Schema es FIR NORTHAD K a y Add All gt Remove lt Remove All coo __ te _ The Station List list box displays the stations previously defined using the Station File Configuration dialog box To define a schema for a station it must first be moved from the Station List list box to the Stations with Schema list box by clicking on the station name in the Station List list box then click on the Add gt push button You can move all stations in this way using the Add All gt push button Similar
96. f FCS and are used to map structures such as signals and data arrays to corresponding Flow Cal variables See the Flow Cal documentation for information on creating the mapping files is the drive and directory where the Flow Cal import file CFX will be created The default drive and directory is C ProgramData Bristol OpenBSI ACCOL is either YES to indicate that a single common map file name will be used for all meters stations in the system If the entry is NO then each meter station must have its own individual map file The default is NO specifies the name of the common map file shared by all stations meters If unique_map NO this name is ignored since there is no common map file specifies how often the compacted data files will be exported to Flow Cal Valid selections are either DAY for daily export or HOUR for hourly export The default is DAY The DLL combines up to 99 files for a particular collection name of the same type into a single larger file which is suitable for use by Flow Cal Audit Trail files in the same collection are combined into a single file with the extension AUD Hourly data array files or hourly archive files in the same collection are combined into a single file with the extension HLY Because Flow Cal only requires the most recent configuration data the most recent signal list file is Using the Data File Conversion Utility ADD 16 Addendum to D5082 D5083 D5120 giv
97. figuration changes For other DLLs the Configure push button loads the DLL into the system but does not require configuration changes to be entered To de select one or more DLLs and thereby disable conversions by them click on the name in the Selected list box then click on the lt Deselect push button and the DLL will be moved to the Export DLLs list box disabling any conversions using that DLL The DLLs will not be enabled until after exiting the Data File Conversion Setup dialog box by clicking on the OK push button IMPORTANT Configuration cannot be performed while the export process is underway you must stop any exporting in order to perform configuration When all configuration has been completed you MUST explicitly activate the export process to begin exporting data See Activating the Export Process later in this addendum Addendum to D5082 D5083 D5120 ADD 11 Using the Data File Conversion Utility Exporting Data Using the Comma Separated Variable CSV DLL The Comma Separated Variable CSV DLL converts Collector Scheduler Harvester historical data files into a format suitable for import into Microsoft Excel It requires that these files have a timestamp in Column 1 If there are multiple files for a collection name of a given type during a conversion pass they will be compacted into a single file The table below shows the file extensions which will be used for the newly created files in the dir
98. figuration for this station file since you only need to define the attribute name for each signal via the Modify button NOTE For this to work correctly the station file s list name must follow the format described earlier in this section Map Signal to Attribute Name Signal s Position in the RTU s Signal Signal START_HOUR Attribute Name CONTRACT_HOUR To map signals to PGAS attributes identify a signal s position in the Configuration List then enter the signal s name Finally use the Attribute Name selection box to choose the corresponding PGAS attribute Click on OK when finished ADD 56 Addendum to D5082 D5083 D5120 Remove Modify Meter Volume Configuration Upload Archive Configuration From Rtu Import Archive Configuration From FCP File Add To delete an entry from the Meter Configuration List click on it then click on Remove To change an entry from the Meter Configuration List click on it then click on Modify The Map Signal to Attribute Name dialog box will appear and allow you to change the entry This is a list of archive columns to be mapped to PGAS attributes If you are currently communicating with the controller you can click on this button to upload the archive file s column data into the Meter Volume Configuration window thereby simplifying the mapping process since you only need to define the attribute name for each column via the
99. figuring Collections Apply Times to This loads the Harvester Database collection schedule and calculates for RTUs each RTU on a given PC communication port at which offsets from the start times collections should occur Click on Apply Times to RTUs to Finally click on Save New Times bring in the existing Harvester to store the newly defined times database and calculate collection or collection in the database times which the Harvester displays on the screen E Distribute User On Times Hourly Start Times ou i eaves pd eae 24 6 Apply Times to RTUs ave New Times RATU actual offset ETHNET CwWMEB 600 ach column displays collections the Harvester makes through a particular communication port on the PC Each RTU name is displayed followed by a calculated offset from the beginning of the start time hour at which a collection should occur The offsets are based on the RTU Interval value NOTE The new collection offsets are only displayed on the screen They must be stored in the Harvester database using the Save New Times button Save New Times This stores the newly defined collection schedule in the database You must do this before exiting or the new schedule will not be used Cancel Exits the dialog box OpenBSI Harvester 36 Adding a Controller and Configuring Collections Modifying the Configuration for a Controller Once you have added a controller and configured collectio
100. for the selection T 65 6777 8211 F 65 6777 0947 use or maintenance of any product Responsibility for proper selection use and maintenance www EmersonProcess com Remote of any Remote Automation Solutions product remains solely with the purchaser and end user EMERSON Remote Automation Solutions
101. fset can also be used to space out collections if several collections from multiple controllers are scheduled to occur within the same interval 23 OpenBSI Harvester Adding a Controller and Configuring Collections User On Times If User On Times is selected as the On Time Method up to 10 different times during the day can be specified as times at which the Harvester should collect data from this controller Use the User On Times boxes shown to specify a time for collection First check this box User On Times a ca EE AM Now click on any part of the time and type a new time or optionally use the arrows to adjust the time NOTE If you have a large number of controllers and do not want to manually enter on times for each one you can use an alternate method called Distributed User On Times This is discussed later in this manual in the Specifying Distributed User On Times section Reducing Communication Message Traffic OQpenBSI 5 8 Service Pack 1 and newer only By default Harvester collects column header information each collection pass To prevent this re collection of column header data and thereby reduce the number of communication messages per collection you can use the Advanced Configuration tool to turn off re collection of column header information This option can reduce communication costs if your communication link is expensive for example a satellite link To do this 1 First sta
102. g Box for details 8Dynamic Link Libraries DLLs are simply a collection of software sub routines or procedures which may be called on to perform a particular task In this case a customized DLL exists for each type of file conversion to be performed The user specifies which type of conversions are needed by selecting the required DLLs Facilities exist for adding new DLLs when new ones become available Using the Data File Conversion Utility ADD 2 Addendum to D5082 D5083 D5120 Step 6 Start the Export Process Once configuration is complete the export process can be activated The Data File Conversion Utility will then search for files to be converted and conversions will begin The operator can observe the progress of the conversions in the monitor area of the window See Activating the Export Process for details NOTE With the exception of the EXPDLL INI file users should not attempt to edit configuration files with a text editor Always use the dialog boxes and utilities provided Starting the Data File Conversion Utility Converter To start the Data File Conversion Utility OpenBSI communications must already be active Click on Start gt Programs gt OpenBSI Tools gt Collection Programs Converter A message may appear concerning database files being loaded The Data File Conversion Utility window will then appear This window includes a monitor area which displays messages concerning the operation of the utility
103. g Che Tool Watt sisicssssssisssssncscssssasssassensccassessdssavensasstsioidossvnsionsvansncsenansie 45 Viewing Hidine the Status ae vciicsicccscsvicessccasccssccsscecoccssecsesenconsseninecienniecnseeniansceoiees 45 Viewing a List of the Controllers in which a Collection is Occurring Right Now 45 Viewing a List of Controllers which are experiencing Communication Errors or other Fa Suan aa anaa 46 Viewing a list of Debugging Messages sseesssesssecssocesocescocesocessecesooesoosesoeessecssocesooses 47 Placing a controller into Maintenance Mode 47 Viewing the List of Controllers Currently in Maintenance Mode ssesee 48 Taking a Controller Out of Maintenance Mod e sscssssccssssscssssccssssssesscsssssceees 48 Turning on Polling for a Particular Controller 49 Performing an On Demand Collection 49 Clearing Error Status and Timestamp Information using Init Collection 49 Appendix A Writing File Data to Signals A 1 Appendix B File Naming Conventions B 1 Appendix C Sample ACCOL Task for Radio Control C 1 Appendix D Harvester Database Tables D 1 iv Contents Issued May 2013 OpenBSI Harvester Manual Appendix E HARVESTER Initialization Files E 1 Appendix F Harvester Error Messages F 1 Addendum Using the Data File Conversion Utility Issued May 2013 Contents v This page is intentionally left blank Introduction What is the Harvester Introduction
104. he user to specify on times for each RTU In this case the user can opt to use distributed user on times The user specifies a base set of up to four on times and an interval in seconds between RTU collections on the same communication port The Harvester will automatically calculate from the base time and the interval offsets at which collections should occur for each RTU on a given communication port To specify user configured on times choose Edit gt Distribute User On Times Enter up to 4 start times here E Distribute User On Times Hourhp ing RTU Interval 1120 in secs z z 40 Apply Times to RTUs Save New Times Cancel RTU actual offset ETHNET RTU Interval This is the period of time in seconds to wait after starting collection from one RTU before beginning a collection from the next RTU on this same communication port For example if you want collections to RTUs on a port one minute apart enter 60 here Hourly Start These are the hours in which collections should be started entered in 24 Times hour format 1 1 AM 24 12 midnight For example to start collections at midnight 6AM 12 noon and 6PM enter 24 6 12 and 18 Up to four hourly start times can be specified NOTE Actual collections for a given RTU occur at offsets from these start times as calculated by the RTU Interval Entering 0 for an hour disables that particular user on time 35 OpenBSI Harvester Adding a Controller and Con
105. hhh Sec_IP eee fff ggg hhh If this is an IP node you may optionally define a secondary IP address The default is 0 MsgTmo timeout This is the message timeout in seconds The default is 45 Load filename filename is the name of the control strategy running in the RTU either an ACCOL load or a ControlWave project Dial dial_string The phone number this RTU will dial if communication is via a dial up modem WebPage startup_page The initial web page that will be displayed for this RTU Default blank Alarm Dest1 aaa bbb ccc ddd Alarm Dest2 eee fff ggg hhh AlarmDest4 mmm nnn ooo Each RTU can send alarm messages to up to 4 different IP addresses These are defined as alarm destinations The default is 0 RBEDest1 aaa bbb ccc ddd RBEDest2 eee fff ggg hhh RBEDest4 mmm nnn ooo Each RTU can send RBE messages to up to 4 different IP addresses These are defined as RBE destinations The default for these is 0 FailType ip_fail_choice Specifies what happens if IP communications fail There are two choices OpenBSI Harvester Appendix E Harvester Initialization Files type 0 Always try to establish Primary link If you choose this option OpenBSI will always attempt to communicate with this RTU using the Primary link Primary IP Address unless that link fails in which case it will try to communicate using the Secondary link Secondary IP Address ty
106. ications Max Retries Per Pass 1 Special Parms Collection Type This must be set to Raw Array Item Number Flags Disable Communications Max Retries Per Pass This is the number of the array When checked will stop this collection from occurring This specifies the total number of attempts the Harvester will make to collect data from this controller on a given collection pass A retry occurs if there is a communication timeout 31 OpenBSI Harvester Adding a Controller and Configuring Collections Defining Modifying a Wrap Array Collection For an explanation of what a Wrap Array is please see the Configuring Your Controller section Complete the fields as described below then click on OK Collection Type Item Number Flags Disable View TimeStamp in RTU Tree Communications Max Retries Per Pass Max Rows Collected Per Pass OpenBSI Harvester Collection Configuration Collection Type 7 1 Disable P View TimeStamp in ATU Tree Communications Max Retries Per Pass 1 Max Rows Collected Per Pass f1 Collect all history using Max Rows as Maximum per message Cancel ltem Number Flags Special Parms This must be set to Wrap Array This is the number of the array When checked will stop this collection from occurring When checked will display the most recently collected timestamp Last Timestamp from this controller in the tree of nodes on the
107. ields in the OEEXP DLL Setup Dialog Box Data Service Enter the data service name of your OpenEnterprise database This is entered in the form hostname service If the database resides on this workstation it is NOT necessary to include the hostname portion Username Password These fields require you to enter the proper username and password required for access to the specified Data Service You will NOT be able to export data to the OpenEnterprise Database without entering this information Configure Schema The Configure Schema push button calls up the Data Storage Configuration utility to allow you to configure a schema which maps fields in your Collector Scheduler Harvester data files to columns in tables of your OpenEnterprise Database See the Using the Data Storage Configuration Utility later in this addendum for details Log File Specifies the name of a file which will be used to store error messages generated during the file conversion process Use the Browse push button to search for an existing error log file or enter the name of a new one while browsing In the figure above we have created an error log file named OEERROR LOG If conversions are unsuccessful check the error log file for errors A list of error messages and their meanings is included later in this addendum Addendum to D5082 D5083 D5120 ADD 29 Using the Data File Conversion Utility Delete error log file at startup When thi
108. iitArchiveNumber parameter in the ARCHIVE function block Error Array Not Found The specified data array could not be collected because it did not exist in the RTU e Verify that you did configure an array with that array number in the ACCOL load or ControlWave project For ControlWave users make sure you have registered the array using the REG_ARRAY function block e Check to see that you specified the correct array number in the Item Number field of the Collection Configuration dialog box e fusing Wrap Multiple Array collection verify that you did not specify too large a value for the Number of Multiple Arrays parameter in the Collection Configuration dialog box as this could cause the Harvester to attempt to read a higher numbered array than actually exists Error Audit Buffer Not Found The Audit data could not be collected because it did not exist in the RTU e Verify that you did in fact set up the Audit system properly in the RTU In ACCOL II F 1 OpenBSI Harvester Appendix F Harvester Error Messages Error Message Cause Possible Remedy this would involve configuring the EAUDIT Module and allocating sufficient memory for the Audit entries In ControlWave this would involve configuring the AUDIT function block Error Collections Stopped A collection has been stopped by the user by clicking on the Stop Collections pop up menu selection thereb
109. ill automatically update the station file used by the OpenBSI Data File Conversion Utility If no station file exists one will be created NOTE If there are multiple list arrays etc being collected from this controller only the first one will be used to update the station file This signal is turned ON by the Harvester to notify the controller that it has finished collecting data for this scan interval This can trigger user defined logic which turns OFF the radio This signal is set ON by the Harvester as a notification that the radio should not be turned OFF even if no collections are currently occurring This might be done while maintenance or testing is being performed This signal is set ON by user defined logic in the program as a notification to the Harvester that the configuration list has changed somehow and so it should be recollected by the Harvester This signal MUST be designated for audit trail collection via the EAudit Module or AUDIT function block RESERVED FOR FUTURE USE RESERVED FOR FUTURE USE If the Harvester is collecting data from a slave controller which communicates to its master controller in the network via a dial up modem the master must have a pair of logical boolean signals for modem control The Harvester will turn on the request signal which should be used as a notification to execute user defined logic in the master for dialing up the slave node When this is successfully done the user d
110. in the _ AUDIT9 E99 Copy Path field of the Data File Conversion Setup dialog box the AUDIT9 E00 gt VALLEY AUD original unconverted files will then be L copied to the specified path where they will remain until they are either _ LIST9 L99 overwritten by additional files when file gt VALLEY LST numbers wrap around or are deleted by LIST9 LO00 i the user j Locati Pajas ocaton Location in Storage Directory in Collector C adata Data Files directory If no Copy Path is specified the original files will be deleted after conversion occurs to prevent the same files from being converted on subsequent conversion passes If during installation of the OpenBSI software the Error Recovery Database files were installed then any data which is unable to be converted because of errors will be stored in this database During the next conversion pass the Data File Conversion Utility will automatically make additional attempts to convert this data Using the Data File Conversion Utility ADD 14 Addendum to D5082 D5083 D5120 Using the Change Floating Point Format dialog box Exported analog data from arrays archives is s Change Floating Point Format x displayed according to a default floating point format To alter this default format click on the Width K E Floating Point Format button The Change precision 5 zx m fi
111. ion Utility ADD 10 Addendum to D5082 D5083 D5120 Selecting DLLs using the Data File Conversion Setup Dialog Box In order to specify what types of conversions should be xj performed the appropriate DLLs must be configured first Parameters Fies Expor Librenes and then selected for use from the Export Libraries page of the Data File Conversion Setup dialog box To call up 3BODEC E this dialog box click on the icon shown above or click EXBBODEC on File gt Initialization Next click on the Export PIDE Libraries file tab Remove Selected DLLs Add New DuL Configure OK Cancel Help To select a DLL click on its name in the Export DLLs list box then click on the Select gt push button The name will now appear in the Selected DLLs list box If a particular DLL does not appear in the dialog box you can add it via the Add New DLL push button The name of the DLL must be eight characters or less and must not be the same name as any other DLL No more than 32 export DLLs can be configured NOTE A DLL must appear in the Selected DLLs list box in order for conversions to take place using that DLL If the configuration of a particular DLL has changed since the time the DLL was initially selected you MUST click on it in the Selected DLLs list box to highlight its name and then click on the Configure push button For some DLLs this will activate a dialog box from which you must enter certain con
112. is archive record is the time at which the record was stored while a value of 0 indicates Start of Period the timestamp assigned to this archive record is the time at the beginning of the interval This value is used by the PGAS Export DLL to calculate the values of the START_DATE and END_DATE attributes of the resulting XML record If the TSSTORE keyword is not in the file Start of Period is assumed Addendum to D5082 D5083 D5120 ADD 61 Using the Data File Conversion Utility Example PARAMETERS TYPE METER MTR_VOLUME_DAILY LOCSEQ 1 STARTDATE 0 TSSTORE 1 MTR_CONFIG_TAGS Section MTR_CONFIG_TAGS TAGI index attribute_name signal_name TAG2 index attribute_name signal_name TAGn index attribute_name signal_name Where attribute_name is the name of the attribute 25 chars max and index is the position base 1 of the signal in the Station s Configuration Signal List The signal_name is optional Example MTR_CONFIG_TAGS TAG1 1 METER_NAME GV METER_ID TAG2 2 METER_MAKE GV METER_MAKE TAG3 3 MODEL TAG4 4 METER_TYPE TAGS 5 PLATE_MATERIAL TAG6 6 TUBE_DIAMETER TAG7 7 TUBE_REF_TEMP NOTE If a tag with a position and a signal name have been defined but is not associated with any attribute the attribute name should be NONE For example TAG8 8 NONE GV FLOW_MAX The PGAS export DLL will ignore the entries with NONE but it will issue a warning message Using the Da
113. is column i e column can be named something other than STATION The STATION column must be made part of the primary key by selecting Designate Column as Primary Key the signal name together with the station name will be used to form a unique primary key for each record in this table of the database Enter 0 for the UOI Record Field Number since there is no station field in the UOI record only in the database 22 Early versions of the DLL required that there be no spaces or dashes in the column name just an uninterrupted string of alphanumeric characters Later versions allow underscores and or spaces in the column name Using the Data File Conversion Utility ADD 34 Addendum to D5082 D5083 D5120 NOTES ABOUT STORING AUDIT TRAIL DATA e IMPORTANT IF YOU ARE USING THE OEEXP DLL OpenEnterprise Export you CANNOT define tables for audit trail data via this method You must configure both the real time and historical parts of the OpenEnterprise Database first and then import tables from it If you are using the EXBBODBC DLL follow these instructions e You must define a table with six columns e Column 1 should be used to hold date and time information for the audit event Choose a column name for it Choose DATETIME for the Column Data Type Enter 1 for the UOI Record Field Number e Column 2 should be used to hold signal names Choose a column name for it Choose STRING for the Column Data Type E
114. istnumber is the number of the signal list Example List 6 in an RTU named RPC1 would be RPC1_L6 Click on OK when finished Data File Conversion Setup NOTE The Station Name is used as the file Parameters Files Export Libraries basename for the XML file POA DITS Selected DLLs Click on File gt Initialization and go to the Export Libraries tab of the Data File Conversion Setup dialog box Click on PGAS in the Export DLLs box then click on the Select gt button Add New DLL PGAS now appears in the Selected DLLs list box OK Cancel Help lt Deselect Now click on the Configure button and the PGAS Export DLL Configuration dialog box will appear Setup Page PGAS Export DLL Configuration Setup Logging Security XML Files Folder of Resulting XML Files c ProgramData Bristol OpenBSI Harvester Browse Floating Point Format Current Floating Point Format 3 5F Tag Lookup Files Folder of Tag Lookup Files c ProgramData Bristol OpenBSI Harvester Browse Setup Tag Lookup Files XML Files Folder of Resulting XML The XML file generated as a result of the conversion is stored in this folder The PGAS application looks in this folder to access each XML file and deletes the XML file Addendum to D5082 D5083 D5120 ADD 58 Using the Data File Conversion Utility Current Floating Point Format Floating Point Format Tag Lookup Files F
115. it and the controller will be added to the list of controllers in Maintenance Mode k i Viewing the List of Controllers Currently in Maintenance Mode To view a list of the controllers currently in Maintenance Mode click on the Maint Mode icon shown above or click on View gt Maintenance Mode Controllers which Status of the _ Status of are currently in controller last collection Maintenance Mode Taking a Controller Out of Maintenance Mode To remove a controller from Maintenance Mode click on the icon for it then click on the Stop Maint button OpenBSI Harvester 48 Monitoring the Status of Your Collections Turning on Polling for a Particular Controller Polling is a term referring to a request for data sent by the OpenBSI communications system to the controller network Normally polling from a particular controller would only be activated when the Harvester is ready to perform a collection according to a predefined schedule For example in a radio system polling of a particular controller would only occur when radio communication is scheduled to be active with that controller at all other times polling of that controller would be shut off The Start Poll button allows the user to force polling at other non scheduled times for example if communications with the controller need to be tested To do this click on the icon for the controller you want to poll and click on the Start Poll button Polling wi
116. ite List Files WLS and Write Signal Files WSG During the collection of data for a particular node the Harvester will check to see if a WLS or WSG file exists for that node if it does the values in the file will be written to the node during the collection pass Write List File Format The Write List File must be in an ASCII text format and must be located in the Write Files directory as specified in the Write File Directory in the Harvester s System Information dialog box The file base name must be the node name as defined in the NETDEF files and the file extension must be WLS The format of the Write List File is presented below n number of list definitions in this Write List File list definition 1 list definition 2 list definition n where a list definition consists of the number of the signal list the starting index into the list x number of signals being written to value 1 value 2 value x Values in the definition must be consecutive They can be analog values or for logical signals either ON OFF or TRUE FALSE A 1 Open BSI Harvester Appendix A Writing File Data to Signals In the example shown below a Write List file has been created for the node called RTU3 Its Write List File must therefore be named RTU3 WLS The first line of the RTU3 WLS file indicates that it contains 2 list definitions The first list definition applies to signal list 1 in RTU3 and will write to 2 consecutive
117. ith a similar configuration for example it shares the same configuration signal names and will use the same list array numbers etc you can select its name from the Default Config list box Once you have selected a default configuration common configuration details will be used for the new controller you are adding e Finally click on the Add button The Node Configuration pages will now appear These pages allow you to enter various configuration details to choose how often your Harvester collections will be performed and to specify the type s of data to be collected by the Harvester from this particular controller OpenBSI Harvester 18 Adding a Controller and Configuring Collections Node Configuration General Page The Node Configuration pages appear immediately after you add a new controller Node Configuration CWM1 General Scheduling Collections Node Identification Dak STREET COMPRESSOR STATION Flags Communications Signals F Disable Collections Communications Off Signal l Skip Historical Collections on First Pass Maintenance Mode Signal MAINT SIG Turn Off Polling after Collections Force List Collection Signal COLLECT SIG Write To Station File Modem Control Request Signal ControMWave Security Confirm Signal Username Retries Password ao Confirm Wait Cancel Help Node Enter a textual description of the node For example OAK Identification STREET COMPRESSO
118. ith the distributed on times timel time2 time3 time4 are a set of four base times during the day from which the interval will be added to calculate the collection times for RTUs Times should be specified as hours and minutes in 24 hour format hh mm OpenBSI Harvester E 2 Appendix E Harvester Initialization Files HARV_ADD INI The HARV_ADD INI file allows one or more RTU definitions to be added or removed from OpenBSI and Harvester collections to be configured for RTUs OpenBSI periodically checks the ProgramData Bristol OPENBSI installation directory to see whether a HARV_ADD INI file has been added and if it has dynamically re configures the system based on the entries in the file Once this configuration is completed the HARV_ADD INI file is automatically deleted so the configuration does not get repeated This allows a user or some external program to change the system configuration using a batch file instead of using the dialog boxes of the standard graphical user interface If a failure occurs during the parsing of the HARV_ADD INI file it will be renamed to HARV_ADD ERR and the configuration changes will not be processed Multiple RTU definitions may exist in the same file RTU_x Name rtu_name Delete delete Node_ID description Write_Station station_file Default_Config default_RTU_config Disable disable_collections Skip_Hist skip Turn_Off_Poll no_poll Comm_Off_Signal comm_off_sig Maint_Mode_Sign
119. k this box Stat Historical Collections from this Date ivi 4 19 2013 andhour 0 Now click on any part of Optionally specify a different the date and type a new hour than midnight here date or optionally use the arrows to adjust the date To set the date check the box next to the date then select one of the date fields and either enter new numbers for the date or use the up down controls on the right to adjust the date as desired If you want to specify that this historical data that you collect doesn t start at the default of midnight 0 you can specify a different hour here in 24 hour format 0 23 Requires OpenBSI 5 9 or newer Time Interval Settings Interval Units Offset in seconds Together with the Units this defines the period of time between collections For example if the Interval is set to 1 and Units is set to hours then collections will occur every hour This defines the units of the interval The possible choices are minutes hours or days This specifies a period of time in seconds measured from the beginning of the interval that the Harvester will wait before beginning its collection This is often necessary if arrays or archives are being updated in the controller every hour and it is necessary to wait this number of seconds for the array archive manipulation to be completed If left at 0 the collection will begin at the very start of the interval The of
120. l cases the user must specify initialization parameters such as the interval at which conversions should occur This is done from the Parameters page of the Data File Conversion Setup dialog box See Specifying Initialization Parameters for details Step 3 Specify Station Names and Collection Names The collection names file base names of data files collected by the Scheduler Data Collector or Harvester and the station name file base name which will be used for the exported files must also be defined This configuration is done using the Station File Configuration dialog box See Specifying Station Names and Collection Names for details Step 4 Configure Dynamic Link Libraries which will perform conversions The user must decide which of the available dynamic link libraries should be used to perform conversions and may also need to specify in a text file named EXPDLL INI certain special parameters required by the selected DLLs See the sub section on configuring the particular DLL for details Depending upon the choice of DLL special configuration of databases and field mapping may need to be performed using the Data Storage Configuration Utility and other utilities Step 5 Select Appropriate DLLs Once the desired DLLs have been configured they must be selected from the Export Libraries page of the Data File Conversion Setup dialog box See the sub section Selecting DLLs Using the Data File Conversion Setup Dialo
121. left hand side of the main Harvester window NOTE Even if there are multiple collections for a controller only one collection timestamp will be displayed This specifies the total number of attempts the Harvester will make to collect data from this controller on a given collection pass A retry occurs if there is a communication timeout This specifies the maximum number of array rows which the Harvester will attempt to collect from the controller on a given collection pass 32 Adding a Controller and Configuring Collections Collect all history using Max If your system is having communication problems outside of Rows as maximum per OpenBSI you may want to use this option This specifies that message the Harvester should attempt to collect the maximum number of Archive Records as specified by the parameter above but it will do it using shorter messages OpenBSI 5 4 and newer Defining Modifying a Wrap Multiple Array Collection For an explanation of what a Wrap Multiple Array is please see the Configuring Your Collection Configuration Controller section Collection Type ERE TaD Ta Rte Ty x ltem Number 1 _ Cancel Complete the fields as described below Flags then click on OK Disable F View TimeStamp in ATU Tree Communications Max Retries Per Pass 1 Max Rows Collected Per Pass 1 Special Parms Number of Multiple Arrays 0 Collection Type This must be set to Wrap Multiple Arra
122. les TLF define a mapping between columns in an archive file or entries in a signal list and PGAS attributes NOTE A single controller may host multiple stations or stations may be in separate controllers Station 1 XML File Station 2 XML File XML files are created for each station in a designated folder The PGAS application deletes them from the folder when processing is complete Station Data Before using the PGAS Export DLL you must have identified the structures that make up a given station 5 Neme Peci Normally this is done as part of configuring the AreyArhive jReci_coos Harvester To view change the names used all ust APCI_LE exporting must be stopped then click File gt Station The Station File Configuration dialog box will appear Audit RPCIAUD Now select the station name and click on the Add or Modify button to specify the file basenames for the archive list and audit files associated with this station meter in the Station Data dialog box Archive file basenames should follow the format rtuname_Carchive_number where rtuname is the controller name archive_number is the archive file number Using the Data File Conversion Utility ADD 52 Addendum to D5082 D5083 D5120 Example Archive file 005 in an RTU named RPC would be RPC1_C005 List file basenames should follow the format rtuname_Llistnumber where rtuname is the controller name l
123. lete the signal name of a signal already in the list click on the signal then click on the Delete button The signal name will be removed from the list Deleting an entire Common List To delete an entire common list click on the number of the list in the List window of the Common List Configuration dialog box then click on the Delete List button Exiting the Common List Configuration dialog box To exit the Common List Configuration dialog box click on the Close button OpenBSI Harvester 16 Adding a Controller and Configuring Collections i Adding a Controller and Configuring Collections Before data can be collected from a controller it must be added into the list of nodes accessible by the Harvester and certain configuration entries must be made Adding the Controller To add a controller click on the New Node icon shown above or click on File gt New Node from the menu bar The Add Nodes dialog box will appear First select one of the controllers in this list This list is all controllers in your NETDEF file which have NOT yet been defined in the Harvester Add Nodes New Nodes Cancel Next if configuration details for the controller e g numbers of structures used in the collections configuration signals etc are identical with a controller you already defined choose that controller s name from the Default Config list box Default Config inally click on Add to bring
124. list entries starting with the fifth entry in the list It will write a value of 1 9 to the fifth entry in the list 1 and a value of TRUE to the sixth entry in list 1 The second list definition applies to signal list 27 in RTU3 It will write to 3 consecutive list entries starting with the eighth entry in the list It will write a value of ON to the eighth entry of list 27 a value of 1001 to the ninth entry of list 27 and a value of 45 to the tenth entry of list 27 File Entry in RTU3 WLS_ Explanation number of list definitions list definition for signal list 1 start with 5th signal in signal list 1 write values to 2 consecutive signals i e signal 5 and 6 in list1 signal 5 value signal 6 value list definition for signal list 27 start with 8th signal in signal list 27 write values to 3 consecutive signals i e signals 8 9 and 10 signal 8 value signal 9 value signal 10 value Write Signal File A Write Signal File must be in an ASCII text format and must be located in the Write Files directory as specified in the Write File Directory in the Harvester s System Information dialog box A Write Signal file must be named node WSG where the file base name of node is the node name of the controller which will be written to and WSG is the file extension This node name must exist in the NETDEF files The first line of the WSG file must be an integer specifying the number of signals in the file Each of the remaining li
125. ll begin You can shut off polling by clicking on the Stop Poll button Performing an On Demand Collection If you want the Harvester to collect data On Demand from a controller at some time other than when it is normally scheduled to perform a Enter maximum number collection you can force an on demand of records to collect collection To do this click on the icon for the controller from which you want to collect data and click on the Demand Coll button The On Demand dialog box will appear In the Enter maximum number of records to collect field enter the maximum number of records i e array rows archive rows signals from a list that you want to collect then click on OK The Harvester will immediately attempt to perform collections from that controller Clearing Error Status and Timestamp Information using Init Collection To clear erase the Error Last Collection and Timestamp information showing in the window for a particular controller click on the icon for that controller then click on the Init Collection button 49 OpenBSI Harvester This page is intentionally left blank Appendix A Writing File Data to Signals The Harvester s can optionally read ASCII text files containing signal values and write those signal values to corresponding signals in the node This is useful for changing the value of configuration signals in the node There are two different file formats supported Wr
126. log box See the Using the Data Storage Configuration Utility later in this addendum for details NOTE If for some reason you want to use the EXBBODBC DLL to export to more than one database you can accomplish this by configuring the DLL for the first database and then going into Windows Explorer and making a copy of the EXBBODBC DLL file and assigning a new name to the copy The first three characters of the new name MUST be unique among all the other export DLLs Then load the new DLL and configure it independently to export to the second database 18 ODBC stands for Open Database Connectivity Using the Data File Conversion Utility ADD 22 Addendum to D5082 D5083 D5120 Example A compressor station on North Road stato Dat includes a EGM 3530 Electronic Gas Station Data i Measurement Computer which Station Name pomo collects archive data audit trail data and signal list data The OpenBSI Array Archive NRARC Data Collector retrieves this information from the EGM 3530 The was NRLST collection names configured in the ieee Pao Data Collector are NRARC for archive data NRAUD for audit trail data and NRLST for signal list The configured collection names as well as a station name we have chosen called NORTHRD are entered in the Station Data dialog box Next with all exporting stopped the EXBBODBC Extended Access DLL must be highlighted by Parameters Files Export Libraries clicking
127. lutions RETURNED EQUIPMENT WARNING When returning any equipment to Remote Automation Solutions for repairs or evaluation please note the following The party sending such materials is responsible to ensure that the materials returned to Remote Automation Solutions are clean to safe levels as such levels are defined and or determined by applicable federal state and or local law regulations or codes Such party agrees to indemnify Remote Automation Solutions and save Remote Automation Solutions harmless from any liability or damage which Remote Automation Solutions may incur or suffer due to such party s failure to so act ELECTRICAL GROUNDING Metal enclosures and exposed metal parts of electrical instruments must be grounded in accordance with OSHA rules and regulations pertaining to Design Safety Standards for Electrical Systems 29 CFR Part 1910 Subpart S dated April 16 1981 OSHA rulings are in agreement with the National Electrical Code The grounding requirement is also applicable to mechanical or pneumatic instruments that include electrically operated devices such as lights switches relays alarms or chart drives EQUIPMENT DAMAGE FROM ELECTROSTATIC DISCHARGE VOLTAGE This product contains sensitive electronic components that can be damaged by exposure to an electrostatic discharge ESD voltage Depending on the magnitude and duration of the ESD this can result in erratic operation or complete failure of the equipment Re
128. ly re start the export process Directory for CSV files is the drive and directory where the converted files should be stored The default entry is the ProgramData Bristol OpenBSI Harvester installation directory Include Header in CSV Array Files If checked then Header Text see below will be inserted as the top line of the exported CSV file enclosed in brackets NOTE This only applies for Array Archive files Addendum to D5082 D5083 D5120 ADD 18 Using the Data File Conversion Utility Header Text is text up to 255 characters which is inserted within brackets as the first line of the exported file whenever Include Header in CSV Array Files is checked If that option is checked but no text is provided the text DATA will be used NOTE The header option only applies for Array Archive files Floating Point Format Calls up the Change Floating Point Format dialog box to allow you to specify the floating point precision used to display array archive exported data See Using the Floating Point Format dialog box later in this section When exporting is started the Data File Criginal Data Files New Data Files Conversion utility will generate seompacied compacted versions of the array archive audit trail and list files in the ARRAYS A99 C adata directory as shown in the figure at right gt VALLEY ARR ARRAY9 A00 If a valid directory was specified
129. ly you can remove stations from the Stations with Schema list box by using the lt Remove or lt Remove All push buttons Once a station name appears in the Stations with Schema list box and is highlighted you can configure it using the Schema Definition and Table Definition dialog boxes by clicking on the Modify Schema push button Schema Definition Dialog Box The Schema Definition dialog box is accessed from within the Data Storage Configuration Utility dialog box by clicking on the desired station name in the Addendum to D5082 D5083 D5120 ADD 31 Using the Data File Conversion Utility Stations with Schema list box and then clicking on the Modify Schema push button Station Table Definitions Array Archive Audit List r Table Definitions Ss Array irchive Schema Definition Ed Station NORTHRD mc NORAUD_TABLE 3 NORLIST_TABLE 2 gt x Table NORARC_TABLE Ee m Audit m gt x Table e m List gt gt x Table NORLIST_TABLE Selected table has 7 columns OK Cancel Help The station name as selected in the Data Storage Configuration Utility dialog box Tables are a critical part of the schema for every database This list box displays a list of all tables in your database schema which have been defined via the Data Storage Utility To create a new table click on the New push button To modify an existing table click on the table n
130. ly turns on this signal to notify the OpenBSI Harvester F 4 Appendix F Harvester Error Messages Error Message Cause Possible Remedy Harvester that the slave could be dialed successfully e Verify that dialing to the slave works correctly Error Output File Open An array archive audit or list file is currently open at the same time the Harvester is attempting to write to it e Verify that the Data File Conversion Utility Converter is not scheduled to access the raw data files at the same time that they are to be written to by the Harvester Change collection schedules accordingly Error Read Modem Request The Modem Control Request Signal does NOT exist in the RTU e Verify that the Modem Control Request Signal actually exists in the RTU and is of the proper signal type Error Remote List Not Found A requested signal list could not be found in the RTU e Verify that a list of that specified number does exist in the RTU Error Remote Signal Not Found Error Signal not found in Node A required signal does NOT exist in the RTU e Check for syntax errors Verify that a signal with the particular signal name does in fact exist in the RTU e Verify that the signal is accessible i e for ControlWave users it must have its PDD box checked A signal could not be read from in the RTU e Verify that all the signals defined in the Common List actually exist in
131. n r Node Configuration CWM1 General Scheduling Collections On Time Method Ga Scan Interval Address Calculations Historical Collections from this Date Time Interval iv 4 19 2013 andhour 0 C User On Times Valid only for Archive and Pushdown collections On Time Method Only one On Time Method per controller may be used There are three possible choices Scan Interval Address When this is chosen the Harvester attempts to Calculations communicate with a particular node based on its location in the network as determined by an address calculation Time Interval When this is chosen the Harvester attempts to communicate with a particular node every time a particular period of time has expired for example every hour See Timer Interval Settings below User On Times When this is chosen the Harvester attempts to communicate with a particular node at up to ten specified times during the day See the User On Times section below OpenBSI Harvester 22 Adding a Controller and Configuring Collections Start Historical Collections from If you have several days of pushdown array or archive this Date and hour data stored in the controller this allows you to specify the first date from this historical data from which you want the collections to begin Any stored data for dates earlier than this will not be collected This applies only to Archive and pushdown arrays First chec
132. n Error Modem Request Configuration PDD for ControlWave e Verify that the signal is NOT inhibited The signal name entered for the Modem Control Confirm Signal in the Node Configuration dialog box is incorrect e Verify that the signal name entered in the dialog box is syntactically correct The signal name entered for the Modem Control Request Signal in the Node Configuration dialog box is incorrect e The signal name entered in the dialog box is not syntactically correct Error No Comm Line assigned in OpenBSI No communication line has been configured in OpenBSI for this particular RTU s address e Check that a communication line has been defined in NetView and that it handles the address range encompassing the RTUs used by the Harvester Error Node failed to turn on line The Harvester was unable to communicate with the RTU e Verify that dialing is working properly and that the line is NOT busy e Verify that timeouts are configured such that the RTU has enough time to come on line proper delays allowed for modems radios etc Error Node not configured in OpenBSI The Harvester cannot communicate with the specified node because it is undefined e Verify that the node is configured in OpenBSI and is visible in the NetView tree Error No Modem Confirm The Modem Confirm signal in the RTU did NOT turn ON e Verify that user defined logic in the RTU correct
133. name the SQL Server which will be receiving the data from the Converter Then click on Next K Create temporary stored procedures for prepared SOL statements and drop the stored procedures Ony when you disconnect When you disconnect and as appropriate while you are Connected IV Use ANSI quoted identifiers I Use ANSI nulls paddings and warnings Use the failover SOL Server if the primary SUL Server is not available coc e Create a New Data Source to SQL Server 4 xj Change the language of SOL Server system messages to Engish J7 Use strong encryption for data IV Perform translation for character data r User Jogonal settings when outputting currency numbers dates and Specify a path and file name for the log files then click on Finish fe QUERY LOG Browse Long query time milliseconds E 0000 IV Log ODBC driver statistics to the log file cAstaTsLo6 Brose pom SQL Server ODBC Data Source Test xj m Test Results Microsoft SQL Server ODBC Driver Version 03 80 0194 Running connectivity tests A summary page indicating whether tempting connection Connection established the connection to the SQL Server was Medd tal eenias successful will appear If it was click TESTS COMPLETED SUCCESSFULLY on OK and you re done Addendum to D5082 D5083 D5120 ADD 73 Using the Data File Conversion Utility OpenBSI Harvester Manual D5120 May 201
134. nd the start time offset is 60 seconds no polling will start until after the first minute of the hour has expired The Start time offset can range from 0 to 3600 seconds This value defines the amount of time required to poll a single node for data under normal operating conditions This value defines the amount of time from the start time for polling nodes from one expanded addressing group before the Harvester will attempt to start polling nodes from the next expanded node addressing group See the ACCOL II Reference Manual document D4044 for details on expanded node addressing This value can range from 0 to 3600 seconds This is a delay in seconds which is added to the calculated ON time which must expire before the actual collection begins This value can range from 0 to 3600 seconds See the calculation on page 13 for details OpenBSI Harvester Defining System Information Harvester Directories Raw File Storage Directory Write File Directory Stagger Mode Number of Active Nodes forcing Stagger Mode Number of Nodes to skip in Stagger Mode OpenBSI Harvester 40 This entry defines the DOS drive and directory file path where array archive audit trail and list files will be stored You can type the path in directly or use the Browse button to locate it This entry defines the DOS drive and directory file path where the Harvester will look for Write List WLS files and Write Signal
135. nes of the file must consist of a signal name and a signal value separated by a space Either analog or logical signals may be used string signals are not supported If a logical signal is used its value must be either ON OFF or TRUE FALSE In the example shown below a Write Signal file has been created for the node called DPUS Its Write Signal file must therefore be named DPUS WSG Open BSI Harvester A 2 Appendix A Writing File Data to Signals 3 VALVE01 0PEN NOW TRUE PUMP01 POWER ON ON SETPOINT WATER TEMP 32 Open BSI Harvester A 3 This page is intentionally left blank Appendix B File Naming Conventions The data collected from controllers by the Harvester is saved in data files at the OpenBSI Workstation The directory where these files are saved is specified in the Raw File Storage Directory field in the Harvester s System Information dialog box Once the files are saved they are typically exported to OpenEnterprise Microsoft Excel or some other third party package using the OpenBSI Data File Conversion Utility described in an addendum to this manual A maximum of 999 files can be saved of a given type in the Raw File Storage Directory Once this number is exhausted older files will be overwritten as new data must be saved The table below details the file naming conventions File Type File Format File Naming Convention Example File Name Archive Binary nn
136. nfigured Nodes _Lasyfimestamp Node Information eal Start Maint Yow Name ME F Disabled Descriptor CWMB6 Start Poll Mp CwM2 Session Status Error Audit Buffer Not Found SaPo m Time Infomation Next On Time 1 19 2010 12 00 05 Average On Time 8 Last On Time 1 19 2010 11 30 00 Total OnTime 8 Irit Collection Collections Retries Type Item Dis Last TimeStamp Last Status Cons Total Cons Total For Help press F1 lActive O Waiting O Configured 6 Node Information Name The controller s node name as defined in the NETDEF files Descriptor A textual description of the controller This comes from the Node Identification field on the Node Configuration General page Session Status Success indicates collections are occuring without errors If an error message appears it usually indicates some sort of communication or OpenBSI Harvester 42 Disabled Time Information Next On Time Last On Time Average On Time Total On Time Collections Type Item Dis Last Timestamp Last Status Errors Cons Errors Total Monitoring the Status of Your Collections configuration problem NOTE This status is only for the current Harvester session it does NOT report the status of the previous Harvester session Will appear checked if collections have been disabled This is the next time that the Harvester will attempt to collect any data
137. nnnnnn_Cxxx yyy RPC5_C001 000 Array Binary nnnnnnnn_Axxx yyy NORTHWD_A0O01 000 Audit ASCII nnnnnnnn_Exxx yyy FLOW3_E001 000 List ASCII nnnnnnnn_Lxxx yyy PARKROAD_LO01 000 Where nnannnnnn the controller s node name as defined in the NETDEF files XXX the structure number beginning with 001 e g array number yyy the file number ranging from 000 to 999 B 1 OpenBSI Harvester This page is intentionally left blank Appendix C Sample ACCOL Task for Radio Control When using radios as the communication link between the Harvester and a Network 3000 controller power consumption by the radio is normally an important consideration Power may be conserved by ensuring that under normal operating conditions a controller s radio is ONLY turned ON when it is scheduled to send receive data from the Harvester This is also important in preventing interference between multiple controllers which share the same radio frequency The radio turn ON logic is based on a calculation involving a controller s local address its expanded node addressing group number and other parameters defined both in the ACCOL load and in the Harvester The sample ACCOL task in this appendix represents one approach to creating such logic and should only be used as a guide This sample task only shows the part of the ACCOL load related to radio control it does NOT cover other communication details such as buffers port definitions etc Questions regarding this task sh
138. ns for it in the Node ESPERS Configuration pages you can recall those pages to modify the configuration by Fie Edit view three different methods e Double click on the controller s icon in the tree on the left hand side of the Harvester main page or e Click once on the controller s icon to highlight it then click on the Edit Node icon shown above or e Click once on the controller s icon to highlight it then click on Edit gt Node Configuration from the menu bar Deleting a Controller To delete a controller from the list of configured nodes click on the controller s icon then click on File gt Delete Node You will be prompted to confirm the deletion 37 OpenBSI Harvester Defining System Information Defining System Information To call up the System Information dialog box either click on the icon shown above or click on Edit gt System Information from the menu bar System Information Scan Interval Method Configuration Scan Interval ERM All Times in seconds Cancel On Time Calculation Turn on Time Start Time Offset 0 LocalAddress 1 Poll Time per Node 0 EBSAP Group Number Poll Time per Group Tum On Delay 5 Directories from Edit gt Application Parms in NetView Harvester Raw Files Signal Write Files Stagger Mode Number of Active Nodes forcing Stagger Mode Number of Nodes to skip in Stagger Mode Dial Number of Dial Retries on a busy line Time in se
139. nter 2 for the UOI Record Field Number e Column 3 should be used to hold the audit event information Choose a column name for it Choose STRING for the Column Data Type Enter 3 for the UOI Record Field Number e Beginning with OpenBSI 4 0 column 4 should be used to hold the local sequence number Choose a column name for it Choose STRING for the Column Data Type Enter 4 for the UOI Record Field Number e Beginning with OpenBSI 4 0 column 5 should be used to hold the global sequence number Choose a column name for it Choose STRING for the Column Data Type Enter 5 for the UOI Record Field Number e If you want to use STATION names Column 6 should be used to hold the STATION name choose a name for this column i e column can be named something other than STATION Do NOT designate the STATION or any other column to be part of the primary key Audit Trail data does NOT use a primary key Enter 0 for the UOI Record Field Number since there is no station field in the UOI record only in the database Addendum to D5082 D5083 D5120 ADD 35 Using the Data File Conversion Utility NOTES ABOUT STORING ARRAY ARCHIVE DATA e IMPORTANT IF YOU ARE USING THE OEEXP DLL OpenEnterprise Export you CANNOT define tables for array archive data via this method You must configure both the real time and historical portions of your OpenEnterprise Database first and then import tables from it If you ar
140. nversion If this parameter is left blank the individual date files will be automatically deleted following conversion NOTE Do NOT specify the copy path to be the same as the path where the OpenBSI Data Collector Scheduler or Harvester generate their data files or problems may occur specifies the length of time in seconds that the Data File Conversion utility will wait before attempting to process the next station This value can range from 0 to 3600 Click on the OK push button to save the parameters and exit the dialog box NOTE Initialization parameters are stored in the system directory under the name DFCU INI A description of this file is included at the end of this addendum Addendum to D5082 D5083 D5120 ADD 5 Using the Data File Conversion Utility Files Page The second page of the dialog box is accessible by clicking on the Files tab This page allows you to specify that you would like timestamps included in the first row of all list files you export If you select Timestamp exported UOI list files an entry LIST CREATE TIME with an accompanying timestamp will be the first record exported The format of the time date in the timestamp of this record is governed by Regional Settings in the Windows Control Panel The timestamp corresponds to the time the data was exported not the time it was collected however these are usually within a few moments of each other depending upon your configurati
141. nversion Utility This addendum applies to the following manuals OpenBSI Scheduler Manual document D5082 OBSOLETE OpenBSI Collection Export Utilities Manual document D5083 OBSOLETE OpenBSI Harvester Manual document D5120 DLL converts data into PGAS Application i appropriate format for Introduction use in other applications Microsoft Excel PGAS DLL CSV DLL gt Flow Cal The OpenBSI Harvester OpenBSI Data Coastal DLL Dans The Open BSI Data PIBDC DLL Collector and OpenBSI Scheduler store Conversion Utity BBODBC DLL Microsoft Access data array signal list archive and audit Converter grabs EXBBODBC DLL the files and activates OEEXP DLL OpenEnterprise trail data in multiple files on the PC hard iate DLL sa i ae gt appropriate DLL s to User created DLL Other application disk Although it is possible to view the Sela conversions 7 Cae i A on tnem are individual data files most users will L Data SCRE YY Se instead find it easier to export the data to 7 other packages such as OpenEnterprise Microsoft Access Microsoft Excel The collected Array List or Coastal Flow Measurement Inc s data is stored Archive ae Flow Cal software In order to inte Files successfully export
142. of data in the Source Tables These entries are known as Stream Instances 3 Set up the OELogColumn Table Entries should be inserted into the OELogColumn table in order to determine which columns of the source table should be monitored and to define the names of the columns of the destination table where data records will be logged 4 Set up the OELogData Table Entries should be made to the OELogData table to determine how often data should be retrieved from a stream These entries are known as data sets 5 Create Access Tables Once one or more data sets have been established for a stream the stream may specify access tables These are tables that an operator using the SQL Client could use to view historically logged data using standard SQL queries They are created by updating the OELogControl table s raw column Addendum to D5082 D5083 D5120 ADD 41 Using the Data File Conversion Utility OpenEnterprise Historical Example 1 The following SQL DDL and DML statements provide an example of the steps that have to be performed in order to configure the historical component of the OpenEnterprise database for storing array archive records into the historical tables Statements appearing in italics are comments This example assumes that array archive records collected from station dpu1_station have 3 fields one datetime field and two analog value fields Create the source table OEEXP DLL will insert update array records in this
143. older of Tag Lookup Setup Tag Lookup Files after processing Use the Browse button to specify the location of the folder Displays the defined width precision and format of data as it will appear in the XML file Click on this button to alter the floating point format Change Floating Point Format Precision 5 v Cancel f v Exponent Example 12345 56780 Use the Width list box to specify the total number of characters in the field including the decimal point when displaying a floating point number Use the Precision list box to choose the number of places to the right of the decimal point which should be displayed Use the Exponent list box to choose floating point format f exponential notation e or choose g for the best fit format based on available space The Tag Lookup File specifies a mapping between archive file columns or signal list entries and attributes used in the PGAS application The Data File Conversion Utility looks in this folder to access each Tag Lookup File Use the Browse button to specify the location of the folder Click on this button to call up the Tag Lookup File Configuration dialog box The Tag Lookup File Configuration dialog box allows you to define the mapping of signals and archive columns to PGAS attributes Tag Lookup File Configuration dialog box Each station has its own Tag Lookup File with the station name used as the file basename an
144. om the nodes WSG files The number of times the Harvester will retry dial nodes when the line is busy Dial Wait The number of seconds between dial retries Add RTU Yes No When this field is set to YES by an external program the Harvester will look for new RTUs to add in the HARV_ADD INI file This field is checked every 5 seconds D 1 OpenBSI Harvester Appendix D Harvester Database Tables Field Table The field table contains information on the configuration of a controller Field Name Node Identifier Data Type Text Description User defined text to describe this node Disable Yes No If set no collection is performed On Demand Yes No If set data from the node is collected immediately NOTE Harvester regularly monitors this table entry for changes Therefore if you want to have an external program trigger an on demand collection you can do that simply by setting this database field to Yes On Demand List Yes No If set lists from the node are collected immediately NOTE Harvester regularly monitors this table entry for changes Therefore if you want to have an external program trigger an on demand collection of list data you can do that simply by setting this database field to Yes OnUserTimeChange Turn Off Polling Yes No Yes No If set the User Times have been changed externally NOTE Harvester regularly monitors this table entry for changes Therefore you
145. on in the list of collections window then click on the Delete button 25 OpenBSI Harvester Adding a Controller and Configuring Collections Using the Collection Configuration Dialog Box The Collection Configuration dialog box is accessible by clicking on the Add button from the Node Configuration Collections page If you select an existing collection on that page you can call it up by clicking on the Modify button The fields visible in the Collection Configuration dialog box vary depending upon your choice of Collection Type The available choices are Archive Audit Pushdown Array Raw Array Signal List Wrap Array Wrap Multiple Array Each choice will be explained in a separate section below Defining Modifying an Archive Collection Complete the fields as described below then KeJES TI E E click on OK Collection Type Item Number 1 Cancel Flags l Disable View TimeStamp in ATU Tree Communications Max Retries Per Pass 1 Max Rows Collected Per Pass 24 Collect all history using Max Rows as Maximum per message Special Parms Collection Type This must be set to Archive Item Number Enter the Archive File Number here Network 3000 users The Archive File must have been defined in ACCOL Workbench The Archive File Number must match the value on the ARCHIVE terminal of the ARC_STORE module ControlWave users The Archive File must have been OpenBSI Harvester 26 Adding a Cont
146. on it in the Export DLLs list box of the Data File Conversion Setup dialog box Next click on the Select gt push button and the DLL name will be moved to the Selected DLLs list box Export DLLs Selected DLLs Select lt Deselect Add New ouf Configure OK Cancel Help Next click on the Configure push button to call up the EXBBODBC DLL Setup dialog box This dialog box has three pages each of which is accessible by clicking on its associated tab 19Jnformation on naming conventions of files created by the Scheduler Data Collector or Harvester as well as information on the directories used to store these files are included respectively in the OpenBSI Scheduler Manual document D5082 the OpenBSI Collection Export Utilities Manual document D5083 or the OpenBSI Harvester Manual document D5120 Addendum to D5082 D5083 D5120 ADD 23 Using the Data File Conversion Utility EXBBODBC DLL Setup Dialog Box Data Source Page EXBBODBC DLL Setup xj Data Source Error Log General C Select File DSN Browse dBase Files User Microsoft dBase YFP Driver dbf Excel Files User Microsoft Excel Driver xls FoxPro Files User Microsoft FoxPro YFP Driver dbf harvester User Microsoft Access Driver mdb System MOIS User SOL Server y V Compact Database after 45 passes Configure Schema Cancel Help Select File DSN The Data Source Name D
147. on settings If you check the Use UTC time for timestamped records box all timestamps in array archive or audit files will be converted to Universal Time UTC when exported via the Data File Conversion Utility Data File Conversion Setup xi Parameters Files Export Libraries V Use UTC time for timestamped records Cancel Help Export Libraries Page The third page of the dialog box defines which dynamic link libraries DLLs should be used to convert and export the data files It is accessible by clicking on the Export Libraries file tab Instructions for using this page of the dialog box are included later in this addendum in the section Configuring and Selecting Export DLLs Using the Data File Conversion Utility ADD 6 Addendum to D5082 D5083 D5120 Specifying Station Names and Collection Names When the Data File Conversion Utility performs its conversion of data files a new set of files which may be exported to other software packages is created Most of the export DLLs use Station names as the file base names for these new files Although not required typically the station name corresponds to the name of the meter A meter is either the controller or one of the meter runs associated with the controller For example if a controller is named DPU4 the station name for its exported data could be DPU4 If on the other hand a controller named RPU2 controls three separate meter runs then
148. on your PC workstation In addition if this is a new system you will need the ControlWave Designer kit and or the ACCOL Workbench kit to create a control strategy which will execute in the controller 2 Create structures in your control strategy which will hold the data you want to collect with the Harvester These structures can include lists arrays archives or audit trail You may find it advantageous to use the same signal names list numbers array numbers and archive numbers in each controller you configure since this can simplify your configuration activities later on NOTE We strongly recommend you consider using Archives instead of Arrays because Archives are more versatile Archives include sequence numbers and timestamps which simplify data management and make data collection more efficient 3 Create necessary configuration signals in each control strategy These are used for modem control and to set various modes of operation for the controller when it is used with the Harvester Again you may find it advantageous to use the same configuration signal names in each controller 4 Download the completed and compiled control strategy files ACCOL or ControlWave into each controller 5 Configure your controller network Before attempting to use the Harvester you must have an existing network of controllers to communicate with These controllers must exist in your NETDEF database Verify that communications between
149. onfigure the DLL via the OEEXP DLL Setup dialog box accessible via the Configure push button of the Data File Conversion Setup dialog box 6 Use the Data Storage Configuration utility to make any allowed changes required in the database schema which maps fields from the collected data files to specific columns in tables of your database NOTE You can only change UOI Field Number mappings column names and data types CANNOT be changed via the Data Storage Configuration utility The Data Storage Configuration utility is accessed from the Configure Schema push button of the OEEXP DLL Setup dialog box See the Using the Data Storage Configuration Utility later in this addendum for details 20 Any SQL configuration done for OpenEnterprise should be done by entering statements in text files This allows proper debugging to be performed and prevents the loss of SQL commands in the event of a system re start Addendum to D5082 D5083 D5120 ADD 27 Using the Data File Conversion Utility Example The Elm Street pumping station is cial x monitored and controlled by a DPC Station Name ELMSTRT 3330 controller The controller array data audit trail data and signal list data Anray Archive JELMARAY are retrieved via the OpenBSI Data List ems SC Collector The collection names configured in the Data Collector are Audit JELMAUD ELMARAY for array data ELMAUD Cancel for audit trail data and ELMLIST for signal list data
150. onversion Setup dialog box Next click on Export DLLs Selected DLLs the Select gt push button and the DLL name COASTAL o will be moved to the Selected DLLs list box Add New DLL Configure Parameters Fies Export Libraries l Finally click on the Configure push button and then on the OK push button When exporting is started the Data File Conversion utility will insert the list data directly into the Access database in the REAL_TIME table as discussed previously If a valid directory was specified in the Copy Path field of the Data File Conversion Setup dialog box the original unconverted files will be copied to the specified path where they will remain until they are either overwritten by additional files when file numbers wrap around or they are deleted by the user If no Copy Path is specified the original files will be deleted after conversion occurs to prevent the same files from being converted on subsequent conversion passes Addendum to D5082 D5083 D5120 ADD 21 Using the Data File Conversion Utility Exporting Data Using the Extended Access EXBBODBC DLL Like the BBODBC DLL the EXBBODBC DLL can take signal list data collected via the OpenBSI Scheduler Data Collector Harvester and insert that data into an ODBC compliant database such as Microsoft Access In addition however it can also insert array archive and audit trail data into an ODBC compliant database IMPORTANT If
151. ould be directed to Bristol s Application Support Group Task Description Turn ON Logic Highlights This task assumes the Harvester has a scan interval of 1 hour 3 600 seconds The time within each hour that the controller will turn ON its radio is stored in the signals HOUR MIN and HOUR SEC and is calculated by the lines 60 CALCULATOR 10 IF NODEADR 127 20 NODE TIME NODEADR 1 26 GROUP ADDR 5 60 30 HOUR MIN INT NODE TIME 60 40 HOUR SEC NODE TIME 60 HOUR MIN where in line 20 NODEADR is a system signal representing the local address of this controller and GROUP ADDR is a signal which holds the Expanded Node Addressing group number as defined during system configuration The values 26 5 and 60 are the poll time per node poll time per group and start time offset respectively which must be identical to the values for those parameters defined in the Harvester Lines 30 and 40 of the Calculator convert the turn ON time in seconds to minutes and seconds The HOUR MIN and HOUR SEC values are checked against TIME system signals later in the task to determine when it is time to turn on the radio 160 IF TIME 007 HOUR SEC amp TIME 006 HOUR MIN 170 IF RADIO HOUR ENBL 180 RADIO HOUR REQ 0N The start time of a scan interval is measured from midnight 00 00 of the current day As part of its communication activities the Harvester regularly sends a Node Routing Table
152. pe T Stay with link that is working Symmetric If you choose this option OpenBSI will attempt to use the current working communication link either Primary or Secondary and then if that link fails fail over to the alternate link TS_Disable toggle Determines whether or not timestamps will be sent to this RTU 0 TimeSync Enabled If you choose this option time synchronization messages will NOT be sent to this RTU Default T TimeSync Enabled If you choose this option time synchronization messages will be sent to this RTU Comm_Direct proxydirect Determines whether proxy direct access is allowed to this IP RTU 0 Proxy direct access disabled default 1 Proxy direct access enabled coll_n The name of a collection section as specified in the RTU section The same collection section can be used by multiple RTUs if they share the same collection parameters Type collection_type This indicates the kind of data being collected There are seven collection types Archive Audit PushdownArray RawArray SignalList WrapArray WrapMultipleArray Item item_num This is the number of the structure being collected i e the array number the archive number or the signal list number If multiple arrays are collected this would be the number of the first array in the group of consecutively numbered arrays This field does not apply to Audit Disable disable Specifies whether this coll
153. ping between the source data file and the tag names that will be used in the PI Database The PI Batch Database DLL can then automatically generate a file containing the tag names timestamps and the actual data values for import into the PI Database The PI Tag Mapping file is a text TXT file Entries in the file must follow the format shown below rtu_name structure_type structure_number element_number tag_name where rtu_name is the name of the controller from which the data is collected structure_type is the UOI file type of data being collected The supported choices are 1 data array 2 audit file 3 signal list 4 archive file structure_number is the number assigned to the array archive file or signal list from which you are collecting data element_number is the position in the structure from which the data will come This would correspond to the Archive File column number array column number or signal list entry number tag_name is the tag name used to represent this data in the PI Database Spaces are not allowed in the tag name See the example below for more on creating the Tag Mapping file Example Two ControlWave controllers named STAI and STA2 are used to monitor electrical data and pressure at two different sites though they are running identical application programs Each controller has two archives Archive 1 collects battery voltage communication request status input voltage a resi
154. r Scheduler Harvester data files is not known the first table s column will be mapped to field 1 the second column to field 2 and so on You can adjust this mapping by entering new values in the UOI Record Field Number and clicking on the Modify push button Using the Data File Conversion Utility ADD 40 Addendum to D5082 D5083 D5120 Examples for Configuring the OpenEnterprise Historical System Array archive and audit records are exported to the historical subsystem of the Open Enterprise Database The historical system provides a set of tables which define what data should be stored for retrieval at a later time These tables should be configured by inserting specific records into them This configuration can be performed by using the OpenEnterprise SQL Client as follows 1 Create the source tables The schema of a source table is a close image of the format of the array archive or audit record A source table should be created with as many columns as fields in the record plus a column named STATION which will store the name of the station from which the records were collected The STATION column must be the primary key in the table and must have a data type of char For array archive data records the source tables must have an extra column named TRIGGER_UPDATE of data type integer See Example 1 and Example 3 2 Set up the OELogControl Table Entries in the OELogControl table should be inserted to prompt monitoring
155. r their associated station name For List data the station name is preceded by either an L to indicate configuration list data or an R to indicate Real Time List data When the table has been selected click on the View Records push button to view the entries in that table 18 DEC 02 10 00 00 1297 65 29 8538 44 4254 19 DEC 02 10 00 00 1184 43 30 1412 49 6558 20 DEC 02 10 00 00 1243 5 29 7797 50 7652 21 DEC 02 10 00 00 1190 88 30 3117 56 7515 22 DEC 02 10 00 00 1247 12 29 9338 50 981 23 DEC 02 10 00 00 1268 63 29 9049 49 5815 24 DEC 02 10 00 00 1183 68 30 1113 51 3129 25 DEC 02 10 00 00 1246 73 29 9037 55 472 26 DEC 02 10 00 00 1179 22 30 0842 44 6432 2 DEC 02 10 00 00 1239 9 29 926 47 6603 28 DEC 02 10 00 00 1174 65 30 0193 47 5116 29 DEC 02 10 00 00 743 748 30 743 48 4395 30 DEC 02 10 00 00 1148 38 30 4104 50 0775 1207L gt Using the Data File Conversion Utility ADD 68 Addendum to D5082 D5083 D5120 Deleting Entries Use the Tables list box to select which tables will be deleted from the database Tables are named after their associated station name For List data the station name is preceded by either an L to indicate configuration list data or an R to indicate Real Time List data When the tables to be deleted have been selected click on the Delete Tables push button to delete them If the Confirm Deletion box has been checked you will be prompted to confirm that you want to delete the selec
156. required they can be Toum made through the Table Definition dialog GEN ANALOG box after the table has been imported 4 FLOW ANALOG 5 TEMP ANALOG 6 LEVEL ANALOG 7 FAILURES ANALOG NOTE If you realize at this point that you ve chosen the wrong Archive file click on Back to choose a different one Finish Cancel Help If you don t want to rename the table you can click on Finish and the table will be imported If you want to rename the table click on Next to bring up the third page Using the Data File Conversion Utility ADD 38 Addendum to D5082 D5083 D5120 Import table from Archive Profile Step 3 of 3 x That s all the information the wisard needs to import your table In the third page of the wizard you have the option of renaming the table prior to importing it If you want to rename it enter a new name in the Import to table field otherwise just leave it at the default name which is the Archive file name Finally click on Finish to actually import the table Import to table TOTALS lt Back Next gt Finish Cancel Help Import from ACCOL Load Network 3000 series ONLY When ACCOL Load is selected from the Import Table from list a table schema will be built for archive files whose definitions were specified during construction of your ACCOL load Since the ACC file associates an ACCOL signal with each column of the archive record the user has the
157. riencing communication problems or any current Harvester debugging messges You can select which items are displayed either from icons in the tool bar or from the View menu bar selection OpenBSI Harvester 14 Defining Common Lists Defining Common Lists If you are running an identical application load project in more than one controller that contains signals you want to collect you can use Common Lists to simplify your collections A common list is just a group of signals you want to collect in which the signals share the same name in more than one controller For example if you have ten controllers and each one has signals named CURRENT FLOW CURRENT TEMP and CURRENT PRESUR that you want to collect you could define a Common List containing these three signals The advantage is that the Common List is defined in only one place the Harvester program itself so as long as those individual signals already exist in the your running application you don t need to modify your application to add or change the Common List Another advantage of using common lists is that you save on certain communications overhead because signal names do not need to be collected just the signal values To access the Common List Configuration dialog box click on Edit gt Common Lists Common List Configuration Signals Number Count Used Add List i Insert After Adli _insertAher Delete List Insert Before Copy List Modify
158. roller and Configuring Collections Flags Disable View TimeStamp in RTU Tree Communications Max Retries Per Pass Max Rows Collected Per Pass Collect all history using Max Rows as maximum per message defined using either the Flash Configuration Utility or the Archive web page The Archive File Number must match the value on the iiArchiveNumber parameter in the ARCHIVE function block When checked will stop this collection from occurring When checked will display the most recently collected timestamp Last Timestamp from this controller in the tree of nodes on the left hand side of the main Harvester window NOTE Even if there are multiple collections for a controller only one collection timestamp will be displayed This specifies the total number of attempts the Harvester will make to collect data from this controller on a given collection pass A retry occurs if there is a communication timeout This specifies the maximum number of Archive Records rows which the Harvester will attempt to collect from the controller on a given collection pass If your system is having communication problems outside of OpenBSI you may want to use this option This specifies that the Harvester should attempt to collect the maximum number of Archive Records as specified by the parameter above but it will do it using shorter messages OpenBSI 5 4 and newer NOTE When using the Harvester to collect Archive Files in
159. rt the Advanced Configuration tool by clicking OpenBSI Tools gt Common Tools gt Advanced Configuration 2 Then on the Harvester tab of the OpenBSI INI Configuration Settings dialog box check the Do Not collect Column Header Information on Archive Collections and click OK Harvester will not collect column header information on subsequent collections OpenBSI Harvester 24 Adding a Controller and Configuring Collections Node Configuration Collections Page The Collections page lists all currently configured collections for this controller and also allows you to configure additional collections Node Configuration CWM1 General Scheduling Collections Collection Type Item Number _ Disable Max Retries MaxRows View Stamp 1 Archive 1 Audit 1 SignalList 55 1 Modify Delete OK Cancel Help Adding a new Collection for this Controller To add a collection click on the Add button then configure the collection in the Collection Configuration dialog box See Using the Collection Configuration Dialog Box Modifying an existing Collection To modify an existing collection click on the line for that collection in the list of collections window then click on the Modify button to call up the Collection Configuration dialog box See Using the Collection Configuration Dialog Box Deleting an existing collection To delete an existing collection click on the line for that collecti
160. rts hourly data the resulting XML file will have the following format lt xml version 1 0 gt lt PGAS_XML gt Addendum to D5082 D5083 D5120 ADD 68 Using the Data File Conversion Utility lt TRANSACTION gt lt METER METER_ID 20 0236 00 gt lt METER_CONFIG gt lt MTR_CONFIG_REC attributes gt lt METER_CONFIG gt lt MTR_VOLUME gt lt MTR_VOLUME_REC attributes gt lt MTR_VOLUME_DAILY gt lt METER gt lt TRANSACTION gt lt PGAS_XML gt The attributes in the MTR_CONFIG_REC element correspond to signal values from a configuration list for the meter where the attributes in the MTR_VOLUME_DAILY_REC or MTR_VOLUME_REC element correspond to values coming from the archive file that holds daily or hourly records for the meter If the station reports Gas Quality Data with varying data log intervals the resulting XML File will have the following format lt xml version 1 0 gt lt PGAS_XML gt lt TRANSACTION gt lt GAS_QUALITY GAS_QUALITY_ID 20 0236 00 gt lt GQ_PERIODIC gt lt GQ_PERIODIC_REC attributes gt lt GQ_PERIODIC gt lt GAS_QUALITY gt lt TRANSACTION gt lt PGAS_XML gt Using the Data File Conversion Utility ADD 64 Addendum to D5082 D5083 D5120 Activating the Export Process To activate the export process click on Export Start Once the export process has been started it may be shut down by clicking on Export gt Stop There may be some delay time in order to allow e
161. rue by the Harvester it is intended to trigger user configured logic that keeps communications active with the RTU even though no collections are occurring so that maintenance communications testing debugging can be performed Force_List_Signal force_list_sig This signal is set ON by user defined logic in the program as a notification to the Harvester that the configuration list has changed somehow and so it should be re collected by the Harvester This signal MUST be designated for audit trail collection via the EAudit Module or AUDIT function block Modem_Req_Signal modem_req_sig If the Harvester is collecting data from a slave controller which communicates to its master controller in the network via a dial up modem the signal identified by modem_req_sig is turned ON by the Harvester as a trigger to execute user defined logic in the Master controller that will cause it that will cause it to dial up its slave controller Modem_Confirm_Signal If the Harvester is collecting data from a slave OpenBSI Harvester E 6 Appendix E Harvester Initialization Files modem_confirm_sig controller which communicates to its master controller in the network via a dial up modem the signal identified by modem_confirm_sig must be turned ON by user defined logic in the Master controller as a confirmation to the Harvester that the Slave node has been successfully dialed and collections can commen
162. rvester array archive audit trail or list file s or check the Generate Field Numbers Automatically to have field numbers assigned automatically NOTE In most cases you will want to explicitly define field numbers rather than let them be generated automatically to ensure proper mapping This is especially true in the case of the STATION which must be field 0 because there is no station field in the UOI record but a STATION must be part of the database record Please review the notes above for directions as to which field numbers to use for a given type of file 4 If this column should be part of the primary key of the table check the Designate Data files collected by the OpenBSI Data Collector OpenBSI Scheduler or OpenBSI Harvester are sometimes generically referred to as UOI files because they follow the same format as files generated by the Universal Operator Interface UOI software When we say UOI files we are referring to data array archive files audit trail files or signal list files collected by the Scheduler Data Collector or Harvester Using the Data File Conversion Utility ADD 36 Addendum to D5082 D5083 D5120 Column as Primary Key selection See the notes on the previous pages to determine which columns should be part of the primary key 5 Click on the Insert push button to add the column to the table NOTE If you make a mistake you can change the column definition by clicking on the column name
163. s for all stations are empty If the error history area is full of errors no new incoming messages can be displayed To DELETE all errors in the buffers and clear the error history window click on the icon shown at left or click on View gt Reset Errors Monitor Area The lower part of the Data File Conversion Utility window includes a monitor area which displays messages concerning the status of the utility and the progress of conversions Oldest messages appear at the top of the monitor area and newest messages appear at the bottom The number of messages which can be displayed in the monitor area is configured by the Monitor Size parameter in the Data File Conversion Setup dialog box If more messages are received than the number specified by Monitor Size older messages will automatically be deleted Refresh of the monitor area may be toggled on off by clicking on the icon shown above or by clicking on View gt Restart Monitor or View gt Stop Monitor The scroll bar may be used to display messages which are not currently in view It is recommended however that refreshing be turned off when attempting to view the oldest messages since they will be the first to be overwritten when new messages are received and the screen is refreshed To clear the monitor area thereby deleting all the messages click on the icon shown at left or click on View gt Clear Monitor Using the Data File Conversion Utility ADD 66 Addendum
164. s option is checked the contents of the error log file will be deleted whenever the Data File Conversion Utility is re started When it is not checked the contents of the error log file will be appended Floating Point Format Calls up the Change Floating Point Format dialog box to allow you to specify the floating point precision used to display array archive exported data See Using the Floating Point Format dialog box earlier in this section When you have finished defining your data service configured its schema via the Data Storage Configuration utility etc click on the OK push button to save changes or the Cancel push button to abandon the changes In either case you will return to the OEEXP DLL Setup dialog box From there click on either OK or Cancel to return to the Export Libraries page of the Data File Conversion Setup dialog box Click OK again and configuration is complete After you have activated the export process the Data File Conversion utility will insert the Collector Scheduler Harvester data directly into the OpenEnterprise database If a valid directory was specified in the Copy Path field of the Data File Conversion Setup dialog box the original unconverted files will be copied to the specified path where they will remain until they are either overwritten by additional files when file numbers wrap around or they are deleted by the user If no Copy Path is specified the original files will be del
165. sccssssccsssccsssscscssscssssssssenss 25 Modifying an existing Colle cti0i cscssccsseccossssssoossonesseonssentesssonseesnnsessoonasessnsssonssosones 25 Issued May 2013 Contents OpenBSI Harvester Manual Deleting an existing colection ssnin er rsss 25 Using the Collection Configuration Dialog BOX eeescsescoessseessecescocesocessoeessecssocscocseo 26 Defining Modifying an Archive Collection eessecesosescoessscessecesooesooessoesssecssocssocseo 26 Defining Modifying an Audit Collection e sseessoossooessocsssocsssccssocesocssoossssesssesesosee 28 Defining Modifying a Signal List Collection seeessoessocsssesssecssocssoosssosessecssocesoosso 29 Defining Modifying a Pushdown Array Collection e sseessecesoocssocescocessessscseseeee 30 Defining Modifying a Raw Array Colle ction ccssccssssccssssccssssccsscscsssscceseesees 31 Defining Modifying a Wrap Array Collection sccsscccssssccsssscsessccssscssseesees 32 Defining Modifying a Wrap Multiple Array Collections cscccsccssscsssessesees 33 Specifying Distributed User On Times OpenBSI 5 0 and newer sccesseeees 35 Modifying the Configuration for a Controller af Deleting a Controller 37 Defining System Information 38 Monitoring the Status of Your Collections 42 Controllers with Collection ErrorS si ccississcessccsnsncsrcesssiesontisoeaasnsscioastneiacetsnenntsannainnie 44 Viewing Hidin
166. se of errors will be stored in this database Using the Data File Conversion Utility ADD 18 Addendum to D5082 D5083 D5120 During the next conversion pass the Data File Conversion Utility will automatically make additional attempts to convert this data Original Data Files New Data Files compacted PARKROAD HLY DPCS E99 R gt DPC5 E00 PARKROAD AUD J PE PARKROAD CFG DPC51 L00 Location Location Files are Files are in directory in directory specified specified in the by store_path in the Scheduler s EXPDLL INI file SYSDEF TXT file Addendum to D5082 D5083 D5120 ADD 19 Using the Data File Conversion Utility Exporting Data Using the Access BBODBC DLL The Access BBODBC DLL reads Scheduler Collector Harvester signal list data files and inserts the data directly into a Microsoft Access Database NOTE If you need to export data other than signal lists arrays archives audit trail you must use the Extended BBDOBC DLL EXBBODBC discussed later in this addendum The name of the database file is BBODBC MDB and the name of the data source DSN is BBI ODBC The list data in the Access database is stored in four columns of a table called REAL_TIME The columns are defined as follows Column Heading Description STATION Station name SIGNAL Signal name in the load This signal must be associated with the STATION named above SIGVAL Value of the signal nam
167. stance temperature device RTD reading and current Archive 2 collects the outlet pressure The Harvester collects these archives and stores the archive data in binary files at the PC Using the Data File Conversion Utility ADD 46 Addendum to D5082 D5083 D5120 tanvan 1 27 00 Jon WANs n 0 Amnn On Toe 9 TotalOnTee 4 STA1_C001 000 STA2_C001 000 Harvester saves archive data in binary files on the PC F Harvester collects archives A RTU STA1 Archive files RTU STA2 Archive files as viewed via DataView as viewed via DataView The PI Batch Database Conversion DLL PIDBC needs to know which columns of archive file data will be assigned to which tag names in the PI Database To specify this you must create a Tag Mapping file STA2_C001 000 STA1_C001 000 Data File Conversion Utility PI Batch Database Conversion DLL takes binary files and based on tag mapping file PIDBC DLL generates output files that can be exported to the PI Database tag_mapping_file TXT FILES THAT CAN BE IMPORTED INTO THE PI DATABASE Tag Mapping files have a file extension of TXT A Tag Mapping file for this example is shown below Addendum to D5082 D5083 D5120 ADD 47 Using the Data File Conversion Utility RTU name Structure Type Structure Number Element Number ij Name for PI Database 1 STAIBATTVOLT 2 STAICOMREQ 3 STALINVOLI1 STAI 4
168. t from previous attempts Minimize 1 When 1 the Data File Conversion Utility will start with its window minimized When 0 the window will not be minimized SilentExit 1 When 1 allows the Data File Conversion Utility to be closed down without confirmation prompts When 0 prompts will be made to confirm that the utility should be shut down OpenBSI 5 6 and newer DLL_SECTION This section lists the DLLs available to perform export duties DLLO CSV DLL1 COASTAL DLL2 BBODBC DLL3 EXBBODBC DLL4 OEEXP DLL5 PIBDC DLL6 PGAS EXPORT_SECTION EXPORTO 0 This section lists which of the corresponding DLLs in the DLL section have been activated for use e g Export0 0 Export1 1 Export2 2 etc Using the Data File Conversion Utility ADD 70 Addendum to D5082 D5083 D5120 Exporting Harvester Data to an SQL Server If instead of exporting Harvester data to a database or CSV format Flow Cal etc you want to use the EXBBODBC DLL to export data to an SQL Server you must follow steps similar to those shown below Start the Windows Control Panel by ri clicking on Start gt Settings gt Control Panel then double click on Pta Sources the Data Sources ODBC icon secsssesuevesenssessnnecnessensed ODBC Data Source Administrator 2 xi User DSN SystemDSN File DSN Drivers Tracing Connection Pooling About Look in Data Sources h Sl Add Remove Go to the File DSN page of the ODB
169. t of the OpenEnterprise Database for storing array archive records Statements appearing in italics are comments This example assumes that array archive records are collected from two stations dpul and dpu2 Records from dpul have 4 fields one datetime field and three analog value fields while records from dpu2 have 3 analog value fields Create the source tables OQEEXP DLL will insert update array records in these tables for logging into historical database create table dpul PERSISTENT PRIMARY KEY station station char trigger_update integer rectimestamp datetime flow real temperature real pump_status real create table dpu2 PERSISTENT PRIMARY KEY station station char trigger_update integer pressure_1 real pressure_2 real pressure_3 real Create the streams for monitoring of data in the source tables insert into oelogcontrol id source namecolumn enable triggercolumn values 3 dpul station true trigger_update insert into oelogcontrol id source namecolumn enable triggercolumn values 4 dpu2 station true trigger_upate commit Set up the columns of the source tables to be monitored Using the Data File Conversion Utility ADD 44 Addendum to D5082 D5083 D5120 insert into oelogcolumn control name type sourcecolumn values 3 rectimestamp 0 rectimestamp insert into oelogcolumn control name type sourcecolumn values 3 flow
170. tView To start the Harvester click as follows Start gt Programs gt OpenBSI Tools gt Collection Programs Harvester IMPORTANT If this is the very first time the Harvester has been started on this particular computer you will be prompted to register the software Otherwise the software can only be used for a maximum of 60 days For more information on the registration process see Chapter 2 of the OpenBSI Utilities Manual document D5081 The Harvester Main Page will appear as shown below These sections of the screen allow you to monitor information about the status of the currently configured collections Timestamp associated with most Menu bar recent collection Harvester DR Fie Edit Vi Sa Tool ba ertga A Node Information fom Name CwM2 F Disabled Start Maint O e SERED a Time Infomation Demand Coll Next On Time 1 19 2010 10 00 05 Average On Time 0 Last On Time 1 19 2010 08 00 05 Total On Time 0 Irit Colection Collections Errors Retries Type item Dis LastTimeSfamp LastStatus Cons Total Cons Total Descriptor Cwh2 Tree of configured controllers Status ba For Help press F1 lActive 0 Waiting 0 Configured 6 A This window pane can display either a list of the active nodes controllers for which collections are occurring right now or a list of nodes which are in Maintenance Mode or a list of nodes which are expe
171. ta File Conversion Utility ADD 62 Addendum to D5082 D5083 D5120 DATA_TAGS Section DATA_TAGS TAGI field_number attribute_name field_name TAG2 field_number attribute_name field_name TAGn field_number attribute_name field_name Where attribute_name is the name of the attribute 25 chars max and field_number is the number base 1 of the user field in the archive record The field_name is the name of the field in the archive record optional Example DATA_TAGS TAGI1 1 DIFF_PRESS DPRESS TAG2 2 STATIC_PRESS SPRESS TAG3 8 TEMPERATURE NOTE If a tag with a position and a signal name have been defined but is not associated with any attribute the attribute name should be NONE For example TAG4 4 NONE GV FLOW_MAX The PGAS export DLL will ignore the entries with NONE but it will issue a warning message Resulting XML Files An XML file created by the PGAS Export DLL contains data from a single station For example if the station represents a Meter that reports daily data the resulting XML file will have the following format lt xml version 1 0 gt lt PGAS_XML gt lt TRANSACTION gt lt METER METER_ID 20 0236 00 gt lt METER_CONFIG gt lt MTR_CONFIG_REC attributes gt lt METER_CONFIG gt lt MTR_VOLUME_DAILY gt lt MTR_VOLUME_DAILY_REC attributes gt lt MTR_VOLUME_DAILY gt lt METER gt lt TRANSACTION gt lt PGAS_XML gt If the station represents a Meter that repo
172. ta Type Target Node Name Type of Collection list 10 disabled Last Timestamp Date Time Last valid timestamp collected for Archives and Arrays or last time structure was collected for Lists Audits and Raw Arrays Last Error Text Error encountered on the last collection pass Max Retries Number Maximum number of Retries before marking a collection as failed Common List Number Number of the Common Signal Name List to associate with this list if zero signal names are collected from the node Reset Audit Yes No If set the Audit records collected are removed in the Audit buffer in the node Max Rows Number Max number of archive rows to collect per pass Push Rows Number Number of array rows to collect in the first message in the Pushdown Array scheme Multiple Array scheme array row collected this is the last array collected OpenBSI Harvester D 4 Appendix D Harvester Database Tables Common List Tables The Common List Tables contain signal names for signal lists in the controllers The user can configure these to eliminate the communications overhead of collecting the signal names The first table common lists table shows the number of the list then the number of entries in the list The second table common list signals table contains all of the signal names for all of the common lists Common Lists Table Number of signals in List 2 Common List Number n Number of signals in list n For e
173. ted tables To exit the dialog box click on the OK push button Addendum to D5082 D5083 D5120 ADD 69 Using the Data File Conversion Utility Data File Conversion Utility Initialization File DFCU INI Initialization information for the Data File Conversion Utility is stored in the file DFCU INI located in the system directory for NT users IMPORTANT Users should avoid editing this file and should use dialog boxes to change initialization parameters instead The only entries which may need to be edited directly in the INI file are the keep_files and minimize entry This file appears similar to the format shown below comments appear in italicized type and do not actually appear in the DFCU_INI file PARAMETER_SECTION time_interval 30 Time Interval see page 4 error_buffer 30 Error Buffer History Size see page 5 monitor 140 Monitor Size see page 5 copy_path C Program Data Bristol OpenBSI ACCOL Copy path see page 5 station_interval 1 Station Interval see page 5 keep_files 0 when keep_files 1 the Error Recovery Database will NOT be loaded or used by the utility If there is an error while exporting data the processing for that station will stop and the unexported station files will NOT be deleted from the directory or copied elsewhere When this method is used there is a chance that duplicate data might be exported to the configured DLLs because data which could not be exported will still be presen
174. ter can collect signal lists One of these lists may be the Configuration Signal List which contains any configuration parameters related to your particular application The configuration list generally contains information which does not change often because it is normally collected only on system startup if a change occurs or if the operator explicitly requests that it be collected In a natural gas pipeline application for example this list might contain signals whose values represent pipe diameters or orifice types NOTE Signal lists collected via the Harvester cannot have more than 1000 signals Radio Turn ON Time Logic If you are using radios as your communication link your program must include user defined logic to turn ON its radio at a pre determined time so as to be ready for data collection from the Harvester This pre determined time is calculated based on the node s local address its expanded node addressing group number and various parameters defined in the Harvester Appendix C of this manual includes a sample ACCOL task which may be used to turn on a Network 3000 controller s radio at a scheduled time For information on the turn on logic for the Harvester program see the box below Protected mode firmware PLSO0 PLX00 or newer currently only supports use of the EAudit Module 186 based units except for the 3308 with AL or newer firmware or 386EX Real Mode units with RMSO2 or newer firmware can be used with either
175. the Status of Your Collections Retries Cons The total number of consecutive communication retries made during this type of collection Retries Total The total number of communication retries made during this type of collection Controllers with Collection Errors If as the Harvester attempts to collect data from a particular controller an error occurs the icon for that controller will be surrounded by an red box Flow5 indicating that there are errors with the most recent collection Typically banal collection errors relate to communication problems or invalid configuration of the structures arrays archive etc in the controller NOTE If the Harvester is currently collecting data from a particular controller and a communication failure occurs prior to the collection being completed Harvester will store whatever partial valid data it was able to collect OpenBSI Harvester 44 Monitoring the Status of Your Collections Viewing Hiding the Tool Bar If desired you can remove the Tool Bar from the screen by clicking on View gt Toolbar To restore the Tool Bar repeat the same command Viewing Hiding the Status Bar If desired you can remove the Status Bar from the screen by clicking on View gt Status bar To restore the Status Bar repeat the same command Psa Viewing a List of the Controllers in which a Collection is Occurring Right Now To view a list of the controllers to which a collection is und
176. the data however it f 3 p must be converted to a format Data is collected Open asi Open BSI E compatible with the other software by the Collector Scheduler Harvester Data Collector Scheduler or packages Harvester Open BSI Communications Layer P i f t f The Data File Conversion Utility n R 1 ae Controller JA A provides this conversion capability Network p D o a it e e IMPORTANT If you are using the Harvester in addition to the Data Collector in the same OpenBSI system you must ensure that the files stored by these utilities are NOT in the same directory or there will be file conflicts 1 These files are sometimes referred to as UOI files because they follow the format used by the Universal Operator Interface software signal list data and audit trail data are stored in ASCII format data array entries and archive data are stored in binary format For more information on the internal structure of the files see Appendix C of the Universal Operator Interface Configuration Manual document D5074 2ASCII files may be viewed with any ASCII text editor For information on viewing binary array archive files see appendices in the OpenBSI Scheduler Manual document D5082 and OpenBSI Collection Export Utilities Manual document D5083 Addendum to D5082 D5083 D5120 ADD 1 Using the Data File Conversion Utility How Does the Conversion Process Work At a pre defined interval the Dat
177. the data in files on the PC hard disk Archive Files As an alternative to using data arrays some controllers support the use of historical archive files Archive files reside within the controller and are similar to data arrays except that each column is directly associated with a particular signal and each column also has a descriptive title See the ARC_STORE section of the ACCOL II Reference Manual document D4044 for details ControlWave users should see the ControlWave Designer on line help for the ARCHIVE function block Wherever possible we strongly recommend you use Archive Files for your historical storage NOTE When using the Harvester to collect Archive Files ina BSAP network the archive records to be displayed must be 220 bytes or less This is explained in more detail later in this manual OpenBSI Harvester 10 Configuring Your Controller EAudit Module Audit Function Block ACCOL users must configure the Extended Audit Trail Module EAudit This module is used to record alarm and event conditions and is discussed in detail in the Audit Trail EAudit section of the ACCOL II Reference Manual document D4044 Similarly ControlWave users must configure the AUDIT function block See the ControlWave Designer on line help in ControlWave Designer for details The alarm event data is collected by the Harvester and stored in files on the PC hard disk Signal Lists Configuration Signal List The Harves
178. type file consisting of three sections e The PARAMETERS section which includes parameters that help the PGAS Export DLL to interpret the type of data in the UOI type files e The MTR_CONFIG_TAGS section which holds the tags that will be used to name the attributes in a MTR_CONFIG_REC element in the resulting XML file e The DATA_TAGS section which holds the tags that will be used to name the attributes in MTR_VOLUME_REC MTR_VOLUME_DAILY_REC and GQ_PERIODIC_REC elements in the resulting XML file PARAMETERS Section TYPE type_attribute Where type_attribute is either METER or GAS_QUALITY period_attribute For type_attribute METER the period_attribute is either MTR_VOLUME_DAILY for daily data or MTR_VOLUME for hourly data For type_attribute GAS_QUALITY the period_attribute is GQ_PERIODIC If the TYPE keyword is not in the file METER MTR_VOLUME_DAILY is assumed STARTDATE value A value of 1 indicates that the START_DATE attribute will be included in the XML resulting record This is the default if the STARTDATE keyword is not in the file LOCSEQ value A value of 1 indicates that the SEQUENCE attribute will be included in the XML resulting record indicating the local sequence number of the archive record This is the default if the LOCSEQ keyword is not in the file TSSTORE value This keyword indicates how the timestamp was assigned to the archive record A value of 1 indicates At Store the timestamp assigned to th
179. udit Module or AUDIT function block for ControlWave signal lists and signals are discussed briefly below OpenBSI Harvester 6 Configuring Your Controller Data Arrays The Harvester collects data from an analog read Cell ol2 Cel3 Col4 Cally colle write data array or from multiple such arrays TIME F DP T Coa Na which share the same row column dimensions Row a0 Av These arrays are used to hold historical data Row2 9100 AM Rows 10C AM In most cases the first column of each analog read write array must contain a timestamp in the Julian format of the ACCOL system signal TIME 000 or the ControlWave _TIME_000 Row24 799 AM variable The remaining columns of each array row contain the actual data collected at the time designated by the timestamp in column 1 An example array is shown above which contains hourly flow data from a natural gas pipeline The type of data in the array will vary depending upon your particular application There are four basic methods of array storage each of which is discussed below Storage without Wrapping Push Down Arra Storage without wrapping means that the most recent data is always stored in row 2 of the data array and as new data is entered the previous data in row n is moved to row n with the data in the last row of the array discarded Note Row
180. udit records in the RTU that have already been collected Push_First number This is the number of pushdown array rows to collect during the first collection pass This should be set to match the number of rows of data generated within the controller that need to be collected on a given collection pass number can be either 0 or 1 default Common_List list_number If using a Common List list_number is the number of that signal list This can range from 1 default to 99999 If 0 collection occurs via signal names Wrap_Number num_arrays If using Wrap Multiple arrays this is the number of arrays used This can range from 1 default to 99999 OpenBSI Harvester This page is intentionally left blank Appendix F Harvester Error Messages A list of common Harvester error messages and their explanations is included below Error Message Cause Possible Remedy Error Archive File Not Found The specified archive file could not be collected because it did not exist in the RTU e Verify that you did configure an Archive file in the ACCOL load or ControlWave project with that number e Check to see that you specified the correct archive file number in the Item Number field of the Collection Configuration dialog box For ACCOL II users this number must match the value on the ARCHIVE terminal of the ARC_STORE module for ControlWave users this number must match the value on the
181. up the Node Configuration pages 17 OpenBSI Harvester Adding a Controller and Configuring Collections e The New Nodes list box displays a list of all controllers in your NETDEF database which have NOT yet been configured for use with the Harvester Select any one of these controllers by clicking on it e Optionally you can add multiple controllers at the same time by holding down the Ctrl key as you select This will cause all of the controllers you add to have the same collection configuration parameters you can alter them individually after the initial configuration is complete When you add multiple controllers via this method you will prompted to enter an Auto Increment value in seconds If your collection method is Time Interval the Auto Increment is KAJUJC Aii used to space out collections if collections from multiple You have selected multiple node configuration If you are using the Time Interval collection method controllers are scheduled to occur this field will auto increment the Time Interval Cancel within the same interval Offset between nodes configured Otherwise the Harvester would attempt to collect all the collections at the same time which could cause communication problems Auto Increment seconds You can adjust the offset for individual nodes later using the Offset in seconds parameter described on page 23 e Optionally if you have already configured another controller w
182. ured for collection at the same time Error Failed to lookup node status Node status could not be verified in OpenBSI e Check to see that the RTU is configured properly in OpenBSI This could also be caused by an internal error Error Failed to Turn on Polling Polling could not be turned on for this RTU e Check to see that the RTU is configured properly in OpenBSI e Check that the communication line is not already in use e This could also be caused by an internal error Error Invalid Maint Mode Signal The Maintenance Mode Signal configured in the Node Configuration dialog box is not set up correctly e Verify that the signal name entered in the dialog box is syntactically correct e Verify that this signal exists in the RTU and that it is a logical or BOOL signal e Verify that the signal is accessible Marked PDD for ControlWave e Verify that the signal is NOT inhibited Error Invalid Radio Off Signal The Communications Off Signal configured in the Node Configuration dialog box is not set up correctly e Verify that the signal name entered in the dialog box is syntactically correct e Verify that this signal exists in the RTU and that it is a logical or BOOL signal e Verify that the signal is accessible marked OpenBSI Harvester F 3 Appendix F Harvester Error Messages Error Message Cause Possible Remedy Error Modem Confirm Configuratio
183. utton to abandon the changes In either case you will return to the EXBBODBC DLL Setup dialog box From there click on either OK or Cancel to return to the Export Libraries page of the Data File Conversion Setup dialog box Click OK again and configuration is complete After you have activated the export process the Data File Conversion utility will insert the Collector Scheduler Harvester data directly into the database If a valid directory was specified in the Copy Path field of the Data File Conversion Setup dialog box the original unconverted files will be copied to the specified path where they will remain until they are either overwritten by additional files when file numbers wrap around or they are deleted by the user If no Copy Path is specified the original files will be deleted after conversion occurs to prevent the same files from being converted on subsequent conversion passes Using the Data File Conversion Utility ADD 26 Addendum to D5082 D5083 D5120 Exporting Data Using the OpenEnterprise Export OEEXP DLL The OEEXP DLL can take signal list data array archive data and audit trail data collected via the OpenBSI Scheduler OpenBSI Data Collector or OpenBSI Harvester and insert that data into a pre defined OpenEnterprise Database The signal list data is exported to the Real Time portion of the database the array archive and audit trail data is also exported to the Real Time portion of the database but it is
184. val The possible choices are minutes hours or days Interval_Offset interval_offset This specifies a period of time in seconds 0 to 86400 measured from the beginning of the interval that the Harvester will wait before OpenBSI Harvester Appendix E Harvester Initialization Files beginning its collection This is often necessary if arrays or archives are being updated in the controller every hour and it is necessary to wait this number of seconds for the array archive manipulation to be completed If left at the default of 0 the collection will begin at the very start of the interval The offset can also be used to space out collections if several collections from multiple controllers are scheduled to occur within the same interval Start_Coll_Date start_date start_date specifies from which date in the historical system data collection should start It should be expressed in the format mm dd yyyy where mm months dd days and yyyy years User_Time_1 user_timel User_Time_ 2 user_time2 User_Time_10 user_time10 When this is chosen the Harvester attempts to communicate with a particular node at up to ten user specified times during the day user_time must be specified as hh mm ss PM or hh mm ss AM depending upon whether the time is before or after 12 noon Collection1l coll_ 1 Collection2 coll_ 2 Cite E These identify the names of collections for this particular RTU
185. xample if there are three common lists numbered 10 20 and 42 and they have 8 2 and 7 signals in them respectively then the Common Lists Table would appear as follows Entries Common List Signals Table For the Common List Signals Table the table must include a list number identifying which Common List a signal belongs to and the signal name of each signal Field Name Data Type Description List Number Number Common List Number Signal Text Signal Name For example if you have two common lists numbered 1 and 2 each with four and three signals in them respectively the Common List Signals Table would appear similar to that shown below List Number Signal STATION FLOW STATION PRES 1 STATION TEMP OpenBSI Harvester D 5 Appendix D Harvester Database Tables List Number Signal STATION ACTIVE DAILY FLOW AVG DAILY TEMP AVG DAILY PRES AVG OpenBSI Harvester D 6 Appendix E HARVESTER Initialization Files HARVESTER INI The HARVESTER INI file which is located in the WINDOWS folder sets certain defaults for how the Harvester operates The format of the HARVESTER INI file is as follows TIMERS CONFIGVIEW_TIMER config_time MONVIEW_TIMER monitor_time RTUVIEW_TIMER rtu_time ONDEMAND_TIMER demand_time STATION station BROADCAST broadcast CRITICAL critical SILENTEXIT silent DEBUG ENABLE enable DISTRIBUTE INTERVAL interval STARTTIME1 time1 START
186. xport of the current file to be completed Monitoring the Progress of Conversions Viewing Error Histories The Data File Conversion Utility window is divided into two areas the Error History Area and the Monitor Area A slide bar between the two areas lets you adjust the relative size of the two areas i a Data File Conversion Utility ay x File View Expat Database Help ala xa ae ma Error History Area 01 07 99 13 47 06 VALLEY Exporting Remate Configuration List Source CFGLIST LS 9 13 47 06 VALLEY Files Copied to Temporary Directory UOI File Base Name 13 40 04 VALLEY Exporting Data Array Records Source ARAY A15 13 40 04 VALLEY Files Copied to Temporary Directory UOI File Base Name 13 46 04 VALLEY Exporting Audit Data Records Source MYAUD E13 13 46 04 VALLEY Files Copied to Temporary Directory UOI File Base Name H 13 48 04 VALLEY Big enien Remote Configuration List Source CFGLIST L5 Monitor Area 13 48 05 VALLEY Files Copied to Temporary Directory VOI File Base Name 01 07 99 13 48 16 VALLEY Exporting Audit Data Records Source MYAUD F13 01707799 13 48 16 VALLEY Files Copied to Temporary Directory UOI File Base Name z For Help press F1 ie Arus 7 Error History Buffer Area Associated with each station name is an error history buffer which contains any error messages generated during the file conversions for that particular station name The contents of the error history buffers m
187. y Item Number This is the number of the first array in the group of multiple arrays to be collected All arrays in the group must be consecutively numbered from this first array number Flags Disable When checked will stop this collection from occurring View TimeStamp in RTU When checked will display the most recently collected Tree timestamp Last Timestamp from this controller in the tree of nodes on the left hand side of the main Harvester window NOTE Even if there are multiple collections for a controller only one collection timestamp will be displayed 33 OpenBSI Harvester Adding a Controller and Configuring Collections Communications Max Retries Per Pass This specifies the total number of attempts the Harvester will make to collect data from this controller on a given collection pass A retry occurs if there is a communication timeout Max Rows Collected Per Pass This specifies the maximum number of array rows which the Harvester will attempt to collect from the controller on a given collection pass Special Parms Number of Multiple Arrays This is the total number of arrays to be collected OpenBSI Harvester 34 Adding a Controller and Configuring Collections Specifying Distributed User On Times OpenBSI 5 0 and newer The Harvester can be configured to collect data from an RTU at a pre defined set of times during the day In systems with a very large number of RTUs however it may be tedious for t
188. y aborting the current collection Error Common List Read A problem occurred while trying to read the Common List in the RTU e Verify that a list with the number specified in the Common List Configuration dialog box actually exists in the RTU and that the names of the signals in that list match the ones defined in the Common List Configuration dialog box and that they are in the correct order e Verify that all the signals in the list can be collected For ControlWave users this means that they must have been their PDD check box marked Error Comm Send Failure Error Comm Timeout The Harvester could not communicate with the specified RTU e Verify that the RTU is on line and communicating The RTU did not respond within the expected period of time e Verify that the RTU is on line and communicating and that timeouts are not set too short Error Crop Write Failure Failure to update field with new timestamp Error Dial Comm Line Busy The phone line used for dial up is already is use e Check to see that another RTU is not using the line If it is check to see if hang up parameters may be improperly configured OpenBSI Harvester F 2 Appendix F Harvester Error Messages Error Message Cause Possible Remedy e fusing one of the On Times features to collect data at specified times during the day check to see if there might be too many RTU s config
189. you previously used the EXBBODBC DLL in OpenBSI Version 3 1 and you are upgrading to OpenBSI Version 3 2 or newer you will need to modify the schema of the database created under 3 1 to be compatible with OpenBSI 3 2 To do so you must use the Table Definition dialog box in the Data Storage Configuration utility to explicitly create a column to hold the STATION name this column must be mapped to field 0 In OpenBSI 3 1 this was unnecessary because a station name column was created automatically Also if you previously used the STATION as part of the primary key you must select Designate Column As Part of Primary Key in the Table Definition dialog box The EXPDLL INI file does not have to be configured for the Extended Access EXBBODBC DLL Configuration of station names and the steps described below must be performed There are three major steps which must be accomplished in order to use the Extended Access EXBBODBC DLL 1 Select the EXBBODBC DLL from the Export DLLs list box of the Data File Conversion Setup dialog box 2 Configure the DLL via the EXBBODBC DLL Setup dialog box accessible via the Configure push button 3 Use the Data Storage Configuration utility to create a database schema which maps data record fields from the collected data files to specific columns in tables of your database The Data Storage Configuration utility is accessed from the Configure Schema push button of the EXBBODBC DLL Setup dia

OpenBSI Harvester Manual (D5120)

Contents

Download Pdf Manuals

Related Search

Related Contents