MultiSpeak 4.1 Interface

Report
MULTISPEAK® 4.1 INTERFACE
RNI 3.1 SP1
© 2013 Sensus. All rights reserved.
C-PAMI-WGE-0006-01
Module Goals
2
The goal for this module is to:
Provide an overview of the Sensus implementation
of MultiSpeak version 4.1 that supports:
• Collection of meter reading data for utility
services billing and engineering analysis
• Detection of electric service outages
• Remote connection and disconnection of
devices, and
• Configuration and management of Home Area
Network (HAN) devices to support Demand
Response Management System (DRMS)
programs.
Section One
3
Sensus MultiSpeak 4.1
Solution
Section Objectives
4
Following this section, you should be able to:
1. List the functions Sensus supports for version
4.1 of the MultiSpeak Standard.
2. Describe the purpose of each function.
3. Recognize which methods are associated with
each function.
4. Identify additional features provided by
Sensus MultiSpeak 4.1 solution.
Sensus MultiSpeak 4.1 Function Support
MultiSpeak 4.1 Solution
• Meter Reading (MR)
• Home Area Network
Communications (HAN)
• Outage Detection (OD)
• Connect-Disconnect (CD) • Demand Response (DR)
Customer Billing
Outage
Management
OD
MR
CD
MultiSpeak v4.1 web applications
FlexNet Gateway application server (Tomcat)
5
Demand Response
HAN
DR
MultiSpeak 4.1 Meter Reading (MR) Function
MultiSpeak 4.1 Solution
• Specification 4.1.3
• Contains a Web service, MR server
– Provides meter read data and lifecycle management
– Located at http://<rniweb.mycompany.com>/multispeakv41/mr
• Contains a Web service client, CB client
– Manages meter synchronization with a remote CB system
– CB script (command line utility) available to trigger data
synchronization using these methods
• Appropriate LDAP/AD permissions required to
execute methods
6
MultiSpeak 4.1 Meter Reading (MR) Methods
MultiSpeak 4.1 Solution
API
MR
Server
Category
General
Meter
management
7
Method
PingURL
GetMethods
GetAMRSupportedMeters
IsAMRMeter
MeterAddNotification
MeterChangedNotification
MeterRemoveNotification
MeterRetireNotification
ServiceLocationChangedNotification
MultiSpeak 4.1 MR Methods (Continued)
MultiSpeak 4.1 Solution
API
Category Method
GetLatestReadingByMeterID
MR
Meter
server reading GetReadingsByMeterID
GetReadingsByMeterIDAndFieldNameIntervalData
GetReadingsByMeterIDListAndFieldNameIntervalDataExt
InitiateMeterReadingsByMeterID
EstablishMeterGroup
Meter
groups
DeleteMeterGroup
InsertMeterInMeterGroup
RemoveMetersFromMeterGroup
8
MultiSpeak 4.1 MR Methods (Continued)
MultiSpeak 4.1 Solution
API
Category
MR
Notification
notification
client
CB client
9
Method
IntervalDataNotification
ReadingChangedNotification
GetAllMeters
GetAllServiceLocations
MultiSpeak 4.1 Outage Detection (OD) Function
MultiSpeak 4.1 Solution
• Specification 4.1.3
• Contains a Web service, OD server
– Provides event information related to managing outages
– Allows meter ping
– Located at http://<rniweb.mycompany.com>/multispeakv41/od
• Contains a Web service client, OD Notification client
– Sends outage notifications
– Real-time alarms
• Appropriate LDAP/AD permissions required to
execute methods
10
MultiSpeak 4.1 Outage Detection (OD) Methods
MultiSpeak 4.1 Solution
Web Service Category
OD server
OD
notification
client
11
Method
PingURL
General
GetMethods
InitiateOutageDectectionEventRequest
Status
Notification ODEventNotification
Sensus Additions to the ODEventNotification Method
MultiSpeak 4.1 Solution
• Intended for reporting service outage events
• Sensus implementation uses this method to also
report on non-outage alarm conditions
–
–
–
–
–
–
–
Reverse Energy
Tamper
Single Phase Fail
Brown Out (low AC voltage)
Over Voltage
Over Current (over class amps)
Over Temperature (hot socket)
• Non-outage alarms only sent as unsolicited
notifications
12
MultiSpeak 4.1 Connect-Disconnect (CD) Function
MultiSpeak 4.1 Solution
• Specification 4.1.3
• Contains a Web service, CD Server
– Manages the remote connection and disconnection of
meters
– Subset of methods defined by specification
– Located at http://<rniweb.mycompany.com>/multispeakv41/cd
• Contains a Web service client, CD Notification client
– Sends notifications to remote CB system
• Appropriate LDAP/AD permissions required to
execute methods
13
MultiSpeak 4.1 Connect-Disconnect (CD) Methods
MultiSpeak 4.1 Solution
Web Service Category
CD server
General
CD
notification
client
14
Method
PingURL
GetMethods
InitiateConnectDisconnect
Meter
InitiateArmCDDevice
control
GetCDMeterState
InitiateCDStateRequest
GetCDSupportedMeters
Notification CDStatesChangedNotification
CDStatesNotification
MultiSpeak 4.1 HAN Communications (HAN) Function
MultiSpeak 4.1 Solution
• Sensus-proprietary solution contributed to
MultiSpeak standard organization
• Included in the MultiSpeak 4.1.6 specification with
minor modifications
• Sensus solution will realign to MultiSpeak
specification in future release
• Available to MultiSpeak members at
https://groups.cooperative.com/multispeak/Sha
red%20Documents/MultiSpeak%20DRMS%20proposal_
07272010.doc
15
MultiSpeak 4.1 HAN Function (Continued)
MultiSpeak 4.1 Solution
• Specification 4.1.3
• Contains a Web service, HAN Server
– Manages add and remove device notifications, initiates
device commissioning and registration, and displays
messages on selected devices
– Located at http://<rniweb.mycompany.com>/multispeakv41/han
• Contains a Web service client, HAN Notification client
– Sends notifications to remote system, typically DRMS
• Appropriate LDAP/AD permissions required to
execute methods
16
MultiSpeak 4.1 HAN Communications (HAN) Methods
MultiSpeak 4.1 Solution
Web Service Category
HAN server General
Method
PingURL
GetMethods
InHomeDisplayAddNotification
HAN device
management InHomeDisplayRemoveNotification
ThermostatAddNotification
ThermostatRemoveNotification
LMDeviceAddNotification
LMDeviceRemoveNotification
17
MultiSpeak 4.1 HAN Methods (Continued)
MultiSpeak 4.1 Solution
Web
Service Category
HAN
server
18
Method
InitiateHANCommissioning
HAN
registration
InitiateHANRegistration
CancelHANRegistration
InitiateGetHANRegistrationStatus
IHD (In Home InitiateInHomeDisplayMessage
Device)
InitiateInHomeDisplayMessageToGroup
messaging
CancelInHomeDisplayMessage
CancelInHomeDisplayMessageToGroup
InHomeDisplayBillingMessageNotification
InitiateHANPricing
HAN pricing
MultiSpeak 4.1 HAN Methods (Continued)
MultiSpeak 4.1 Solution
Web
Service
Method
HAN
Notification HANRegistrationNotification
notification
IHDMessageStatusNotification
client
IHDMessageConfirmedNotification
InitiateHANPricingNotification
19
Category
MultiSpeak 4.1 Demand Response (DR) Function
MultiSpeak 4.1 Solution
• Sensus-proprietary solution contributed to
MultiSpeak standard organization
• Included in the MultiSpeak 4.1.6 specification with
minor modifications
• Sensus solution will realign with MultiSpeak
specification in future release
• Available to MultiSpeak members at
https://groups.cooperative.com/multispeak/Sha
red%20Documents/MultiSpeak%20DRMS%20proposal_
07272010.doc
20
MultiSpeak 4.1 DR Function (Continued)
MultiSpeak 4.1 Solution
• Specification 4.1.3
• Contains a Web service, DR Server
– Manages one time and scheduled critical peak pricing
events and demand response (load control) events on
selected HAN devices
– Located at http://<rniweb.mycompany.com>/multispeakv41/dr
• Contains a Web service client, DR Notification client
– Sends notifications to remote system, typically DRMS
• Appropriate LDAP/AD permissions required to
execute methods
21
MultiSpeak 4.1 Demand Response (DR) Methods
MultiSpeak 4.1 Solution
Web
Service
Category
DR server General
CPP event
DR event
22
Method
PingURL
GetMethods
InitiateCriticalPeakPriceEvent
InitiateCriticalPeakPriceEventToGroup
CancelCriticalPeakPriceEvent
CancelCriticalPeakPriceEventToGroup
InitiateDemandResponseSetup
InitiateDemandResponseEvent
InitiateDemandResponseEventToGroup
MultiSpeak 4.1 DR Methods (Continued)
MultiSpeak 4.1 Solution
Web
Service
Category
Method
CancelDemandResponseEvent
CancelDemandResponseEventToGroup
InitiateGetDemandResponseEventStatus
DR
Notification DemandResponseSetupNotification
notification
CriticalPeakPriceEventNotification
client
DemandResponseEventNotification
DR server
23
DR event
Flow Control and Reliable Delivery
MultiSpeak 4.1 Solution
• Sensus MultiSpeak 4.1 solution has introduced the
concepts of flow control and reliable delivery
• Flow Control: Ability to buffer read and outage event
notifications to control number of message sent to
remote service
• Reliable Delivery: Two-fold capability
– Ability to resend messages not received on first
transmission due to transient interruptions
– Ability to perform auto recovery when longer delivery
interruptions occur
24
Questions
25
Learning Check
26
Question:
1. Which function is supported by the Sensus
MultiSpeak 4.1 solution?
a)HAN Communications
b)Distribution Automation
c)Asset Management
d)Customer Billing
Learning Check
27
Question:
2. What is the purpose of the Meter Reading
function?
a)Provides event information related to
managing outages
b)Provides meter read data and lifecycle
management
c)Manages the remote connection and
disconnection of meters
d)Sends notifications to remote OD system
Learning Check
28
Question:
3. What is the purpose of the Outage Detection
function?
a)Provides event information related to
managing outages
b)Manages meter synchronization with a
remote CB system
c)Manages the remote connection and
disconnection of meters
d)Provides meter read data and lifecycle
management
Learning Check
29
Question:
4. What is the purpose of the Connect Disconnect
function?
a)Manages meter synchronization with a
remote CB system
b)Provides event information related to
managing outages
c)Provides meter read data and lifecycle
management
d)Manages the remote connection and
disconnection of meters
Learning Check
30
Question:
4. What is the purpose of the Home Area
Network function?
a)Manages add and remove device
notifications
b)Initiates device commissioning and
registration
c)Displays messages on selected devices
d)All of the above
Learning Check
31
Question:
5. What is the purpose of the Demand Response
function?
a)Initiates HAN device commissioning and
registration
b)Provides event information related to
managing outages
c)Manages critical peak pricing and load
control events on selected HAN devices
d)Manages the remote connection and
disconnection of meters
Learning Check
Question:
5. Check the MultiSpeak 4.1 function associated
with each method.
Method
MeterChangedNotification
GetAMRSupportedMeters
Meter
Reading
Outage
Detection








