................................................................................................................................... 16Definition of rules
................................................................................................................................... 22Configuration of Chatter Notification Engine
................................................................................................................................... 26Configuration of the Rules Engine
................................................................................................................................... 29Configuration of the SCADA plug-in
................................................................................................................................... 37Configuration of the STORMFLOW plug-in
Naming objects in a SCADA system
................................................................................................................................... 48Spredsheet for object names
................................................................................................................................... 52Import-file for object names
Creating Stormflow data
................................................................................................................................... 55Spreadsheet for stormflow data
................................................................................................................................... 56Import file for stormflow data
4
15
39
54
IGSS only information
................................................................................................................................... 59Creation of objects in IGSS 8
................................................................................................................................................................... 62String type objects
63
64
3
GB CHATTER NOTIFICATION CONFIGURATION 1303
Area
Phone
e-mail
Europe
+45 45 56 06 56
mjk@mjk.com
Denmark
+45 45 56 06 56
mjk@mjk.dk
Norway
+47 69 20 60 70
mjk@mjk.no
Sweden
+46 53 31 77 50
kontoret@mjk.se
Netherlands
+31 251 672171
mjknl@mjk.com
Ireland
+353 8795 35625
mke@mjk.com
USA
+1 847 482 8655
mjkusa@mjk.com
Australia
+61 3 9758 8533
ns@mjk.com
Item number
Description
840128-2008R2-001
2008 R2, release 001
Revision
Revisions
001
First release in this format
Introduction
system to meet your requirements.
To ensure the best result MJK recommends that the user reads this manual to become familiar with all features,
Configure the system as instructed by the manufacturer, MJK Automation ApS, to ensure reliable operation and
accurate measurements.
You can always get in touch with your supplier or with an MJK support hotline for advice and guidance:
MANUAL
Visit our website www.mjk.com to read more about MJK Automation ApS, our other products and the people behind.
system.
Ordering
Brief revision history
4
GB CHATTER NOTIFICATION CONFIGURATION 1303
MANUAL
5
System overview
GB CHATTER NOTIFICATION CONFIGURATION 1303
MANUAL
6
GB CHATTER NOTIFICATION CONFIGURATION 1303
Description
System. It treats the measurement or the alarm according to a set of rules. The rules tests the new measurement
or alarm, and decides - according to its origin - how to treat it.
A verbal description of a rule could be:
by the SCADA plug-in and the result forwarded to the SCADA-system.
Chatter Notification Engine - the component which receives the measurement or the alarm
Chater Rules Engine - the component which determines the further treatment of the measurement or alarm
SCADA plug-in - the component which treats data before forwarding them to the SCADA-system
STORMFLOW plug-in - the component which calculates numbers, durations and amount of spill during stormflows
based on a level measurement. The results is forwarded to a SCADA system.
MANUAL
16
7
GB CHATTER NOTIFICATION CONFIGURATION 1303
MANUAL
System description
System. It treats the measurement or the alarm according to a set of rules. The rules tests the new measurement or
alarm, and decides - according to its origin - how to treat it.
A verbal description of a rule could be:
the SCADA plug-in and the result forwarded to the SCADA-system.
Chatter Notification Engine - the component which receives the measurement or the alarm
Chater Rules Engine - the component which determines the further treatment of the measurement or alarm
SCADA plug-in - the component which treats data before forwarding them to the SCADA-system
STORMFLOW plug-in - the component which calculates numbers, durations and amount of spill during stormflows
based on a level measurement. The results is forwarded to a SCADA system.
8
Stormflow processing overview
GB CHATTER NOTIFICATION CONFIGURATION 1303
MANUAL
9
GB CHATTER NOTIFICATION CONFIGURATION 1303
Description
A stormflow starts when a water level has exceeded a preset maximum for a certain period of time.
A stormflow stops when the level has been below a preset level for a certain period of time.
MANUAL
10
Stormflow - Float switch
GB CHATTER NOTIFICATION CONFIGURATION 1303
MANUAL
11
Stormflow - Pressure transmitter
GB CHATTER NOTIFICATION CONFIGURATION 1303
MANUAL
12
GB CHATTER NOTIFICATION CONFIGURATION 1303
MANUAL
13
GB CHATTER NOTIFICATION CONFIGURATION 1303
Not all available plug-in may be used in your installation
MANUAL
Functions overview
General
If new data is detected, they are treated by a Chater Rules Engine, which determines - according to a set of rules which plug-in will treat the data.
Plug-in's
received from Chater Rules Engine
SCADA plug-in
This plug.-in receives data from Chater Rules Engine and creates a file with comma-separated values from the data. This
file with comma-separated values contains measurement or alarm data which is delivered to various SCADA-systems.
The current version will supply data for:
7-Tedhnologies IGSS32 release 8 with DDHC Data FileDriver (Driver ID 66) installed.
7-Tedhnologies IGSS32 release 9 with DDHC Data FileDriver (Driver ID 66) installed.
System
BV Electronics System 2000
STORMFLOW plug-in
This plug-in receives data from Chater Rules Engine and creates a file with comma-separated values from the data. This
file with comma-separated values contains data on stormflows which is delivered to various SCADA-systems.
The current version will supply data for:
7-Tedhnologies IGSS32 release 8 with DDHC Data FileDriver (Driver ID 66) installed.
7-Tedhnologies IGSS32 release 9 with DDHC Data FileDriver (Driver ID 66) installed.
System
BV Electronics System 2000
14
Detailed configuration
Step
Desription
1
Configure the Chatter Notification Engine to use the correct database.
Information about setting up the engine are found in this chapter.
2
Define at least one rule in the configuration file cnsRulesEngineGlobalConfig.xml.
Information about how to set up rules are in this chapter.
Step
Desription
1
Create at least one rule in the range 0 - 1999 the configuration file
cnsSCADAplugInGlobalConfig.xml.
Information about how to set up rules are in this chapter.
2
Create a corresponding entry in the cnsSCADAobjects table in the database
Information about how to create and name objects in the database are in this chapter
3
Configure the SCADA plug-in to deliver its output data in a place to suit your needs
Information about how to configure this are in this chapter
Step
Desription
1
Create at the 2;M;1;0;M; rule in the configuration file
cnsRulesEngineGlobalConfig.xml.
Information about how to set up rules are in this chapter.
2
Create the necessary entries in the cnsSCADAobjects table in the database
Information about how to create and name objects in the database are in this chapter
3
Configure the STORMFLOW plug-in settings to suit your needs.
Information about how to configure this are in this chapter
General
SCADA plug-in
GB CHATTER NOTIFICATION CONFIGURATION 1303
MANUAL
22
16
16
39
29
STORMFLOW plug-in
16
39
37
15
Definition of rules
#
Description
1;
The first element of the rule is 1, thus the data will be processed by the SCADA plug-in
M;
The second element of the rule is M, thus data must come from a Modbus input on any MJK
1;
The third element of the rule is 1, thus data must come from Modbus input number 1 on any
0;
The fourth element of the rule is 0, thus the SCADA plug-in will output the measured value
M;
The fifth element of the rule is M, thus data must come from a measurement.
#
Description
1;
The first element of the rule is 1, thus the data will be processed by the SCADA plug-in
M;
The second element of the rule is M, thus data must come from a Modbus input on any MJK
1;
The third element of the rule is 1, thus data must come from Modbus input number 1 on any
1024;
The fourth element of the rule is 1024, thus the SCADA plug-in will output the GSM signal
M;
The fifth element of the rule is M, thus data must come from a measurement.
C:\Program Files (X86)\MJK Automation\Chatter - Notification Service
cnsRulesEngineGlobalConfig.xml
#1
Description
1;
Data will be treated by the SCADA plug-in
Rules definition
A rule
measurements or alarms - are processed.
system.
they will be processed by the rule, if not, they will be ignored.
System operate.
Example number one
GB CHATTER NOTIFICATION CONFIGURATION 1303
MANUAL
Example number two
Definition of rules
Rules are kept in this file:
First element - process where?
The first element is a digit designating which plug-in will process the data coming from this rule:
16
2;
Data will be treated by the STORMFLOW plug-in
Second element - input type
#2
Description
D;
Data must come from a digital input
A;
Data must come from a analog input
C;
Data must come from a counter on a digital input
M;
Data must come from a Modbus input
I;
Data must come from an internal measurement
#3
Description
1;
Data must come from X-input number 1
2;
Data must come from X-input number 2
3;
Data must come from X-input number 3
4;
Data must come from X-input number 4
measurement or alarm which is processed by this rule.
#4
From
Description
0;
comma-separated values.
1000;
Chatter
Output the battery voltage in mV from the internal battery in the current MJK
1001;
Chatter
Output the GSM signal strength as a value between 1 and 31 as recorded for
Value
Description
1 - 14
The signal strength is marginal
15 - 19
The signal strength is is acceptable
20 - 24
The signal strength is is good
25 - 31
The signal strength is is excellent
1002;
Chatter
reset to the file with comma-separated values.
for this rule:
Third element - input number
data for this rule:
GB CHATTER NOTIFICATION CONFIGURATION 1303
MANUAL
Fourth element - data output
The fourth element is a number designating which data, this rule will output to a recipient, typically a SCADA-system.
Data output is divided into three different groups;
marked with a Chatter in the table below.
Database in the table below.
Output of data from the STORMFLOW plug-in, marked with an Stormflow in the table below.
17
GB CHATTER NOTIFICATION CONFIGURATION 1303
1003;
Chatter
measurement or alarm to the file with comma-separated values.
1004;
Database
the file with comma-separated values.
1005;
Database
Logger to the file with comma-separated values.
1006;
Database
Logger is located to the file with comma-separated values. Used mostly at
waterworks.
1007;
Database
Data Logger to the file with comma-separated values.
1008;
Database
Output the name from the middle level in the location for the current MJK
1009:
Database
Output the name from the lowest level in the location for the current MJK
1010;
Database
with comma-separated values.
1011;
Database
Output the signal type which is the origin of the data to the file with commaseparated values.
1012;
Database
Output the signal number which is the origin of the data to the file with commaseparated values.
1013;
Database
with comma-separated values.
1014;
Database
file with comma-separated values.
1015;
Database
Logger to the file with comma-separated values.
1016;
Database
file with comma-separated values.
1017;
Database
the file with comma-separated values.
1018;
Database
the file with comma-separated values.
1019;
Database
Output the flag telling if Minimum Threshold is enabled in the current MJK
1020;
Database
Output the flag telling if Maximum Threshold is enabled in the current MJK
1021;
Database
with comma-separated values.
1022;
Database
comma-separated values.
1023:
Database
server to the file with comma-separated values.
1024;
Chatter
Data Logger converted from mV to V to the file with comma-separated values.
1025;
Chatter
Output the GSM signal strength converted to dBm as recorded for the current
MANUAL
18
GB CHATTER NOTIFICATION CONFIGURATION 1303
Value
Converted to dBm
0
-113 dBm
1
-111 dBm
2 - 30
-109 dBm til -53dBm in steps of -2 dBm
31
-51 dBm
1026;
Database
measurement or alarm, converted to seconds since midnight, January 1st, 1970
using the local time zone, to the file with comma-separated values
1027;
Database
measurement or alarm, converted to seconds since midnight, January 1st, 1970
using UTC, to the file with comma-separated values
1028;
Database
server, converted to seconds since midnight, January 1st, 1970 using the local
time zone, to the file with comma-separated values.
1029;
Database
server, converted to seconds since midnight, January 1st, 1970 using UTC, to the
file with comma-separated values.
Numbers above 2000 are usable only if the installation contains the
STORMFLOW plug-in
2000;
Stormflow
Output the start time for the first stormflow within the last 24 hours to the file with
comma-separated values.
2000 must always be in the cnsSCADAobjects table whether it is
used or not!
2001;
Stormflow
Output the end time for the last stormflow within the last 24 hours to the file with
comma-separated values.
2002;
Stormflow
Output the duration of all stormflows within the last 24 hours to the file with
comma-separated values.
2003;
Stormflow
Output the number of sub-stormflows within the last 24 hours to the file with
comma-separated values.
2004;
Stormflow
Outputs the number of stormflows within the last 24 hours to the file with commaseparated values.
2005;
Stormflow
Outputs the total number of stormflows since system start to the file with commaseparated values.
2006;
Stormflow
Outputs the total duration of stormflows since system start to the file with
comma-separated values.
2007;
Stormflow
Outputs the amount of spill in litres within the last 24 hours to the file with
comma-separated values.
2008;
Stormflow
Outputs the amount of spill in m3 within the last 24 hours to the file with commaseparated values.
2009;
Stormflow
Outputs the total amount of spill in litres since system start to the file with
comma-separated values.
2010;
Stormflow
Outputs the total amount of spill in m3 since system start to the file with commaseparated values.
2011;
Stormflow
Outputs the momentary flow at log-time in litres pr. second to the file with
comma-separated values.
2012;
Stormflow
Outputs the momentary flow at log-time in m3 pr. second to the file with commaseparated values.
MANUAL
19
GB CHATTER NOTIFICATION CONFIGURATION 1303
2013;
Stormflow
Outputs the momentary flow at log-time in m3 pr. minute to the file with commaseparated values.
2014;
Stormflow
Outputs the momentary flow at log-time in m3 pr. hour to the file with commaseparated values.
2015;
Stormflow
Output the start time for the latest, completed stormflow to the file with commaseparated values.
2016;
Stormflow
Output the end time for the latest, completed stormflow to the file with commaseparated values.
2017;
Stormflow
Output the duration for the latest, completed stormflow to the file with commaseparated values.
2018;
Stormflow
Output the number of sub-stormflows for the latest, completed stormflow to the
file with comma-separated values.
2019;
Stormflow
Outputs the amount of spill in litres for the latest, completed stormflow to the file
with comma-separated values.
2020;
Stormflow
Outputs the amount of spill in m3 for the latest, completed stormflow to the file
with comma-separated values.
2021;
Stormflow
Output the start time for the first stormflow within the last 24 hours, converted to
seconds since midnight, January 1st, 1970 using UTC, to the file with comma-
separated values.
2022;
Stormflow
Output the start time for the first stormflow within the last 24 hours, converted to
seconds since midnight, January 1st, 1970 using the local time zone, to the file
with comma-separated values.
2023;
Stormflow
Output the end time for the last stormflow within the last 24 hours, converted to
seconds since midnight, January 1st, 1970 using UTC, to the file with comma-
separated values.
2024;
Stormflow
Output the end time for the last stormflow within the last 24 hours, converted to
seconds since midnight, January 1st, 1970 using the local time zone, to the file
with comma-separated values.
2025;
Stormflow
Output the start time for the latest, completed stormflow , converted to seconds
since midnight, January 1st, 1970 using UTC, to the file with comma-separated
values.
2026;
Stormflow
Output the start time for the latest, completed stormflow, converted to seconds
since midnight, January 1st, 1970 using the local time zone, to the file with
comma-separated values.
2027;
Stormflow
Output the end time for the latest, completed stormflow , converted to seconds
since midnight, January 1st, 1970 using UTC, to the file with comma-separated
values.
2028;
Stormflow
Output the end time for the latest, completed stormflow , converted to seconds
since midnight, January 1st, 1970 using the local time zone, to the file with
comma-separated values.
Numbers 2029 to 2032 requires the Alarm interval in the MJK
2029;
Stormflow
Outputs the momentary flow at log-time in litres pr. second for the for the
current, ongoing stormflow to the file with comma-separated values.
2030;
Stormflow
Outputs the momentary flow at log-time in m3 for the for the current, ongoing
stormflow to the file with comma-separated values.
2031;
Stormflow
Outputs the summed amount of spill in litres for the for the current, ongoing
stormflow to the file with comma-separated values.
2032;
Stormflow
Outputs the summed amount of spill in m3 for the for the current, ongoing
stormflow to the file with comma-separated values.
If this configuration file is modified, the Chatter - Notification Service must be restarted
C:\Program Files\MJK Automation\Chatter - Notification Service
cnsNotificationEngineGlobalConfig.xml
Key
Description
cnsVersion
This key contains the version number of this configuration file. The key is used by
Do not change the values in this key without
consulting MJK Automation ApS!
Example:
<cnsVersion>
003
</cnsVersion>
Key
Description
cnsServiceDependencies
This key describes which services must be present and running before Chatter
Notification Engine can start.
The value is a list of service names:
Value
Service
MSSQLSERVER
Microsoft SQL server 2008 R2
MSSQL$SQLEXPRES
S
Microsoft SQL server 2008 R2 Express Edition
SQL Server
Example:
<cnsServiceDependencies>
MSSQLSERVER
</cnsServiceDependencies>
Configuration of Chatter Notification Engine
How Chatter Notification Engine is working is described in a configuration file. This file is a text file in XML format
It will expect that Microsoft SQL server 2008 R2 Express Edition is running
It will log on to the database using a valid connection string
It will check for new, untreated data every 30 seconds
It will update its 'alive' record every 10 minutes
It will maintain a log file with a specific name in a specific folder on the local hard disk
Filename and -location
MANUAL
22
GB CHATTER NOTIFICATION CONFIGURATION 1303
SQL Express
Example:
<cnsServiceDependencies>
MSSQL$SQLEXPRESS
</cnsServiceDependencies>
Key
Description
cnsDBconnectionString
This key describes the information needed by Chatter Notification Engine for it to
The key must contain:
Data Source = The name of the database engine
Initial Catalog = The name of the database
Integrated Security = Log-on security
SQL Server
Example:
<cnsDBconnectionString>
Data Source=.; Initial Catalog=ChatterDB; Integrated
Security=yes;
</cnsDBconnectionString>
SQL Express
Example:
<cnsDBconnectionString>
Data Source=.\SQLEXPRESS; Initial Catalog=ChatterDB;
Integrated Security=yes;
</cnsDBconnectionString>
Key
Description
cnsNEscanInterval
This key describes how often Chatter Notification Engine will check for new,
untreated data in certain tables in the database.
The value is a number of seconds, valid values are 0 to 86400:
Value
Description
0
Chatter Notification Engine never checks for new,
untreated data in the database.
1
Chatter Notification Engine checks for new, untreated
data in the database every second.
+++
84600
Chatter Notification Engine checks for new, untreated
data in the database every 24 hours.
MANUAL
23
GB CHATTER NOTIFICATION CONFIGURATION 1303
Example:
<cnsNEscanInterval>
10
</cnsNEscanInterval>
Text
Text
cnsScanDatabaseTables
by Chatter Notification Engine for new alarms or measurements.
Do not change the values in this key without
consulting MJK Automation ApS!
Name
Table
cnsAlarmLog
cnsAlarmLog
cnsMeasurementLog
cnsMeasurementLog
Example:
<cnsScanDatabaseTables>
cnsAlarmLog
cnsMeasurementLog
</cnsScanDatabaseTables>
Key
Description
cnsKeepAliveInterval
This key describes how often a software component - Chatter Notification Engine
or a plug-in - will update a record in the table cnsModuleStatus
Database to tell that it is still 'alive'
The value is a number of minutes, valid values are 0 to 1400:
Value
Description
0
A software component never tells if it is 'alive'
1
A software component tells if it 'alive' every minute
+++
1440
A software component tells if it 'alive' every 24 hours
Example:
<cnsKeepAliveInterval>
10
</cnsKeepAliveInterval>
Text
Text
cnsNotificationLogFile
This key describes the name of and the path to the Chatter Notification Engine log
file.
The folder must exist, it will NOT be created by
Chatter Notification Engine.
MANUAL
24
The value is a string representing a fully qualified file name:
If this configuration file is modified, the Chatter - Notification Service must be restarted
C:\Program Files\MJK Automation\Chatter - Notification Service
cnsRulesEngineGlobalConfig.xml
Key
Description
cnsVersion
This key contains the version number of this configuration file. The key is used by
Do not change the values in this key without
consulting MJK Automation ApS!
Example:
<cnsVersion>
003
</cnsVersion>
Key
Description
cnsAvailablePlugIns
This key describes which plug-in's are available for the Chater Rules Engine.
The value is a list of an identification number for plug-in and a name of a plug-in.
The identification number and the plug-in name is separated by a semicolon.
ID
Plug in name
0;
Not known
1;
SCADA plug-in
2;
STORMFLOW plug-in
If you specify a plug-in which is not installed, the
Chatter Notification Engine will not start, and you
will get an error like this in the logfile;
Rules Engine: Plugin <PluIn name> failed to initialize - stopping
EventLog: Rules Engine: Plugin <PluIn name> failed to initialize stopping
MANUAL
Configuration of the Rules Engine
Detailed configuration of Chater Rules Engine
This configuration file describes how data received by Chatter Notification Engine will be treated. This file is a text file in
XML format
The rules shown in the sample configuration file below will treat data like this:
Measurement values from Modbus input number 1 is sent to a SCADA-system
The log time for the measurement is sent to a SCADA-system
Description of the configuration file for Chater Rules Engine
Table header
26
24
Terminating NEengine
Notification Engine: Stopping service
Key
Description
cnsTriggers
This key contains five values, separated by a semicolon
An identification number for the plug-in treating data from this rule.
data to this rule.
data to this rule.
A digit pointing at a supplementary data element
A letter describing the type of data, either a measurement or an alarm,
supplying data to this rule.
First element
The first element is a digit, the identification number for the plug-in treating data
from this rule:
#1
Description
0;
Data will not be treated by any plug-in
1;
Data will be treated by the SCADA plug-in
2;
Data will be treated by the STORMFLOW plug-in
Second element
Data Logger supplying data to this rule.:
#2
Description
D;
a digital input
A;
Data must come from an analog input
C;
Data must come from a counter on a digital input.
M;
Data must come from a Modbus input
I;
Data must come from an internal measurement
Third element
Logger supplying data to this rule.
#3
Description
1;
Data must come from X-input number 1
2;
Data must come from X-input number 2
3;
Data must come from X-input number 3
4;
Data must come from X-input number 4
Fourth element
The fourth element is a digit pointing at a supplementary data element
Fifth element
The fifth element is a letter describing the source of data, either an alarm or a
measurement:
If this configuration file is modified, the Chatter - Notification Service must be restarted
C:\Program Files\MJK Automation\Chatter - Notification Service
cnsSCADAplugInGlobalConfig.xml
Key
Description
cnsVersion
This key contains the version number of this configuration file. The key is used by
Do not change the values in this key without
consulting MJK Automation ApS!
Example:
<cnsVersion>
003
</cnsVersion>
Key
Description
cnsSCADAsystemName
This key describes which type of SCADA-system, the SCADA plug-in will supply
data for.
The value is a string representing the name of the SCADA-system.
Value
Description
IGSS
The output from SCADA plug-in wil be in a format
acceptable to IGSS32 release 8 or IGSS32 release 9
IFIX
The output from SCADA plug-in wil be in a format
acceptable to GE Proficy iFix version 5 Historian
BV2000
The output from SCADA plug-in wil be in a format
acceptable to BV Electronics System 2000
Example:
<cnsSCADAsystemName>
IGSS
</cnsSCADAsystemName>
Key
Description
cnsCSVifixTagFile
This key describes the name of and the path to a file with comma-separated
values with tag-names from the SCADA plug-in exported to the GE Proficy iFix
version 5 Historian SCADA-system.
Configuration of the SCADA plug-in
Detailed configuration of SCADA plug-in
How SCADA plug-in is working is described in a configuration file. This file is a text file in XML format
Filename and -location
Description of the configuration file for SCADA plug-in
MANUAL
29
GB CHATTER NOTIFICATION CONFIGURATION 1303
The folder must exist, it will NOT be created by
SCADA plug-in.
The value is a string representing a fully qualified file name:
Example, located on a local hard disk:
<cnsCSVifixTagFile>
c:\csv\tags.csv
</cnsCSVifixTagFile>
Key
Description
cnsCSVifixTagName
This key describes the character string used as section header in the file with
comma-separated values exporting tag-names to the GE Proficy iFix version 5
Historian SCADA-system.
The value is a string representing the name of the section header. The default
value is [Tags]
Example:
<cnsCSVifixTagName>
[Tags]
</cnsCSVifixTagName>
Key
Description
cnsCSVifixDataName
This key describes the character string used as section header in the file with
comma-separated values exporting data to the GE Proficy iFix version 5 Historian
SCADA-system.
The value is a string representing the name of the section header. The default
value is [Data]
Example:
<cnsCSVifixDataName>
[Data]
</cnsCSVifixDataName>
Key
Description
cnsCSVifixTagHeader
This key describes the character string used as a field header in the file with
comma-separated values exporting tag-names to the GE Proficy iFix version 5
Historian SCADA-system.
The value is a string representing the content of the field header.
This key describes the character string used as a field header in the file with
comma-separated values exporting data to the GE Proficy iFix version 5 Historian
SCADA-system.
MANUAL
30
The value is a string representing the content of the field header.
Example:
<cnsCSVifixDataHeader>
Tagname,TimeStamp,Value
</cnsCSVifixDataHeader>
Key
Description
cnsCSVdateFormat
This key describes how dates are formatted in the file with comma-separated
values, delivered to the GE Proficy iFix version 5 Historian SCADA-system.
The value is a string representing the date format:
Value
Description
DMYY
Exports the date as
the day of the month as a number without a leading
zero (1-31)
the month as a number without a leading zero (1-12)
the year as a two-digit number (00-99).
DDMMYY
Exports the date as
the day of the month as a number with a leading
zero (01-31)
the month as a number with a leading zero (01-12)
the year as a two-digit number (00-99).
DDMMYYYY
Exports the date as
the day of the month as a number with a leading
zero (01-31)
Displays the month as a number without a leading
zero (1-12)
Displays the year as a four-digit number (0000-
9999).
+++
MDYY
Exports the date as
the month as a number without a leading zero (1-12)
the day of the month as a number without a leading
zero (1-31)
the year as a two-digit number (00-99).
MMDDYY
Exports the date as
the month as a number with a leading zero (01-12)
the day of the month as a number with a leading
zero (01-31)
the year as a two-digit number (00-99).
+++
YYMMDD
Exports the date as
the year as a two-digit number (00-99)
the month as a number with a leading zero (01-12)
the day of the month as a number with a leading
zero (01-31).
YYYYMMDD
Exports the date as
the year as a four-digit number (0000-9999)
the month as a number with a leading zero (01-12)
the day of the month as a number with a leading
zero (01-31).
GB CHATTER NOTIFICATION CONFIGURATION 1303
MANUAL
31
GB CHATTER NOTIFICATION CONFIGURATION 1303
Example:
<cnsCSVdateFormat>
DDMMYY
</cnsCSVdateFormat>
Key
Description
cnsCSVdateDelimiter
This key describes which character is used between the various elements in the
date when it is exported to the GE Proficy iFix version 5 Historian SCADA-system
The value is a single character, the value depends on the type of SCADA-system,
you will supply data to.
Example:
<cnsCSVdateDelimiter>
/
</cnsCSVdateDelimiter>
Key
Description
cnsCSVtimeFormat
This key describes how time is formatted in the file with comma-separated values,
delivered to the GE Proficy iFix version 5 Historian SCADA-system
The value is a string representing the time format:
Value
Description
HM
Exports the time as
the hour without a leading zero (0-23)
the minute without a leading zero (0-59).
HHMM
Exports the time as
the hour with a leading zero (00-23)
the minute with a leading zero (00-59).
+++
HMS
Exports the time as
the hour without a leading zero (0-23)
the minute without a leading zero (0-59)
the second without a leading zero (0-59).
HHMMSS
Exports the time as
the hour with a leading zero (00-23)
the minute with a leading zero (00-59)
the second with a leading zero (00-59).
Example:
<cnsCSVtimeFormat>
HHMM
</cnsCSVtimeFormat>
Key
Description
cnsCSVtimeDelimiter
This key describes which character is used between the various elements in the
time when it is exported to the GE Proficy iFix version 5 Historian SCADA-system
The value is a single character, the value depends on the type of SCADA-system,
you will supply data to.
MANUAL
32
GB CHATTER NOTIFICATION CONFIGURATION 1303
Example:
<cnsCSVtimeDelimiter>
:
</cnsCSVtimeDelimiter>
Key
Description
cnsDeleteOldRecords
This key describes how long times processed records will remain in the database
before they are deleted by the SCADA plug-in
The value is a number of days, valid values are 0 to 365:
Value
Description
0
SCADA plug-in never deletes processed records
1
SCADA plug-in deletes processed records after one
day
+++
365
SCADA plug-in deletes processed records after one
year
Example:
<cnsDeleteOldRecords>
30
</cnsDeleteOldRecords>
Key
Description
cnsCSVfile
This key describes the name of and the path to the file with comma-separated
values with data from the SCADA plug-in to the SCADA-system
The folder must exist, it will NOT be created by
SCADA plug-in.
The value is a string representing a fully qualified file name:
Example, located on a local hard disk:
<cnsCSVfile>
c:\csv\data.txt
</cnsCSVfile>
Example, located on a network share:
<cnsCSVfile>
\\Server1\csv\scada.txt
</cnsCSVfile>
Key
Description
cnsTempCSVfile
This key describes the name of and the path to a temporary file with commaseparated values with data from the SCADA plug-in. Data is kept in this
temporary file until the SCADA-system is ready to receive new data.
MANUAL
33
GB CHATTER NOTIFICATION CONFIGURATION 1303
The folder must exist, it will NOT be created by
SCADA plug-in.
The value is a string representing a fully qualified file name:
Example, located on a local hard disk:
<cnsCSVtempFile>
c:\csv\tempdata.txt
</cnsCSVtempFile>
Example, located on a network share:
<cnsCSVtempFile>
\\Server1\csv\tempdata.txt
</cnsCSVtempFile>
Key
Description
cnsICSVcontent
This key describes to values used internally by SCADA plug-in, used to identify
the actual measurement.
Do not change the values in this key without
consulting MJK Automation ApS!
This key describes which character is used to separate fields in the file with
comma-separated values, delivered to the SCADA-system
The value is a single character, the value depends on the type of SCADA-system,
you will supply data to.
Example:
<cnsCSVfieldDelimiter>
;
</cnsCSVfieldDelimiter>
Key
Description
cnsDecimalDelimiter
This key describes which character is used to separate the integer and the
fraction part of decimal values in the file with comma-separated values, delivered
to the SCADA-system
The value is a single character, the value depends on the type of SCADA-system,
you will supply data to.
MANUAL
34
Example:
<cnsCSVdecimalDelimiter>
.
</cnsCSVdecimalDelimiter>
Key
Description
cnsTextQualifier
This key describes which character is used before and after a text in the file with
comma-separated values, delivered to the SCADA-system
The value is a single character, the value depends on the type of SCADA-system,
you will supply data to.
If this configuration file is modified, the Chatter - Notification Service must be restarted
C:\Program Files\MJK Automation\Chatter - Notification Service
cnsSCADAplugInGlobalConfig.xml
Key
Description
cnsVersion
This key contains the version number of this configuration file. The key is used by
Do not change the values in this key without
consulting MJK Automation ApS!
Example:
<cnsVersion>
003
</cnsVersion>
Key
Description
cnsDeleteOldRecords
This key describes how long times processed records will remain in the database
before they are deleted by the STORMFLOW plug-in
The value is a number of days, valid values are 0 to 365:
Value
Description
0
STORMFLOW plug-in never deletes processed records
1
STORMFLOW plug-in deletes processed records after
one day
+++
365
STORMFLOW plug-in deletes processed records after
one year
Example:
<cnsDeleteOldRecords>
30
</cnsDeleteOldRecords>
Key
Description
cnsMaxEventLogInterval
This key contains the maximum allowed value for the EventLogInterval for the
The value is a number of seconds, the default value is 60
Configuration of the STORMFLOW plug-in
Detailed configuration of STORMFLOW plug-in
How STORMFLOW plug-in is working is described in a configuration file. This file is a text file in XML format
Filename and -location
Description of the configuration file for STORMFLOW plug-in
MANUAL
37
GB CHATTER NOTIFICATION CONFIGURATION 1303
Example:
<cnsMaxEventLogInterval>
60
</cnsMaxEventLogInterval>
Key
Description
cnsInitialHighTimeout
This key contains the minimum time the measured level from the actual MJK
above the threshold before it is considered a valid
stormflow
The value is a number of seconds, the default value is 300, equal to 5 minutes
Example:
<cnsInitialHighTimeout>
300
</cnsInitialHighTimeout>
Key
Description
cnsEndingLowTimeout
This key contains the minimum time the measured level from the actual MJK
below the threshold again before it is considered
a valid stormflow
The value is a number of seconds, the default value is 300, equal to 5 minutes
Example:
<cnsEndingLowTimeout>
300
</cnsEndingLowTimeout>
MANUAL
The supplied configuration file
<cnsConfig>
<cnsVersion>
003
</cnsVersion>
<cnsDeleteOldRecords>
0
</cnsDeleteOldRecords>
<cnsMaxEventLogInterval>
60
</cnsMaxEventLogInterval>
<cnsInitialHighTimeout>
60
</cnsInitialHighTimeout>
<cnsEndingLowTimeout>
60
</cnsEndingLowTimeout>
</cnsConfig>
38
Naming objects in a SCADA system
The starting point for naming objects in an SCADA-system is the
In this example, the ID-tag is MJK001
An ID-tag must only be used once. The
system will not work if duplicate ID-tags
are found!
than one object - or tag - in an SCADA-system, the object name
- or tag name - must be more than the ID-Tag.
MJK Automation ApS recommends that naming of objects in an
SCADA-system follows a set scheme. Such a scheme is
defined here.
Object names in someSCADA-systems cannot exceed a set number of characters!
Object name
Description
MJK001_M1-LEVEL
MJK001
MJK001_M1-LOGTIME
The time when a measurement from a Modbus input no. 1 on MJK001 was
MJK001_D2-STATE
MJK00_IN-BATT
MJK00_IN-SIGNAL
MJK001_ST-START
MJK001_ST-FLOW-M3S
The momentary flow in m3 pr. second during a stormflow recorded by MJK
Text
Signal origin
D1-
Digital input no. 1
D2-
Digital input no. 2
D3-
Digital input no. 3
D4-
Digital input no. 4
GB CHATTER NOTIFICATION CONFIGURATION 1303
MANUAL
Naming of objects in a SCADA-system
The object name in an SCADA-system consists of three elements:
ID-tag
Information about the origin of the signal
Name of the signal supplying data to the object
A few examples
ID-Tag
followed by an 'underscore',
Names of origin which may be combined with every ID-tag
39
GB CHATTER NOTIFICATION CONFIGURATION 1303
C1-
The counter on digital input no. 1
C2-
The counter on digital input no. 2
C3-
The counter on digital input no. 3
C4-
The counter on digital input no. 4
A1-
Analog input no. 1
A2-
Analog input no. 2
A3-
Analog input no. 3
A4-
Analog input no. 4
M1-
Modbus input no. 1
M2-
Modbus input no. 2
M3-
Modbus input no. 3
M4-
Modbus input no. 4
IN-
Internal measurement or internal data
ST-
Data from STORMFLOW plug-in
Signal names and associated pointers are only valid for the SCADA-systems mentioned in the right hand
column in the table below.
The supplied spreadsheet contains sample data which are NOT intended for
practical use. Be sure to delete the content of rows 2 to 32 before exporting data
from the spreadsheet!
Column
Description
Column A
This column must exist but it also must also contain no data. It acts as a
Column B
This column contains the names of the objects or tags in a SCADA-system. A
guide to establishing a consistent naming scheme is here.
Column C - IGSS only
This column contains the name of the area in 7-Technologies IGSS32 on which
The column may be left blank if you don't use <%IGSS%
Column D - IGSS only
This column contains information about the data types supplied to the object in 7Technologies IGSS32. Three different data types are available:
Value
Description
VALUE
Use this if the object in 7-Technologies IGSS32 will
receive a number, ie a measurement value. Modbus-,
Logger will deliver data of the data type VALUE
STATE
Use this if the object in 7-Technologies IGSS32 will
receive a digital value. Digital inputs in a MJK
STATE
STRING
Use this if the object in 7-Technologies IGSS32 will
receive a text string. Data elements as LOGTIME
will deliver data of the data type STRING
The column may be left blank if you don't use 7-Technologies IGSS32.
Column E
This column contains the ID for the plug-in which delivers data to this object Two
different plug-in's will deliver data to a SCADA-system:
Value
Description
1
Data will be coming from the SCADA plug-in
2
Data will be coming from the STORMFLOW plug-in
Column F
data to this object.
Spredsheet for object names
General
As it is rather difficult to type all this information directly into the table in the database by hand, the data can be
imported to the table. The data for this table starts as a Microsoft Excel spreadsheet. MJK Automation ApS supplies a
pre-formatted Microsoft Excel spreadsheet in Microsoft Excel 2003 format. You can find the spreadsheet here:
Each row contain the data needed for one object in an SCADA-system. The spreadsheet columns contains data as
described below.
MANUAL
Columns in the spreadsheet
39
48
39
GB CHATTER NOTIFICATION CONFIGURATION 1303
You cannot use the numbers designating the number for a signal
pointer in this column, you must use a 'real' ID-tag.
Column G
This column contains the signal type supplying data to this object.. These data
types exists:
Value
Description
D
Data for this object has comes from a digital input on a
A
Data for this object has comes from an analog input on
C
Data for this object has comes from a counter on a
M
Data for this object has comes from Modbus input on a
I
Data for this object has comes from an internal
Column H
This column contains the signal number supplying data to this object.. These data
types exists:
Value
Description
1
Data for this object has comes X-input number 1 on a
2
Data for this object has comes X-input number 2 on a
3
Data for this object has comes X-input number 3 on a
4
Data for this object has comes X-input number 4 on a
Column I
This column contains the number for the signal pointers supplying data to this
object. If the object just need to receive the 'standard' measurement the field must
contain a digit 0
Column J
This column contains information on any calculations which must be made before
data is delivered to an object in the SCADA-system. Calculations are done after
the SCADA plug-in has received the data but before it starts writing data to its file
with comma-separated values
If the field is empty - first character in the field is not a # - no
calculations are performed
MANUAL
17
17
49
GB CHATTER NOTIFICATION CONFIGURATION 1303
Value
Description
Also needs
#000
No calculations are done. Is included to make
it possible do temporarily disable a calculation
on a value just by changing this value.
#001
The value sent to this object is multiplied by
the value in parameter 2
Example:
If you need to scale a level measurement to
125%, enter the following in this field:
#001#1,25#
If you need to scale a level measurement to
75%, enter the following in this field:
#001#0,75#
#2
#002
The value in parameter 2 is added to the value
of this object before it is sent to the SCADAsystem
Example:
If you need to add 0,5 meter to a level
measurement, enter the following in this
field: #002#0,5#
If you need to subtract 0,5 meter from a level
measurement, enter the following in this
field: #002#-0,5#
#2
#004
If the value of this object is a string, you can
truncate it to a desired length before it is set to
the SCADA-system
Example:
A standard timestamp looks like this: 2011-0405 15:40, If you want to remove the timeinformation and retain the date-information,
enter the following in this field: #004#10#
#2
Column K - iFix only
This column contains information about the data types supplied to the object in
GE Proficy iFix version 5 Historian. Two different data types are available:
Value
Description
SingleFloat
Use this if the object in GE Proficy iFix version 5
Historian will receive a number, ie a measurement
value. Modbus-, analog- and counter inputs in a MJK
VALUE
You must specify a value in columns L, M and N.
FixedString
Use this if the object in GE Proficy iFix version 5
Historian will receive a text string. Data elements as
LOGTIME will supply data of the data type
STRING.
You must specify a value in columns L, M and N.
The column may be left blank if you don't use GE Proficy iFix version 5 Historian.
Column L
If you are exporting data to 7-Technologies IGSS32, this column must contain a
digit 0.
If you are exporting data to GE Proficy iFix version 5 Historian, this column must
contain the smallest numerical value you plan to supply to this tag.
Column M
If you are exporting data to 7-Technologies IGSS32, this column must contain a
digit 0.
MANUAL
50
39
GB CHATTER NOTIFICATION CONFIGURATION 1303
If you are exporting data to GE Proficy iFix version 5 Historian, this column must
contain the largest numerical value you plan to supply to this tag.
Column N
If you are exporting data to 7-Technologies IGSS32, this column must contain a
digit 0.
If you are exporting data to GE Proficy iFix version 5 Historian, this column must
contain the number of characters in the string, you plan to supply to this tag.
MANUAL
51
GB CHATTER NOTIFICATION CONFIGURATION 1303
When importing data to the table csnSCADAobects, remember to delete the existing content of the table
before importing new data. You can use this SQL-script to delete the existing content:
CNS\Server2008R2\ScadaObjects
cleanSCADAobjects.sql
Select the menu Files in Microsoft Excel
select Save as...
Save the file in a place of your choosing.
Select the file type Text (Tab delimited) (*.txt)
Click the button Save
Copy the saved file to this location on the server running MJK
C:\Users\Administrator\Documents\SQL
Server Management Studio\Projects
cnsSCADAobjects.csv
Find the saved text file and open it with Notepad.
Delete the top-line in the file, see the marking in the picture to
the right.
Save the file again.
MANUAL
Import-file for object names
Create an import file for object names in a SCADA-system
If you need to add new objects to the table containing the SCADA object names, it is easiest to modify the supplied
spreadsheet and afterwards import those data to the table.
In order to be able to import these data into the database table, the spreadsheet must be saved as a tab-delimited text
file. After that, this file can be imported into the database.
Follow this procedure
48
52
GB CHATTER NOTIFICATION CONFIGURATION 1303
The SQL script needed for importing
the object names into the database is
System Software CD in this location:
CNS\Server2008R2
\ScadaObjects
cnsSCADAobjectsBul
kImport.sql
Double-click the file in the folder and
wait for this window to appear
Click the button Connect
MJK recommends
that a verified
backup of the
database exists
before this update
is done.
The SQL-script opens in Microsoft SQL Server
Management Studio.
Click the button Execute
When the script has
executed, Query
executed successfully
will be shown in the
lower left corner
This is for information
only.
Close all windows, return to the desktop
MANUAL
53
Creating Stormflow data
Stormflow data
data to a SCADA-system
GB CHATTER NOTIFICATION CONFIGURATION 1303
MANUAL
54
GB CHATTER NOTIFICATION CONFIGURATION 1303
CNS\Server2008R2\StormflowData
cnsSTORMFLOWdata.xls
The supplied spreadsheet contains sample data which are NOT intended for
practical use. Be sure to delete the content of rows 2 to 105 before exporting data
from the spreadsheet!
Column
Description
Column A
Column B
This column contains a level in meters. The first row must always be 0 meters!
You will need a minimum of three different levels:
A level of 0 meters
A level somewhere between 0 meters and the maximum possible level
A level which is above the maximum possible level
Column C
This column contains the spill in litres per second for the level in column B.
The first row must always be 0 litres pr. second.
MANUAL
Spreadsheet for stormflow data
General
STORMFLOW plug-in must know the amount of water spilled over a weir before it can supply data for stormflows to a
specific level in meters.
As it is rather difficult to type all this information directly into the table in the database by hand, the data can be
imported to the table. The data for this table starts as a Microsoft Excel spreadsheet. MJK Automation ApS supplies a
pre-formatted Microsoft Excel spreadsheet in Microsoft Excel 2003 format. You can find the spreadsheet here:
resulting spill in litres pr. second
Columns in the spreadsheet
55
GB CHATTER NOTIFICATION CONFIGURATION 1303
When importing data to the table csnSCADAobects, remember to delete the existing content of the table
before importing new data. You can use this SQL-script to delete the existing content:
CNS\Server2008R2\StormflowData
cleanStormflowData.sql
Select the menu Files Microsoft Excel
Select Save as...
Save the file in a place of your choosing.
Select the file type Text (Tab delimited) (*.txt)
Click the button Save
Copy the saved file to this location on the server running MJK
C:\Users\Administrator\Documents\SQL
Server Management Studio\Projects
cnsStormflowData.txt
Find the saved text file and open it with Notepad.
Delete the top-line in the file, see the marking in the picture to
the right.
Do a Search and Replace in the open document.
search for , (comma)
replace all with . (period)
Save the file again.
MANUAL
Import file for stormflow data
Create an import file for stormflow data in a SCADA-system
If you need to add new objects to the table containing the stormflow data, it is easiest to modify the supplied
spreadsheet and afterwards import those data to the table.
In order to be able to import these data into the database table, the spreadsheet must be saved as a tab-delimited text
file. After that, this file can be imported into the database.
Follow this procedure
55
56
GB CHATTER NOTIFICATION CONFIGURATION 1303
The SQL script needed for importing
the object names into the database is
System Software CD in this location:
CNS\Server2008R2
\ScadaObjects
cnsStormflowDataBu
lkImport.sql
Double-click the file in the folder and
wait for this window to appear
Click the button Connect
MJK recommends
that a verified
backup of the
database exists
before this update
is done.
The SQL-script opens in Microsoft SQL Server
Management Studio.
Click the button Execute
When the script has
executed, Query
executed successfully
will be shown in the
lower left corner
This is for information
only.
Close all windows, return to the desktop
MANUAL
57
GB CHATTER NOTIFICATION CONFIGURATION 1303
IGSS only information
7-Technologies IGSS32
In 7-Technologies IGSS32, all objects must be created manually, they must exist before the can receive data.
exported to a file with comma-separated values. 7-Technologies IGSS32 will discard any data belonging to a nonexisting object
MANUAL
58
Creation of objects in IGSS 8
You can check whether the driver is already installed in the 7Technologies IGSS32 systems configuration.
The driver must have a build-number of 10250 or more.
In the 7-Technologies IGSS32 systems configuration under
Node Properties
System and 7-Technologies IGSS32will corporate.
Path to the CSV file must point to the file name and -location
set in the SCADA plug-in configuration file
Select IGSSTAG in the drop-down CSV Format.
Mark Delete file after read.
Three different object types
GB CHATTER NOTIFICATION CONFIGURATION 1303
MANUAL
An analog object
A digital object
A string type object
60
61
62
This section contain a brief description of the most important settings for the three object types.
IGSS32 release 8 DDHC Data File Driver
Data File Driver, driver ID 66 - must be installed in 7-Technologies IGSS32.
33
59
Analog objects
The object name MUST match the name from column B in the
spreadsheet containing all the SCADA objects.
Scan-interval for the object must be Never
The driver for the object must be set to 7TDHFILE and the data
type must set to FLOAT
Creating an analog object in 7-Technologies IGSS32
48
GB CHATTER NOTIFICATION CONFIGURATION 1303
MANUAL
60
Digital objects
Scan-interval for the object must be Never
The driver for the object must be set to 7TDHFILE and the data
type must set to FP16S
Creating a digital object in 7-Technologies IGSS32
GB CHATTER NOTIFICATION CONFIGURATION 1303
MANUAL
61
String type objects
The object name MUST match the name from column B in the
spreadsheet containing all the SCADA objects.
Scan-interval for the object must be Never
The driver for the object must be set to 7TDHFILE and the data
type must set to STRING
Creating a string type object in 7-Technologies IGSS32
48
GB CHATTER NOTIFICATION CONFIGURATION 1303
MANUAL
62
GB CHATTER NOTIFICATION CONFIGURATION 1303
MANUAL
iFIX only information
GE Proficy iFix version 5 Historian
is started. GE Proficy iFix version 5 Historian creates the necessary tags automatically and discards a tag if it already
exists.
Historian Data Collector
cnsCSVifixTagFile and cnsCSVfile keys in the configuration file cnsSCADAplugInGlobalConfig.xml
must be set to the Data Collectors input folder
2933
63
GB CHATTER NOTIFICATION CONFIGURATION 1303
BV2000 only information
BV Electronics System 2000
Dates for BV Electronics System 2000 are exported as seconds since 1970.01.01
MANUAL
64
1) The tissue in plants that brings water upward from the roots;
2) a leading global water technology company.
We’re 12,000 people unified in a common purpose: creating innovative solutions
to meet our world’s water needs. Developing new technologies that will improve
the way water is used, conserved, and re-used in the future is central to our work.
We move, treat, analyze, and return water to the environment, and we help people
use water efficiently, in their homes, buildings, factories and farms. In more than
150 countries, we have strong, long-standing relationships with customers who
know us for our powerful combination of leading product brands and applications
expertise, backed by a legacy of innovation.
For more information on how Xylem can help you, go to www.xyleminc.com