Introduction to IEC Landis+Gyr May 27, 2015

Transcription

1 Introduction to IEC

2 IEC Implementation Profiles 2

3 IEC The Basics (1) IEC reflects best practices and integration experiences and has been in effective use since 2006 Allows a wide variety of implementation options Part 100 is shared across all other parts. See FDIS document (IEC , published 2013) for full details We call this simply the 1 st edition 2 nd edition is in progress (2016?) Also specifies Message.xsd and Generic.wsdl files 3

4 IEC The Basics (2) IEC Tells you how to construct and transport a message. Provides a set of normative message exchange patterns. Mappings to specific transports e.g. SOAP and JMS XML based Omits Security (IEC62351 series) Compression 4

5 IEC (available real soon now!) 5

6 IEC , -100 status Current directions IEC edition 3 (editor David Bishop, L+G) IEC edition 2 (co-chair Rob Ward, L+G) 6

7 IEC Message Structure 7

8 Message stereotypes Request messages Reply messages Event message Fault messages 8

9 Structure of a Part 100 message All Part 100 messages have the same basic structure 9

10 Request message stereotype Top-level element is <RequestMessage> Request messages contain <Header> and optional <Request> and <Payload> elements Used for sending a request from one system to another 10

11 Sample meter read request message <soapenv:envelope xmlns:soapenv=" <soapenv:header/> <soapenv:body> <RequestMessage xmlns=" <Header> <Verb>get</Verb> <Noun>MeterReadings</Noun> <Timestamp> T14:16:09Z</Timestamp> <MessageID>f4cef283-9a3d-40f3-a3b2-48aa6088ad80</MessageID> <CorrelationID>facb121a-b46e-4deb a4cbde6746</CorrelationID> <Comment>simple meter read request</comment> </Header> <Request> <GetMeterReadings xmlns=" <EndDevice> <Names> <name>meter1</name> </Names> </EndDevice> <TimeSchedule> <scheduleinterval> <end> t09:40:00z</end> <start> t09:35:00z</start> </scheduleinterval> </TimeSchedule> </GetMeterReadings> </Request> </RequestMessage> </soapenv:body> </soapenv:envelope> SOAP IEC IEC

12 Response message stereotype Top-level element is <ResponseMessage> Response messages contain <Header>, <Reply> and (optionally) <Payload> elements Used for sending a reply in response to a previous request 12

13 Sample meter read response message <ResponseMessage xmlns=" <Header> <Verb>reply</Verb> <Noun>MeterReadings</Noun> <Timestamp> T13:08:15Z</Timestamp> <MessageID>eed4dac0-c3a5-432a-a9b2-e7c481a9c029</MessageID> <CorrelationID>facb121a-b46e-4deb a4cbde6746</CorrelationID> <Comment>response to a simple meter read request</comment> </Header> <Reply> <Result>OK</Result> <Error> <code>0.0</code> <level>inform</level> </Error> </Reply> <Payload> <MeterReadings xmlns=" <MeterReading> <Meter> <Names> <name>meter1</name> </Names> </Meter> <Readings> <timestamp> t09:38:00z</timestamp> <value> </value> <ReadingType ref=" "/> </Readings> </MeterReading> </MeterReadings> </Payload> </ResponseMessage> IEC IEC

14 Event message stereotype Top-level element is <EventMessage> Event messages contain <Header> and optional <Payload> elements Used for sending asynchronous event data 14

15 Event message example <EventMessage xmlns=" <Header> <Verb>created</Verb> <Noun>MeterReadings</Noun> <Timestamp> T14:01:32Z</Timestamp> <MessageID>df8596fc-816c-42f8-a14f-2a1b3499f33b</MessageID> <CorrelationID>ee25e536-2bd4-42c4-947f-0dbf10be1879</CorrelationID> <Comment>unsolicited event message containing meter data</comment> </Header> <Payload> <MeterReadings xmlns=" <MeterReading> <Meter> <Names> <name>meter1</name> </Names> </Meter> <Readings> <timestamp> t14:00:00z</timestamp> <value> </value> <ReadingType ref=" "/> </Readings> </MeterReading> </MeterReadings> </Payload> </EventMessage> 15

16 Fault messages Sent by a receiving system only when a request has been received that is so damaged that no meaningful processing can be performed. Top-level element is <FaultMessage> No <Header>, contains just a <Reply> element 16

