Terminology

The Itron common interface guides use the following terminology.

• Attribute. A name and value pair that describes or defines a property of an element.
• Element. A tag that describes and organizes data within an XML file. Database entities can be mapped to XML elements so that data can be transferred between applications, even if those applications use different database schemas. APIs use elements to classify data in the XML document.
• Endpoint. A device installed at the site of electricity, gas, or water consumption that gathers usage and related data which it sends to a meter data collection system. The term may refer to an ERT module that is attached to a meter, a meter that is equipped with a built-in communication module, or other devices.
• Interface. An Itron common format, API, or web service.
• Interval read. Electricity, gas, or water consumption data that is collected at regular time intervals. Interval reads show the amount of energy that was consumed during the period of time, such as 15 kWh in 60 minutes or 100 gallons in 24 hours. Interval reads are also known as load profile data or data logging data.
• Minimum occurrences (minOcc). minOcc = 0 indicates that an element or attribute could be optional. In the element diagram, these are outlined with a dotted line. Any value other than zero indicates that this element or attribute is required. In many cases, even if minOcc = 0, an element or attribute may be required if you use its parent element.
• Maximum occurrences (maxOcc). This indicates the maximum number of occurrences of this element or attribute within one file.
• Name space. An XML element used by web services that enables client applications to distinguish between data types that are named the same but defined differently. Unique name spaces allow an XML parser to interpret XML files correctly when multiple applications are using the same web service to communicate with one another.
• Register read. The reading value recorded by the meter at a specified date and time. A register read is an integer value such as 17592. Register reads are also known as index reads, boundary reads, or start and end reads.
• Service point. The point where a utility service such as electricity, water, or gas physically connects to a service location. A service point is sometimes called a location.
• Swap. An existing meter or endpoint at a location needs to be removed and replaced by a new endpoint or meter. The new device is put into the existing socket of the old device. This scenario may also be called an Exchange or Change-out.
• Valid values. The valid values show the attribute values that are recognized and accepted by the interface.