Example: Itron Commissioning Process
This section provides an example of a synchronous command, the commission device command supported by the Itron OpenWay adapter.
The Itron OpenWay 3.9 command for registering a meter (commissioning a device) in the system is AddMeterDefinitions in the www.itron.com.ami.2008.10.provisioning.wsdl definition. The Smart Grid Gateway Adapter for Itron OpenWay typically sends a meter serial number and some other configuration data. The response indicates whether or not an error was encountered.
The image below illustrates the process flow used by this command.
Below is a summary of the important features of the Smart Grid Gateway implementation of this command. Many of the concepts can be applied when creating a custom synchronous command.
Command Activity — Device Commissioning
Business Object: D1-DeviceCommissioning
Lifecycle and Algorithms
The table below outlines some of the important algorithms used by the Device Commissioning command activity.
Lifecycle State | Algorithms |
|---|---|
Validate | The important features here are not the specific algorithms, but rather the ability to perform validation logic at a process level. • D1-VALDVCNAC – Validate Device Not Already Commissioned: This algorithm checks whether the device is already commissioned • D1-VHCPCOMMS – Validate Head-End's Capability to Commission Device: This algorithm checks to ensure that the head-end system has the capability to support the command requested. Some commands may not be supported by every head end system. • D1-CACTCOMM – Check for Existing Active Commissioning Command Request: This algorithm prevents multiple, simultaneous commands from being issued by SGG. • D1-CHKFDCOMM – Check for Concurrent Decommissioning Command Request: This algorithm prevents a commissioning request from executing when there is a current decommissioning request. |
Commission Ready | Several algorithms in this state are designed to create outbound communications to the head end system based on various conditions. • D1-AMIOBCOMM – AMI Device Identifier Outbound Communication Creation: This algorithm creates an outbound message, a communication to the head end system. |
Communication In Progress | • D1-CHKCHILD – Check Children Communications: This algorithm checks all of the outbound communications related to the activity and, if complete, will transition the activity. |
Execute Completion Events | • D1-EXCMPEVTS – Execute Completion Events: This algorithm provides a mechanism for running completion events upon successful completion of the commissioning operation. |
Outbound Communication — Itron - Add Meter Definition (Commission)
Business Object: D8-AddMeterDefinitionsDR
Schema
The portions of the schema that contain the payload of the web service request and response communications are the sendDetail element (constructed using the D8-AddMeterDefinitionsDRDA data area) and the responseDetail element (constructed using the D8-AddMeterDefRespDRDA data area). The XSLs used to create or decipher XML conforming to the Itron structure use these elements as a basis.
Lifecycle and Algorithms
The table below outlines some of the important algorithms used by the Add Meter Definition outbound communication.
Lifecycle State | Algorithms |
|---|---|
Validate | • D1-VALCOMTP – Validate Communication Type: This algorithm ensures the communication type is populated on the communication. |
Awaiting Response | • D8-PAMDSDDR – Itron - Populate Add Meter Definitions Send Detail - Direct Route: This algorithm constructs the sendDetails element used in the outbound request. • D8-COUTMCMDR – Create Outbound Message for Commissioning / Decommissioning Direct Route: This algorithm determines the correct outbound message to create based upon the input processing role. The reply from the head end system will be stored in the responseDetails element and log entries will be created for the creation of the outbound message and the result (whether it is a success or a failure). |
Response Error | The business object will transition to this state if the reply indicates a failure. • D8-RAMBOE – Itron - Retry Add Meter BO in Error: This algorithm provides a means to retry the communication in the event of an error. • D8-CTDEBOEO – Itron - Create To Do Entry for BO in Error for Outbound: This algorithm creates a To Do entry in order to inform a user to take corrective action. • D1-ALLOWTPA – Set Allow Transition Parent Activity Flag To True For Synchronous Outbound Communication: This algorithm conditionally allows the parent activity to transition to complete. |
Create Completion Event | • D8-CRCDCOMPE – Itron - Create Commission Device Completion Event: This algorithm creates a completion event to show the device as commissioned. |
Completed | • D8-UCCFTPA – Itron - Update Commission Completion Flag: This algorithm notifies the parent command activity that the communication has completed. |
Message Sender XSLs
Outbound messages created by Add Meter Definition outbound communication use the following XSL files:
• Request XSL: D8-CommissionRequest.xsl
• Response XSL: D8-CommissionResponse.xsl
Refer to Creating Message Senders for more information about creating message senders.
Parent topic