GetCDSupportedMeters
PingURL
InitiateUsageMonitoring


ODEventNotification
GetMethods
MeterRetireNotification
CDStatesChangedNotification
32
Connect
Disconnect



Learning Check
Question:
6. Check the MultiSpeak 4.1 function associated
with each method.
Method
InHomeDisplayAddNotification
Home Area
Network

InitiateCriticalPeakPriceEvent
DemandResponseEventNotification
PingURL
InitiateHANRegistration
InitiateHANPricingNotification
GetMethods
ThermostatRemoveNotification
33
Demand
Response









Section Two
34
Configuring MultiSpeak
Parameters in the RNI
Section Objectives
35
Following this section, you should be able to:
1.
2.
3.
4.
5.
Configure common gateway properties.
Configure logging levels.
Perform data synchronization.
Set flow control attributes.
Set reliable delivery parameters.
Configuring MultiSpeak Gateway Properties: Steps 1-3
Configuring MultiSpeak 4.1 Parameters
1. In FlexWare, click Administration
2. Click Configuration >
Customer/Network/Configuration
3. Click Configuration tab
Note: Gateway configurations are
named in the following manner:
[Gateway].[Function].[Method].[Property]
*The method may be omitted if the configuration
is not specific to a method.
36
Configuring MultiSpeak Gateway Properties: Steps 4-7
Configuring MultiSpeak 4.1 Parameters
7
Save the changes
4
Select your company
from the list.
Do not change the
System Defaults
6
Select or enter the
desired value
5
Locate the parameter to
change. Uncheck the
System Default value.
Note: Any user can view values, but you must have the appropriate permissions to make changes.
37
Various Log Files Available for Troubleshooting
Configuring MultiSpeak 4.1 Parameters
Log Type
Gateway
HTTPD
FlexNetApp
NCProgs
38
Log Files
/opt/flexnet-gateway/logs
catalina.out
tomcat.log
[webapp].log
/var/log/httpd
access.log
error.log
/opt/flexnet/log
/opt/ncprogs/backspool
nc2tgb.dat
mctsbackspool.dat
About Logging Levels
Configuring MultiSpeak 4.1 Parameters
• Determines level of information to include in
notifications
• Levels
– WARN: Quiet level
– INFO: Audit level
– DEBUG: Troubleshooting level
• Logging granularity at Java class level
Default logging displays
start-up messages,
warnings and errors,
and when messages are
sent and received
39
Setting Logging Level for Gateway
Configuring MultiSpeak 3.0 Parameters
1. Log in to the gateway server
2. Navigate to the /opt/flexnet-gateway/conf
directory
3. Open the log4j.properties file for editing
4. Enter the following:
# Set the gateway service logger at INFO to log
incoming requests
log4j.logger.com.sensus.gateway.multispeak.ws.interce
ptor.MultiSpeakLoggingInterceptor=INFO
40
About Data Synchronization
Configuring MultiSpeak 4.1 Parameters
• MultiSpeak 4.1 gateway includes two methods for
performing a data synchronization:
– Command line utility (same as in MultiSpeak 3.0)
– User interface (preferred method)
• Both trigger data synchronization using GetAllMeters
and GetAllServiceLocations CB client web methods
41
Performing a Data Synchronization Using the Web UI
Configuring MultiSpeak 4.1 Parameters
1. Log in to the Web server
2. Navigate to the /opt/flexnet-gateway/webapps/
multispeakv4-cb-client directory
Enter Customer
name/identifier
Monitor status
here
42
Select either
meters or
service
locations to
synchronize
About Flow Control
Configuring MultiSpeak 4.1 Parameters
• Implemented on notifications sent from the NC to
the gateway using caches
• Provides better performance when sending to
destination URLs with slow responses and with
bursts of event notifications
• Delivery to web service URLs occurs at Batch Time or
Batch Size (whichever occurs first)
• Configured using MaxCacheCount, Batch Size, and
Batch Time parameters
• Configuration changes require a FlexNet-gateway
restart
43
Setting Flow Control Attributes: Steps 1-4
Configuring MultiSpeak 4.1 Parameters
1. Log in to the Web server
2. In FlexWare, click Administration
3. Click Configuration >
Customer/Network/Configuration
4. Click Configuration tab
44
Setting Flow Control Attributes: Steps 5-8
Configuring MultiSpeak 4.1 Parameters
8
Save the changes
5
Select your company
from the list.
Do not change the
System Defaults
7
Select or enter the
desired value
45
6
Locate the parameter to
change. Uncheck the
System Default value.
About Reliable Delivery
Configuring MultiSpeak 4.1 Parameters
• Two forms of reliable delivery implemented
• Retries: used to address transient interruptions
– Configured using MaxCacheCount, RetryCount, and
RetryInterval parameters
• Auto Recovery: used to address longer duration
delivery interruptions
– Configured using MaxAutoRecoveries and
AutoRecoveryInterval parameters
• Configuration changes require a FlexNet-gateway
restart
46
Setting Reliable Delivery Parameters: Steps 1-4
Configuring MultiSpeak 4.1 Parameters
1. Log in to the Web server
2. In FlexWare, click Administration
3. Click Configuration >
Customer/Network/Configuration
4. Click Configuration tab
47
Setting Reliable Delivery Parameters: Steps 5-8
Configuring MultiSpeak 4.1 Parameters
8
Save the changes
5
Select your company
from the list.
Do not change the
System Defaults
6
Locate the parameter to
change. Uncheck the
System Default value.
7
Select or enter the
desired value
48
Questions
49
Learning Check
50
Question:
1. Which of the following parameters can be set
using the configuration page in the FlexWare
Web interface?
a) HAN parameters
b) Flow control parameters
c) Data synchronization parameters
d) All of the above
Learning Check
51
Question:
2. Which feature of the Sensus MultiSpeak 4.1
solution provides a method for handling
transient interruptions of messages?
a) Auto-recovery flow control
b) Meter data synchronization
c) Retry flow control
d) Service location synchronization
Learning Check
52
Question:
3. Which of the following gateway parameters
follows the Sensus parameter naming
conventions?
a) Multispeak.MR.IntervalDataNotification.BatchSize
b) Multispeak.IntervalDataNotification.MR.BatchSize
c) Multispeak.BatchSize.MR.IntervalDataNotification
d) None of the above
Learning Check
53
Question:
4. Which are the three logging levels available
with the MultiSpeak logs?
a) Info, Debug, Caution
b) Info, Warn, Debug
c) Normal, Caution, Warn
d) Normal, Debug, Warning
Learning Check
54
Question:
5. Indicate whether the following statements
about data synchronization are true or false.
a)Data synchronization can be performed using
True
the command line or user interface. _______
b)The user interface is located on the database
False
server. _______
c)You can synchronize a meter or all meters at
True
a location. _______
d)Data synchronization ensures that the data
at the meter matches the data in the
True
database. _______
Learning Check
55
Question:
6. What is the purpose of flow control?
a)To control the flow of data between the Base
Station and NC server.
b)To manage the flow of control messages in
the RNI.
c)To improve the flow of configuration data
from the RNI to a meter.
d)To improve the rate of data flow such that a
fast transmitter does not overwhelm a slow
receiver.
Learning Check
56
Question:
7. Which best describes the Retries form of
reliable delivery supported by MultiSpeak 4.1?
a)Addresses longer duration delivery
interruptions
b)Addresses varying rates of data delivery
c)Addresses transient interruptions in data
delivery
d)Addresses the rate at which data delivery
becomes reliable
Learning Check
57
Question:
8. Where do you view or modify the parameters
for flow control, reliable delivery, and the
gateway in general?
a)FlexWare Administration > Reprogramming
b)FlexWare Administration >
Customer/Network/Configuration >
Configuration
c)FlexWare Administration > Configuration >
MultiSpeak
d)FlexWare Diagnostics > Job Monitor

similar documents