17 Message header 17

18 Message header 18

19 Message Header element details <Verb>: enumeration, identifies a specific action to be taken Request messages: Must be one of create, change, cancel, close, delete, execute or get. Response messages: Is always reply Event messages: Must be one of created, changed, canceled, closed or executed <Noun> identifies the subject of the action <Timestamp> When the message was created <MessageID> A string identifying the message <CorrelationID> Used for matching responses to requests 19

20 Request messages Use <Verb> of get for making a query Specify filtering criteria in the <Request> subelement Use <Verb> of create, change, delete for managing objects Specify object in the <Payload> subelement <Verb>s cancel, close and execute are special cases 20

21 Response message contain a status indication (1) Status indication if reply is all OK <Reply> <Result>OK</Result> <Error> <code>0.0</code> </Error> </Reply> 21

22 Response message contain a status indication (2) Reply element if errors are present: <Reply> <Result>FAILED</Result> <Error> <code>0.0</code> </Error> <Error> <code>2.4</code> <level>fatal</level> <reason>no such meter</reason> <ID kind="name" objecttype="meter">meter1</id> </Error> <Error> <code>2.12</code> <level>fatal</level> <reason>invalid usagepoint</reason> <ID kind="name" objecttype="usagepoint">up2</id> </Error> </Reply> 22

23 A single reply may cause multiple response messages (1) More messages to follow: <Reply> <Result>PARTIAL</Result> <Error> <code>0.1</code> </Error> </Reply> 23

24 A single reply may cause multiple response messages (2) No more messages to follow (this is the last in a series): <Reply> <Result>PARTIAL</Result> <Error> <code>0.2</code> </Error> </Reply> 24

25 Some message exchange patterns 25

26 Example MEP (1) historical meter data exchange 26

27 Example MEP (2) On-request meter read 27

28 Example MEP (3) Create a CIM object 28

29 How this relates to IEC Meter read request with single response message Meter read request with multiple response messages On-demand meter read request Unsolicited meter reads 29

30 sd Meter Read Request (single response message) MDMS HES Meter * get(meterreadings) HES validates request alt [Request is invalid or specifies all invalid (non-existent) meters] HES sends reply message with list of non-existent meters (if applicable) reply(meterreadings, <Reply><Result>=FAILED) [Request is valid and specifies at least some valid (existent) meters] HES issues command across AMI network to read one or more meters Read meters alt [some meter reads failed] Reply message contains mixture of meter data and list of invalid meters or meters for which the reads failed reply(meterreadings, <Reply><Result>=FAILED) [all meter reads succeeded] Reply message contains meter data only reply(meterreadings, <Reply><Result>=OK)

31 Unsolicited meter reads sd Unsolicited meter read MDMS HES Meter * HES issues command across the AMI network to read one or more meters loop created(meterreadings) Read meters 31

32 More about transports 32

33 IEC and SOAP IEC61968 messages can be wrapped by a WSDL Two basic approaches (generic, coarse grained) or tightly coupled (strongly typed, fine grained) Generic.wsdl is defined by part 100 Defines three operations (Request, Response, PublishEvent) Define your own WSDL if you prefer strongly typed web services 33

34 sd Simple acknowledgements MDMS HES get(meterreadings) HES validates message reply(meterreadings) reply(meterreadings) reply(meterreadings) Simple acknowledgement messages

35 Simple acknowledgement messages <soapenv:envelope xmlns:soapenv=" xmlns=" <soapenv:header/> <soapenv:body> <ResponseMessage> <Header> <Verb>reply</Verb> <Noun>MeterReadings</Noun> <Timestamp> T13:08:17Z</Timestamp> <MessageID>0a d47-4f6c-9a5e-34f0da7b94db</MessageID> <CorrelationID>10c411ab-b84b-4f13-afd8-f5129f720bc6</CorrelationID> </Header> <Reply> <Result>OK</Result> <Error> <code>0.3</code> <reason>simple ack</reason> </Error> </Reply> </ResponseMessage> </soapenv:body> </soapenv:envelope> 35

36 Transports JMS Use queues, not topics Use JMSCorrelationID, JMSMessageID, etc. Use persistent messages, auto acks REST A work in progress... 2nd edition? 36

37 Thank you for your attention

38 Questions and contacts IEC TC57 sharepoint for CIM UG and IEC TC57 members IEC web site Rob Ward