SAP Utilities PDF download from SAP Help Portal: http://help.sap.com/erp2005_ehp_07/helpdata/en/43/6dce53118d4308e10000000a174cb4/frameset.htm Created on October 12, 2015
The documentation may have changed since you downloaded the PDF. You can always find the latest information on SAP Help Portal.
Note This PDF document contains the selected topic and its subtopics (max. 150) in the selected structure. Subtopics from other structures are not included. The selected structure has more than 150 subtopics. This download contains only the first 150 subtopics. You can manually download the missing subtopics.
© 2015 SAP SE or an SAP affiliate company. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP SE. The information contained herein may be changed without prior notice. Some software products marketed by SAP SE and its distributors contain proprietary software components of other software vendors. National product specifications may vary. These materials are provided by SAP SE and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty. SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP SE in Germany and other countries. Please see www.sap.com/corporate-en/legal/copyright/index.epx#trademark for additional trademark information and notices.
Table of content
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 1 of 130
Table of content 1 SAP Utilities 1.1 Basic Functions 1.2 Master Data 1.3 Device Management 1.4 Energy Data Management 1.5 Contract Billing 1.6 Invoicing 1.7 Contract Accts Receivable and Payable for the Utilities Industry 1.8 Customer Service 1.9 Work Management 1.10 Information System 1.11 Intercompany Data Exchange 1.12 Advanced Metering Infrastructure 1.13 SAP Utilities Enterprise Services Documentation (EN only) 1.13.1 Business Partner Data Management 1.13.1.1 Business Partner 1.13.1.1.1 Business Partner Replication In 1.13.1.1.1.1 Replicate Business Partner as Bulk 1.13.1.1.2 Business Partner Replication Out 1.13.1.1.2.1 Confirm Business Partner Replication as Bulk 1.13.1.1.3 Business Partner Replication Requesting In 1.13.1.1.3.1 Change Business Partner Replication Status as Bulk 1.13.1.1.4 Business Partner Replication Requesting Out 1.13.1.1.4.1 Request Business Partner Replication as Bulk 1.13.1.2 Payment Card 1.13.1.2.1 Payment Card Processing In 1.13.1.2.1.1 Change Payment Card 1.13.1.2.1.2 Create Payment Card 1.13.1.2.1.3 Read Payment Card 1.13.2 Utilities Business Partner Data Management 1.13.2.1 Utilities Service Provider 1.13.2.1.1 Manage Utilities Service Provider In 1.13.2.1.1.1 Read Utilities Service Provider Basic Data 1.13.2.1.2 Query Utilities Service Provider In 1.13.2.1.2.1 Find Utilities Service Provider by Identification 1.13.3 Measurement Processing 1.13.3.1 Measurement Reading 1.13.3.1.1 Manage Measurement Reading In 1.13.3.1.1.1 Cancel Measurement Reading 1.13.3.1.1.2 Check Measurement Reading Creation 1.13.3.1.1.3 Create Measurement Reading 1.13.3.1.1.4 Read Measurement Reading 1.13.3.1.2 Measurement Reading In 1.13.3.1.2.1 Create Measurement Reading as Bulk 1.13.3.1.3 Query Measurement Reading In 1.13.3.1.3.1 Find Latest Measurement Reading 1.13.3.1.3.2 Find Measurement Reading ERP by Measuring Device 1.13.3.1.3.3 Find Measurement Reading by Elements 1.13.3.2 Meter Reading Card 1.13.3.2.1 Manage Meter Reading Card 1.13.3.2.1.1 Change Meter Reading Card 1.13.3.3 Meter Reading Document 1.13.3.3.1 Manage Meter Reading Document In 1.13.3.3.1.1 Cancel Meter Reading Document 1.13.3.3.1.2 Cancel Meter Reading Document Result 1.13.3.3.1.3 Create Meter Reading Document Result 1.13.3.3.1.4 Create Meter Reading Document With Reference To Utilities Device 1.13.3.3.1.5 Read Meter Reading Document Basic Data 1.13.3.3.2 Meter Reading Document In 1.13.3.3.2.1 Change Meter Reading Document Result as Bulk
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 2 of 130
1.13.3.3.2.2 Change Based on Smart Meter Meter Reading Document Result Creati 1.13.3.3.2.3 Change Based on Smart Meter Meter Reading Document Result Creati 1.13.3.3.2.4 Change Based on Smart Meter Meter Reading Document Creation Conf 1.13.3.3.2.5 Change Based on Smart Meter Meter Reading Document Creation Conf 1.13.3.3.2.6 Change Based on Smart Meter Meter Reading Document Result Change 1.13.3.3.2.7 Change Based on Smart Meter Meter Reading Document Result Change 1.13.3.3.2.8 Change Based on Smart Meter Meter Reading Document Cancellation 1.13.3.3.2.9 Change Based on Smart Meter Meter Reading Document Cancellation 1.13.3.3.2.10 Create Meter Reading Document Result 1.13.3.3.2.11 Create Meter Reading Document Result as Bulk 1.13.3.3.3 Meter Reading Document Out 1.13.3.3.3.1 Notify Meter Reading Document Out 1.13.3.3.3.1.1 Notify of Meter Reading Document Result as Bulk 1.13.3.3.3.2 Confirm Meter Reading Document Result Creation 1.13.3.3.3.3 Confirm Meter Reading Document Result Creation as Bulk 1.13.3.3.3.4 Confirm Meter Reading Document Result Change as Bulk 1.13.3.3.3.5 Request Smart Meter Meter Reading Document Creation 1.13.3.3.3.6 Request Smart Meter Meter Reading Document Creation as Bulk 1.13.3.3.3.7 Request Smart Meter Meter Reading Document Cancellation 1.13.3.3.3.8 Request Smart Meter Meter Reading Document Cancellation as Bulk 1.13.3.3.3.9 Request Smart Meter Meter Reading Document Result Creation 1.13.3.3.3.10 Request Smart Meter Meter Reading Document Result Creation as Bu 1.13.3.3.3.11 Request Smart Meter Meter Reading Document Result Change 1.13.3.3.3.12 Request Smart Meter Meter Reading Document Result Change as Bulk 1.13.3.3.4 Query Meter Reading Document In 1.13.3.3.4.1 Find Meter Reading Document Result by Utilities Device 1.13.3.3.4.2 Find Meter Reading Document by Utilities Device 1.13.3.4 Utilities Measurement Task 1.13.3.4.1 Manage Utilities Measurement Task In 1.13.3.4.1.1 Read Utilities Measurement Task Basic Data 1.13.3.4.2 Notify Utilities Measurement Task Out 1.13.3.4.2.1 Notify of Smart Meter Measurement Task Point Of Delivery Assigne 1.13.3.4.2.2 Notify of Smart Meter Utilities Measurement Task Device Assignme 1.13.3.4.2.3 Notify of Smart Meter Utilities Measurement Task Point Of Delive 1.13.3.4.3 Query Utilities Measurement Task In 1.13.3.4.3.1 Find Utilities Measurement Task by Utilities Point Of Delivery I 1.13.3.4.4 Utilities Measurement Task In 1.13.3.4.4.1 Change Based on Smart Meter Measurement Task Change Confirmation 1.13.3.4.4.2 Change Based on Smart Meter Utilities Measurement Task Change Co 1.13.3.4.5 Utilities Measurement Task Out 1.13.3.4.5.1 Request Smart Meter Utilities Measurement Task Change 1.13.3.4.5.2 Request Smart Meter Utilities Measurement Task Change as Bulk 1.13.4 Service Contract Processing 1.13.5 Utilities Connection Processing 1.13.5.1 Utilities Connection Status Change Request 1.13.5.1.1 Utilities Connection Status Change Request In 1.13.5.1.1.1 Change Based on Smart Meter Connection Status Change Request Bul 1.13.5.1.1.2 Change Based on Smart Meter Connection Status Change Request Can 1.13.5.1.1.3 Change Based on Smart Meter Connection Status Change Request Cre 1.13.5.1.2 Utilities Connection Status Change Request Out 1.13.5.1.2.1 Request Smart Meter Utilities Connection Status Change Request C 1.13.5.1.2.2 Request Smart Meter Utilities Connection Status Change Request C 1.13.5.1.2.3 Request Smart Meter Utilities Connection Status Change Request C 1.13.5.1.2.4 Notify Utilities Connection Status Change Request Out 1.13.5.1.2.4.1 Notify of Smart Meter Utilities Connection Status Change Request 1.13.5.1.2.4.2 Notify Cancellation of Smart Meter Utilities Connection Status C 1.13.5.1.3 Utilities Connection Status Management In 1.13.5.1.3.1 Change Utilities Connection Status Change Request Based on Confi 1.13.5.1.4 Utilities Connection Status Management Out 1.13.5.1.4.1 Request Utilities Connection Status Change Request 1.13.5.1.4.2 Request Utilities Connection Status Change Request Cancellation 1.13.6 Utilities Contract Processing
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 3 of 130
1.13.7 Utilities Device Management 1.13.7.1 Utilities Device 1.13.7.1.1 Manage Utilities Device In 1.13.7.1.1.1 Read Utilities Device Basic Data 1.13.7.1.2 Notify Utilities Device In 1.13.7.1.2.1 Change Based on Utilities Device Smart Meter Registered Notifica 1.13.7.1.2.2 Change Based On Utilities Device Smart Meter Registered Notifica 1.13.7.1.3 Notify Utilities Device Out 1.13.7.1.3.1 Notify of Utilities Device Smart Meter Location 1.13.7.1.3.2 Notify of Utilities Device Smart Meter Location as Bulk 1.13.7.1.3.3 Notify of Utilities Device Smart Meter Relationship 1.13.7.1.3.4 Notify of Utilities Device Smart Meter Text as Bulk 1.13.7.1.4 Query Utilities Device In 1.13.7.1.4.1 Change Based on Utilities Device Smart Meter Operational State b 1.13.7.1.5 Query Utilities Device In 1.13.7.1.5.1 Find Utilities Device by Utilities Measurement Task 1.13.7.1.6 Query Utilities Device Out 1.13.7.1.6.1 Query Utilities Device Smart Meter Operational State by ID 1.13.7.1.7 Utilities Device In 1.13.7.1.7.1 Change Based on Device Smart Meter Register Creation Confirmatio 1.13.7.1.7.2 Change Based on Utilities Device Smart Meter Cancellation Confir 1.13.7.1.7.3 Change Based on Utilities Device Smart Meter Change Confirmation 1.13.7.1.7.4 Change Based on Utilities Device Smart Meter Change Confirmation 1.13.7.1.7.5 Change Based on Utilities Device Smart Meter Creation Confirmati 1.13.7.1.7.6 Change Based on Utilities Device Smart Meter Creation Confirmati 1.13.7.1.7.7 Change Based on Utilities Device Smart Meter Register Change Con 1.13.7.1.7.8 Change Based on Utilities Device Smart Meter Register Change Con 1.13.7.1.7.9 Change Based on Utilities Device Smart Meter Register Creation C
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 4 of 130
SAPUtilities
Purpose SAP Utilities is a process-oriented sales and information system that supports all services provided by utility and waste disposal companies. You can use SAP Utilities to manage and bill residential, commercial and industrial, and prospective customers. In times of deregulated markets and increasing competition, it is vital that you provide the bet possible response to your customers’ requirements, use operational information tailored to their specific requirements, and maximize revenue potential. As an integrated component in SAP ERP , SAP Utilities provides you with all the benefits of a comprehensive and effective Enterprise Resource Planning (ERP) System. SAP Utilities helps you to keep you business processes as streamlined and as efficient as possible. As a single software solution, SAP Utilities eliminates incompatible and isolated information in the back office.With SAP Utilities , you can access data at any time from diverse business areas, providing you with the information you need to make the right decisions.
Integration Solution Portfolio SAPfor Utilities SAP Utilities is part of the solution portfolio SAP for Utilities and includes the SAP Utilities (IS-U) industry-specific component. SAPforUtilities can be integrated with the following applications: Application
Documentation
SAP Customer Relationship Management
SAP Help Portal (help.sap.com): SAP Business Suite SAP Customer Relationship Mgmt.
SAP NetWeaver Business Intelligence
SAP Help Portal (help.sap.com): SAP NetWeaver (or other release) Capability{
BI Content
German
Industry Solutions
SAP NetWeaver Portal
SAP Help Portal (help.sap.com): SAP NetWeaver Portal Content
SAP Utilities Customer E-Services
SAP Solution Manager
SAP NetWeaver by Key
Utilities
You can use the Plant Maintenance (PM), Customer Service (CS) and Sales and Distribution (SD) SAP ECC application components to bill service orders, service contracts, services, and the sale of goods. Due to the large number of postings from billing and budget billing requests, these are posted in a subledger in Contract Accounts Receivable and Payable (FI-CA) . SAP Utilities uses SAP Business Workflow to automate the processing of its many business processes. Common workflows include initial creation of a service connection and the disconnection of devices.
Features SAPUtilities You can use Basic Functions to manage addresses and regional structures. You can generate schedules for meter reading, budget billing, and billing. You can use Master Data to manage data that remains fixed for long periods of time. In IS-U, this data includes the business partners, contracts and contract accounts, connection objects (buildings and real estate) and the premises, installations, and device locations contained therein. You can use Device Management to manage the installations, meter reading, and the certification of all devices for a utility company. The Billing component is used to bill the standard divisions: Electricity, gas, water/waste water, district heating, and multimedia services (for example, cable TV). You can use Invoicing to group services and invoice them on one bill. You can also use Invoicing to calculate and charge duty, fees, and taxes. In Customer Service you can use the Customer Interaction Center (CIC) or Front Office to display all data and start specific business processes. In Internet-Self-Services your customers can send you new data or changes to their existing data via the Internet. For example, they can grant you collection authorization or register a move-in. Energy Data Management (EDM) is a solution that meets the requirements of interval reading, schedule management, and the billing of interval energy consumption. EDM includes the following functions:
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 5 of 130
Central database for energy data (Energy Data Repository) Settlement and schedule management using the settlement workbench Billing of profiles using real-time-pricing billing (RTP billing) Intercompany Data Exchange (IDE) fulfills the requirements of the deregulated market. IDE includes the following functions: Infrastructure for processing deregulated business processes Unbundling Data exchange processes Change of supplier processes Bill and payment processing in the deregulated environment Work Management combines various SAP components and enhances them to include industry-specific functions for planning, calculating, executing, and billing work orders. SAP Waste and Recycling (IS-U-WA) is a comprehensive logistics, billing, service, and customer service system that covers all the business processes required by a waste disposal company.
Note If you have any comments or suggestions regarding this documentation, we are always grateful for Feedback .
1.1 Basic Functions Purpose This component contains the following basic functions of the Utilities Industry (IS-U) component: Central management of address data arranged according to postal and political regional structure Scheduling at the meter reading unit and portion levels
1.2 Master Data Purpose This component contains data for the Utilities Industry (IS-U) component that remains unchanged over a long period of time. The graphic below illustrates the master data and shows how the various objects are related to each other. Master Data in IS-U
There are 2 different types of master data: technical and business. These are shown in the graphic below:
1.3 Device Management Purpose This component manages technical data, installations, meter readings, and the inspection of devices. If you have activated the Advanced Metering Infrastructure business function ((ISU_AMI_1)) and you are in an advanced metering infrastructure, you can find more information under Advanced Metering Infrastructure.
Integration The following table lists the standard application components that must be integrated into device management before you can manage devices. The device, device category, and device number in the Utilities Industry (IS-U) component correspond to equipment, material, and the serial number in the standard system: Name in IS-U
From Component
Name in Standard System
Device
Plant Maintenance (PM)
Equipment
Device Category
Logistics Basic Data (LO-MD)
Material
Device Number
Logistics Basic Data (LO-MD)
Serial Number
The device number is created in MM with the Goods Receipt function and transferred to the device. It can also be generated when you create a device in ISU. The device is identified by a unique material and serial number combination to distinguish it from other pieces of material that may have the same serial number. The equipment number is the same throughout the system.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 6 of 130
MM is also used for the following functions in device flow: Function
Component
Procurement
Purchase Requisition and Purchase Order from Purchasing (MM-PUR)
Delivery
Goods Receipt from Inventory Management (MM-IM)
Outward Movement (such as scrapping or sales)
Goods Issue and Return Delivery from MM-IM
Stock Transfer
Goods Issue and Return Delivery from MM-IM
Equipment records are created automatically at goods receipt . Therefore, functions of the PM application component are used, including standard ordering functions and creation of maintenance plans or task lists. Billing is then carried out with the Sales and Distribution (SD) component. More Information PM: Equipment LO-MD: Material Master MM-PUR: Purchase Requisitions, Purchase Orders MM-IM: Planning Goods Receipts, Goods Receipts for Purchase Orders, Goods Receipts for Orders, Other Goods Receipts, Goods Issues.
1.4 Energy Data Management Purpose Energy Data Management is a solution that fulfills requirements by offering interval reading, settlement of energy quantities, scheduling, and billing of interval energy consumption.
Integration The Energy Data Management (SAP IS-U-EDM) component is fully integrated into the SAP IS-U system and can be installed in an existing SAP IS-U system as a new component. SAP IS-U-EDM is also integrated into Intercompany Data Exchange (SAP IS-U-IDE). This component allows for data exchange in standardized formats and enables the integration of cross-company business processes. SAP IS-U-EDM allows you to bill profiles in SAP IS-U. Profiles are prepared in SAP IS-U-EDM and transferred to SAP IS-U billing via an internal interface. This allows you to bill new types of contracts, such as spot purchases. SAP IS-U-EDM also interfaces with automated meter reading systems.
Features Energy Data Management covers the following areas: Central database for energy data (Energy Data Repository) Settlement and scheduling using the settlement workbench Billing profiles using Real-Time-Pricing Billing
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 7 of 130
Profile Management For further information see Profile Management
Import of Profile Values You can import and monitor profile values using a standard interface.
Replacement Value Creation For more information see Replacement Value Creation
Profile Display and Editing Microsoft® Excel has been integrated into IS-U-EDM via an OLE (object linking and embedding) interface. This interface allows you to: Display profile values in Microsoft® Excel. Change profile values in Excel and save the changes in an Excel file. Export profile values (including status) from SAP IS-U-EDM to an Excel file and edit them at your workstation. Import elementary profile values (including status) from an Excel file into SAP IS-U-EDM. The system performs predefined consistency checks during the import process.
Displaying Profiles on the Internet You can use an Internet Application Component to display profile values on the Internet.
Settlement For more information see Settlement
Calculating Profiles For more information see Profile Calculation
Sending Profiles You can send profiles to communication partners and display a list of sent profiles. To send profiles, see Energy Data Management → Send Profiles in the Utilities Industry menu.
Profile Billing For more information, see Real-Time-Pricing Billing .
1.5 Contract Billing The supply and services provided by a utility company are billed using this component. It offers a range of billing procedures with a variety of selection and control options. For example, the component enables the following: Billing of residential and commercial and industrial customers Annual consumption billing and periodic monthly billing cycles Billing for different divisions Numerous bill forms Billing simulation Validation of billing documents and bills
Integration Billing can process discrete measured data from the Meter Reading component (IS-U-DM-MR) as well as interval data from the Energy Data Management component (IS-U-EDM). If you have activated the business function Utilities, Quantity Determination (ISU_QD_1) and you use the quantity determination procedure Quantity Determination During Meter Reading , the system determines a consumption value during meter reading result entry. The value is saved to the database. In this case, billing processes the consumption quantity and not the meter reading results. For more information, see: Quantity Determination During Meter Reading The billing results are processed in the Invoicing component (IS-U-IN). In addition to the standard services, utility companies also offer their customers other services. Some important additional services are, for example: Installation of a service connection Maintenance and repairs Sales These additional services are either billed and invoiced in the Sales and Distribution (SD) component, or externally.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 8 of 130
1.6 Invoicing Use This component: Creates FI-CA documents for: IS-U consumption billing External billing SD billing (sales, installation) Clears bill receivables with posting items, in particular with budget billing payments that have been made Creates and prints bills Supports reversal processes Manages the budget billing plans and provides functions for processing the budget billing amounts Supports the determination and levying of taxes, charges and duties Supports additional functions such as: Interest Calculation Dunning Locks Clearing control, account maintenance, and so on The following figure shows the uses and additional functions of invoicing:
Integration The Contract Billing (IS-U-BI) component sends billing documents, credit memos, backbillings, and the basis for the budget billing plans to invoicing. The budget billing plan is formed on the basis of the budget billing extrapolation lines, which are created automatically in periodic billing. Invoicing links the Utilities Industry (IS-U) component with the Contract Accounts Receivable and Payable (FI-CA) component. Posting documents and budget billing plans are created in FI-CA and are taken into account by invoicing during account maintenance. The Print Workbench (IS-U-TO-PW) component is used for creating the bill form. The following graphic shows the connection between billing, invoicing and contract accounts receivable and payable:
1.7 Contract Accts Receivable and Payable for the Utilities PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 9 of 130
1.7 Contract Accts Receivable and Payable for the Utilities Industry Use Contract Accounts Receivable and Payable is a subledger developed for industries with a large customer base and a correspondingly high volume of documents to post, such as utility companies.
Features This component provides standard accounts receivable and accounts payable functions including dunning, posting documents, and making payments. Contract accounts receivable and payable currently consists of the following detailed components: Basic Functions Business Transactions Integration Closing Operations Information System Job Controls European Monetary Union and Contract Accounts Receivable and Payable Archiving Interfaces The EVENT Concept Data Processing in Mass Runs Enhanced Message Management
1.8 Customer Service Purpose This component is used to efficiently manage services and business transactions in IS-U/CCS. It supports you in: Customer information (for example, for account inquiries, meter reading results, and budget billings) Executing processes and workflows: Invoicing costs that arise from service provision Logging and managing customer contacts
Integration Depending on your Customizing settings, you can integrate all components of the Utilities Industry (IS-U) component and components of the standard system, for example the component Service Processing (CS-SE).
Features The data finder , a high-performance search function, helps you identify customers. Depending on the data you are given, you can search by the following criteria: Name and address of the customer Address of the connection object Customer number Social security number You can also: Combine search criteria any way you like Search with incomplete criteria (for example, all names starting with Ma). Restrict the search according to objects (for example, the division electricity).
Example You can search for customers who inhabit the same property. You can integrate external communication systems in IS-U/CCS. You can, for example, display documents stored in the optical archive (such as bills and welcome letters), store in or outbounf documents (such as letters or faxes), integrate a call center solution using the SAPPhone component or send E-mails via the SAPConnect component.
1.9 Work Management Purpose PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 10 of 130
You use this component for accepting, planning, calculating and carrying out work orders and, if applicable, for billing work orders to a customer. For this process, a distinction is made between two types of work order as follows: External work orders relating to the customer ("services") Examples of external work orders are: Creation and amplification of service connections Energy consulting Unplanned meter readings Disconnection and reconnection (electricity, gas) Internal work orders Examples of internal work orders are: Maintenance Repairs Installation, modification or removal of technical equipment To create a work order efficiently, the Utilities Industry (IS-U) component uses references ("compatible units"). Using a small number of parameters defined by the user, the system can generate the appropriate order. After the order has been created, the system monitors the provision of resources and schedules the order. Geographical conditions play an important role here, especially in the utilities industry.
1.10 Information System Purpose You use this component to manage the statistics for the master data and the most important transactions in the Utilities Industry component ( IS-U ). This gives you fast and effective access to all of the data in your company. You can not only view the data, but can also evaluate, analyze, and display it.
Integration IS-U manages data required for evaluating statistics in separate files. You analyze stock statistics, transaction statistics, and sales statistics using the Logistics Information System (LO-LIS) component, which is integrated with the Open Information Warehouse (CA-OIW) component. This allows you to use the analysis tools from CA-OIW to evaluate, analyze and present statistics. You can also use external programs, such as Microsoft Excel , to analyze the statistics. User Exits also allow you to add information from other applications to the statistics.
1.11 Intercompany Data Exchange Unbundling utility companies has changed the bilateral relationship of customers with a local provider in a regulated market to a multilateral relationship involving different contract and service relationships. A customer has a contractual relationship with their energy supplier, and a service relationship and in some cases also a contractual relationship with their local distributor. Since the customer can change their energy supplier according to current market offerings, additional contractual relationships may also exist over time. Commercial and industrial customers can obtain energy from several suppliers in parallel. So that services from the supplier, distributor and possibly from other service providers to a customer can be coordinated, managed and billed, processes must be executed and information exchanged between these parties. Data exchange includes information about the customer, location and technology used by the service location, measurement values, contract content, billing information and payment transactions. This involves bilateral communication between the customer information systems used by the utility companies involved. These types of collaborative business process scenarios include for example informing the distributor that a customer has switched to a different supplier. This also involves reporting meter reading results from the distributor or meter operation service company to the supplier or exchanging billing results between service providers to ensure that a collective consolidated bill can be sent to the customer. Modern information technology must support an enormous volume of transactions that are generated in the deregulated utilities industry: If a customer switches to a different supplier, in the energy market or when managing an extensive number of different service providers. It has become more important than ever before to keep process costs in check. World class IT support can play a decisive role here. Effective customer and cost management are also core requirements of an integrated IT system landscape. You can use Intercompany Data Exchange (SAP IS-U/IDE) in conjunction with Energy Data Management (SAP IS-U/EDM) and additional SAP for Utilities applications to meet the deregulation requirements of energy markets.
Integration To represent certain processes, you also require additional SAP for Utilities applications that are seamlessly integrated with Intercompany Data Exchange. Representing the processes for Energy Quantity Settlement involves both Energy Data Management and Intercompany Data Exchange. Representing the processes for Managing Grid Usage involves the following applications in addition to Intercompany Data Exchange: Billing Energy Data Management Invoicing FI-CA
Features PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 11 of 130
Intercompany data exchange provides the infrastructure and functions required to implement unbundling requirements and to represent the resulting scenario Change of Supplier and Managing Grid Usage and also to process data exchange in deregulated markets.
Note For more information about this scenario, see SAP Solution Manager. The documentation for Intercompany Data Exchange is structured as follows: Deregulation Data This section describes the master data objects that are required to use the SAP IS-U System in deregulated markets. This deregulation data is used by the deregulation functions. Deregulation Functions The Deregulation Settings section describes the basic settings that you make to configure your system for use in a deregulated environment. These deregulation settings are the basis for using the deregulation functions. The Deregulation Infrastructure section describes the functions that make up the infrastructure used to represent deregulated processes. The Unbundling section describes the options for implementing unbundling of information. The Processing Data Exchange section describes the functions and processes that are used to perform data exchange in the deregulated environment. Data exchange is performed for all deregulation processes. During the change of supplier process, information about the registration or deregistration of grid usage and the cancellation of supply service relationships is exchanged. During bill processing and payment handling, market participants communicate with each other to exchange bills, complaints, payments, and payment advice notes. The data exchanged refers to the customers for which the various service providers perform services or with whom they have contractual agreements. The Change of Supplier section describes the functions and processes that are used to manage the change of supplier processes. The Bill Processing and Payment Handling section describes the functions and processes that are used to manage the various individual processes. The Technical Reference to Deregulation Functions contains information about the architecture and project-specific enhancement options for the deregulation functions described previously. Migration This section describes migration objects for the deregulation data.
1.12 Advanced Metering Infrastructure An advanced metering infrastructure is a communication network consisting of measurement devices and systems. An infrastructure of this nature is characterized by intensive interaction between the different market participants. These market participants can occupy different roles in the market. They exchange information according to these roles. The related information and data exchange processes virtually take place in real time. Companies in the energy industry, associations, and government organizations choose an advanced metering infrastructure with the aim of increasing efficiency and optimizing grid usage as a result of improved evaluation options on the consumer side. You can use SAP Utilities as a customer information and billing system together with other SAP applications as part of an advanced metering infrastructure. The SAP system can communicate with other systems and exchange data. The following diagram illustrates how the SAP applications are integrated in an advanced metering infrastructure.
AMI System Landscape
The AMI system landscape illustrated is subdivided into three large areas:
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 12 of 130
On the left hand side, the AMI systems, on the right hand side, the SAP system as a back-office system, and in the middle, the MDUS system as an interface between the two. The AMI systems on the left hand side include devices with advanced metering capabilities, advanced metering systems (AMS), and other devices and systems, such as data concentrators. Advanced metering systems measure, gather, and analyze energy consumption data from AMI devices and transmit commands and data to these devices. MDUS in the middle stands for Meter Data Unification & Synchronization and describes systems that unite the interfaces between different advanced metering systems and synchronize the data and processes in these systems with those in the back-office systems. You can use the SAP system on the right hand side to run the usual back-office processes, as well as processes and functions specific to an advanced metering infrastructure. Communication between the SAP applications and the MDUS system takes place using enterprise services. Processes can only run fully if all the devices and systems in the advanced metering infrastructure meet the technical requirements and support the required capabilities. For this reason, the SAP Utilities processes are only possible if the required capabilities are supported both by the advanced metering system and by the device.
Example The advanced metering system supports the Remote Disconnection capability but the device does not. This means the remote disconnection process cannot take place.
Integration The AMI capabilities in the SAP system are based on existing functions in the following areas: Device Management Meter Reading Contract Billing Customer Service The remaining documentation focuses on the capabilities and processes that are specific to an advanced metering infrastructure, or that are processed differently in this context than is the case in an infrastructure that is not based on advanced metering technology. For this reason, the descriptions contain a number of references to the documentation for the above areas.
More Information For more information about enterprise services (English language), see SAP Library at SAP for Utilities Enterprise Services Documentation and help.sap.com/ecc SAP ERP 6.0 Enterprise Services Documentation
1.13 SAP Utilities Enterprise Services Documentation (EN only) Features Enterprise services are web services defined by SAP that enable companies to implement and adapt automated business processes with unprecedented speed and ease. They can also be used to break processes into smaller process steps to create reusable enterprise services that can easily be adapted to changing business needs. The documentation that follows describes the enterprise services that are available to you in SAP for Utilities. This documentation provides technical descriptions of specific enterprise service objects and is divided into bundles in the following schema: 1. 2. 3. 4.
Process Component Business Object Service Interface Enterprise Service Operation.
Enterprise service bundles provide an ideal starting point to explore the impact of service-oriented architecture (SOA) on your business processes. They create a comprehensive portfolio of business scenario descriptions that are SOA-enabled by solutions and enterprise services currently shipped by SAP. Enterprise service bundles documentation provides you with information about the impact of SOA on your business processes without requiring detailed knowledge of SAP solutions or technology. Each enterprise service bundle refers to a set of enterprise services that support a particular business process and are made available as part of the SAP Enhancement Packages for SAP Business Suite solutions.
Note To search for information about specific enterprise service fields, you can use the Utilities data type catalog at http://service.sap.com/~sapidb/011000358700001049282012E ( service.sap.com/utilities Information IS-U/CCS General Cookbook&Guidelines Utilities Data Type Catalog ).
SAP for Utilities
SAP for Utilities - Product
Specific use cases for service operations in the SAP for Utilities area can be found in the following enterprise service WIKIs (registration required): Advanced Meter Infrastructure WIKI at https://wiki.sdn.sap.com/wiki/display/ESpackages/Advanced+Meter+Infrastructure Market Communication WIKI at https://wiki.sdn.sap.com/wiki/display/ESpackages/Market+Communication For general information about the installation and prerequisites for using enterprise services, see the following information sources: SCN Community in the SAP Network at https://scn.sap.com/community/soa (registration required) SAP Note 1359215: Technical prerequisites for using enterprise services (relevant for ERP only)
1.13.1 Business Partner Data Management PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 13 of 130
Business Partner Data Processing enables a company to manage all Business Partner data that is relevant to control its business processes, such as sales, purchasing and accounting processes.
Technical Data Entity Type
Process Component
Software Component Version
ESM BS FOUND 731
Technical Name
BusinessPartnerDataManagement
Namespace
http://sap.com/xi/ESM/SUITE
1.13.1.1 Business Partner A carrier of unstructured information and additional control and monitoring information.
Technical Data Entity Type
Business Object
Software Component Version
ESM BS FOUND 731
Technical Name
BusinessPartner
Object Category
Master Data Object
1.13.1.1.1 Business Partner Replication In Technical Data Entity Type
Service Interface
Category
SAP A2A
Direction
inbound
1.13.1.1.1.1 Replicate Business Partner as Bulk Request to create or update Business Partners in a target system, using master data from a source system or file.
Technical Data Entity Type
Service Operation
Software Component Version
SAP_BS_FOUNDATION 731
Release State
released with restrictions
Technical Name
BusinessPartnerSUITEBulkReplicateRequest_In
Namespace
http://sap.com/xi/SAP_BS_FND/MDG/Global2
Application Component
CA-MDG-APP-BP
Web Service Definition (Back End)
BUSINESSPARTNERSUITEBULKREPLIC
Category
SAP A2A
Direction
inbound
Mode
asynchronous
Idempotency
not applicable
P2P Communication Enabled
yes
Message Types Business Partner SUITE Bulk Replicate Request
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 14 of 130
Notes on SAP Implementation The MDG_SE_BP_BULK_REPLRQ_IN Business Add-In (BAdI) is available for this operation.
1.13.1.1.2 Business Partner Replication Out Technical Data Entity Type
Service Interface
Category
SAP A2A
Direction
outbound
1.13.1.1.2.1 Confirm Business Partner Replication as Bulk Confirmation of the replication of business partners as bulk.
Technical Data Entity Type
Service Operation
Software Component Version
SAP_BS_FOUNDATION 731
Release State
released with restrictions
Technical Name
BusinessPartnerSUITEBulkReplicateConfirmation_Out
Namespace
http://sap.com/xi/SAP_BS_FND/MDG/Global2
Application Component
CA-MDG-APP-BP
Category
SAP A2A
Direction
outbound
Mode
asynchronous
Idempotency
not applicable
P2P Communication Enabled
yes
Message Types Business Partner SUITE Bulk Replicate Confirmation
1.13.1.1.3 Business Partner Replication Requesting In Inbound Interface for receiving Business Partner Replication Notification.
Technical Data Entity Type
Service Interface
Category
SAP A2A
Direction
inbound
1.13.1.1.3.1 Change Business Partner Replication Status as Bulk A mass confirmation of the replication of Business Partners.
Technical Data Entity Type
Service Operation
Software Component Version
SAP_BS_FOUNDATION 731
Release State
released with restrictions
Technical Name
BusinessPartnerSUITEBulkReplicateConfirmation_In
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 15 of 130
Namespace
http://sap.com/xi/SAP_BS_FND/MDG/Global2
Application Component
CA-MDG-APP-BP
Web Service Definition (Back End)
BUSINESSPARTNERSUITEBULKREPLI1
Category
SAP A2A
Direction
inbound
Mode
asynchronous
Idempotency
not applicable
P2P Communication Enabled
yes
Message Types Business Partner SUITE Bulk Replicate Confirmation
Notes on SAP Implementation The MDG_SE_BP_BULK_REPLCNF_IN Business Add-In (BAdI) is available for this operation.
1.13.1.1.4 Business Partner Replication Requesting Out Outbound Interface for Sending Business Partner Replication Notification.
Technical Data Entity Type
Service Interface
Category
SAP A2A
Direction
outbound
1.13.1.1.4.1 Request Business Partner Replication as Bulk A mass request to replicate Business Partners.
Technical Data Entity Type
Service Operation
Software Component Version
SAP_BS_FOUNDATION 731
Release State
released with restrictions
Technical Name
BusinessPartnerSUITEBulkReplicateRequest_Out
Namespace
http://sap.com/xi/SAP_BS_FND/MDG/Global2
Application Component
CA-MDG-APP-BP
Category
SAP A2A
Direction
outbound
Mode
asynchronous
Idempotency
not applicable
P2P Communication Enabled
yes
Message Types Business Partner SUITE Bulk Replicate Request
Notes on SAP Implementation The MDG_SE_BP_BULK_REPLRQ_OUT Business Add-In (BAdI) is available for this operation.
1.13.1.2 Payment Card PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 16 of 130
Payment Cards, such as credit cards, debit cards, or charge cards, are payment instruments issued by banks, financial institutions and businesses to individuals (card holders). The card holder can present the card to make cashless payments for goods and services at a merchant, who has an agreement with the issuer to accept the payment.
Technical Data Entity Type
Business Object
Software Component Version
ESM BS FOUND 731
Technical Name
PaymentCard
Object Category
Master Data Object
Features Payment Card consists of the card data (root) and information regarding blocks (node: Block).The business and technical purpose that applies to all service interfaces of this business object is the processing of payment card master records.Customer and business partner payment card master data are stored at two different storages in the SAP back-end system.The related semantic name of this object in the SAP SUITE back-end system is payment card master record.
Constraints You cannot delete a payment card master record from the SAP SUITE back-end system because this may result in inconsistencies, such as, if a payment card which has already been used for payment transactions will be physically removed from the system.
1.13.1.2.1 Payment Card Processing In Technical Data Entity Type
Service Interface
Category
SAP A2A
Direction
inbound
Business Context and Use The Manage Payment Card inbound service interface comprises operations that enable a payment card to be read, created or changed.
1.13.1.2.1.1 Change Payment Card To change a payment card master record.
Technical Data Entity Type
Service Operation
Software Component Version
SAP_BS_FOUNDATION 731
Release State
released
Technical Name
PaymentCardSUITEChangeRequestConfirmation_In
Namespace
http://sap.com/xi/SAP_BS_FND/Global2
Application Component
CA-EPT
Web Service Definition (Back End)
BS_PAYTCARDSUITECHGRC
Category
A2X
Direction
inbound
Mode
synchronous
Idempotency
yes
Change/Update Behavior
not applicable
P2P Communication Enabled
true
Business Context and Use PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 17 of 130
The Change Payment Card inbound operation changes a payment card.
Features To change a Payment Card, the following data is needed:
Input All mandatory fields have to be filled. ID (ID of the payment card) blockListCompleteTransmissionIndicator (If this indicator is set, all block items will be deleted, which are not part of the block payload.) CategoryCode (not supported; should therefore not be filled) TypeCode (type of payment card) ValidityStartDate (date from which the payment card is valid) ExpirationDate (date up to which the payment card is valid) IssueDate (date the payment card was issued) HolderName (name of the person or company to whom the payment card was issued) IssuerName (bank that issued the payment card) Block PaymentCardBlockingReasonCode (ndicates whether a payment card is blocked and for what reason) ActionCode (If the ActionCode is empty the default 01 = create is used automatically; only ActionCodes 01 (Create) and 03 (Delete) are supported.) ValidityPeriod StartDate (date as of which the payment card block is valid) EndDate (date up to which the payment card block is valid) Duration (not supported; should therefore not be filled) Output
Output For security reasons, the payment card ID which corresponds to the payment card number in the SAP Business Suite back-end system is not displayed. Instead the Payment Card MaskedID of the payment card master record is displayed, which has been created by the current service operation. The security level can be adjusted in Customizing of the SAP Business Suite back-end system underCross Application Components -> Payment Cards -> Basic Settings > Maintain Security Settings for Payment Cards.If the Customizing is not maintained only the first five and the last two digits of the card number are displayed (for example 99341*********77).
For security reasons, the payment card ID which corresponds to the payment card number in the SAP Business Suite back-end system is not displayed. Instead the Payment Card MaskedID of the payment card master record is displayed, which has been created by the current service operation. The security level can be adjusted in Customizing of the SAP Business Suite back-end system under Cross Application Components -> Payment Cards -> Basic Settings -> Maintain Security Settings for Payment Cards. If the Customizing is not maintained only the first five and the last two digits of the card number are displayed (for example 99341*********77).
Error Handling If errors occur, tThe system issues an error log.
Message Types PaymentCardSUITEChangeConfirmation_sync PaymentCardSUITEChangeRequest_sync
Prerequisites You have created a payment card master record.
Constraints ActionCode 02 used to change the block of a payment card is not supported. As an alternative you can delete the block and then create a new block
Notes on SAP Implementation Configuration You must run the application component Payment Card (AP-MD-PCA). You have defined at least one payment card type in Customizing under Cross Application Components -> Payment Cards -> Basic Settings -> Maintain Payment Card Type . Depending on the Customizing settings you have made for the security level, the system: Encrypts payment card numbers when they are saved Masks payment card numbers in the service confirmation message
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 18 of 130
You set the security level in Customizing under Cross Application Components -> Payment Cards -> Basic Settings -> Maintain Security Settings for Payment Cards . In addition, to ensure secure handling of payment card information in the SAP Business Suite, you must deactivate the recording of service calls in the PI monitor (also see SAP note 1032588). Enhancements There are three Business Add-Ins available to enhance the current operation: Change Payment Card ( PYCD _ESOA_PAYTCARDCHGRC), e nhancement spot PYCD_SPOT_ESOA_PAYT_CARDMethod INBOUND_PROCESSING of this BAdI is processed at the beginning of the operation. Using this method you can run checks and modify the input data. Method OUTBOUND_PROCESSING is processed at the end of the operation. Using this method you can modify the values in the response message before they are sent to the consumer. Mapping for Blocking Reason Code ( PYCD_ESOAMAP_PAYTCARDBLCKREAS), e nhancement spot PYCD_SPOT_ESOA_PAYT_CARD Using Method MAP_EXT2INT, you can implement your own value mapping for the external field PaymentCardBlockingReasonCode to the payment card block (data element CC_LOCK ) in the SAP Buisness Suite back-end system. Using Method MAP_INT2EXT, you can implement your own value mapping for the payment card block (data element CC_LOCK ) in the SAP Business Suite back-end system to the external field PaymentCardBlockingReasonCode. Mapping of Payment Card Type (BSBP_ESAMAP_PAYMNTCRDTYPE), e nhancement spot BSBP_ESAMAP_PAYMNTCRDTYPE Met hod: MAP_EXT2INT Using Method MAP_EXT2INT, you can implement your own value mapping for the external field TypeCode to the payment card type (data element CC_INSTITUTE) in the SAP Buisness Suite back-end system. Using Method MAP_INT2EXT, you can implement your own value mapping for the payment card type in the SAP Business Suite back-end system to the to the external field TypeCode.
1.13.1.2.1.2 Create Payment Card To create a payment card master record.
Technical Data Entity Type
Service Operation
Software Component Version
SAP_BS_FOUNDATION 731
Release State
released
Technical Name
PaymentCardSUITECreateRequestConfirmation_In
Namespace
http://sap.com/xi/SAP_BS_FND/Global2
Application Component
CA-EPT
Web Service Definition (Back End)
BS_PAYTCARDSUITECRTRC
Category
A2X
Direction
inbound
Mode
synchronous
Idempotency
yes
Change/Update Behavior
not applicable
P2P Communication Enabled
true
Business Context and Use The Create Payment Card inbound operation creates payment card master records in the SAP Business Suite back-end system.
Features To create a Payment Card, the following data is needed:
Input All mandatory elements have to be filled: PaymentCardID (number of the payment card) TypeCode (type of payment card) ValidityStartDate (date from which the payment card is valid) IssueDate (date the payment card was issued)If the IssueDate is not specified in the inbound service the IssueDate will be initial. ExpirationDate (date up to which the payment card is valid)If the ExpirationDate is not specified in the inbound service the ExpirationDate will automatically be set to December 31, 9999. HolderName (name of the person or company to whom the payment card was issued) IssuerName (bank that issued the payment card) Output
Output
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 19 of 130
Payment Card MaskedID For security reasons, the payment card ID which corresponds to the payment card number in the SAP Business Suite back-end system is not displayed. Instead the Payment Card MaskedID of the payment card master record is displayed, which has been created by the current service operation. The security level can be adjusted in Customizing of the SAP Business Suite back-end system under Cross Application Components -> Payment Cards -> Basic Settings -> Maintain Security Settings for Payment Cards. If the Customizing is not maintained only the first five and the last two digits of the card number are displayed (for example 99341*********77). In order to avoid errors when making entries, you can assign checking rules for payment card numbers (ID) to payment card types. The checking rules check whether certain conditions for the payment card type are met. You maintain checking rules for payment card types in Customizing of the SAP SUITE back-end system under Cross Application Components -> Payment Cards -> Basic Settings -> Assign Checking Rules .
Error Handling In case errors occur the system issues an error log.
Message Types PaymentCardSUITECreateConfirmation_sync PaymentCardSUITECreateRequest_sync
Constraints CategoryCode is not supported and should therefore not be filled.
Notes on SAP Implementation Configuration You must run the application component Payment Card (AP-MD-PCA). You have defined at least one payment card type in Customizing under Cross Application Components -> Payment Cards -> Basic Settings -> Maintain Payment Card Type . Depending on the Customizing settings you have made for the security level, the system: Encrypts payment card numbers when they are saved Masks payment card numbers in the service confirmation message You set the security level in Customizing under Cross Application Components -> Payment Cards -> Basic Settings -> Maintain Security Settings for Payment Cards . In addition, to ensure secure handling of payment card information in the SAP Business Suite, you must deactivate the recording of service calls in the PI monitor (also see SAP note 1032588). Enhancements There are two Business Add-Ins available to enhance the current operation: Create Payment Card (PYCD_ESOA_PAYTCARDCRTRC), enhancement spot PYCD_SPOT_ESOA_PAYT_CARDMethod INBOUND_PROCESSING of this BAdI is processed at the beginning of the operation. Using this method you can run checks and modify the input data.Method OUTBOUND_PROCESSING is processed at the end of the operation. Using this method you can modify the values in the response message before they are sent to the consumer. Mapping of Payment Card Type (BSBP_ESAMAP_PAYMNTCRDTYPE), enhancement spot BSBP_ESAMAP_PAYMNTCRDTYPE)Using Method MAP_EXT2INT, you can implement your own value mapping for the external field TypeCode to the payment card type (data element CC_INSTITUTE) in the SAP Buisness Suite back-end system.Using Method MAP_INT2EXT, you can implement your own value mapping for the payment card type (data element CC_INSTITUTE) in the SAP Business Suite back-end system to the external field TypeCode.
1.13.1.2.1.3 Read Payment Card To read details of a payment card master record.
Technical Data Entity Type
Service Operation
Software Component Version
SAP_BS_FOUNDATION 731
Release State
released
Technical Name
PaymentCardSUITEByIdQueryResponse_In
Namespace
http://sap.com/xi/SAP_BS_FND/Global2
Application Component
CA-EPT
Web Service Definition (Back End)
BS_PAYTCARDSUITEBYIDQR
Category
A2X
Direction
inbound
Mode
synchronous
Idempotency
no
Change/Update Behavior
not applicable
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 20 of 130
P2P Communication Enabled
true
Business Context and Use The Read Payment Card inbound operation returns all attributes of a payment card master record.
Features The Create Payment Card inbound operation reads detail information of payment card master records in the SAP Business Suite back-end system. To read a Payment Card, the following data is needed:
Input All mandatory elements have to be filled: PaymentCardID (number of the payment card) TypeCode (type of payment card) Output
Output Payment Card MaskedID For security reasons, the payment card ID which corresponds to the payment card number in the SAP Business Suite back-end system is not displayed. Instead the Payment Card MaskedID of the payment card master record is displayed, which has been created by the current service operation. The security level can be adjusted in Customizing of the SAP Business Suite back-end system under Cross Application Components -> Payment Cards -> Basic Settings -> Maintain Security Settings for Payment Cards. If the Customizing is not maintained only the first five and the last two digits of the card number are displayed (for example 99341*********77).
Error Handling If errors occur, the system issues an error log.
Message Types PaymentCardSUITEByIDQuery_sync PaymentCardSUITEByIDResponse_sync
Prerequisites You have created a payment card master record.
Notes on SAP Implementation Configuration You must run the application component Payment Card (AP-MD-PCA). Depending on the Customizing settings you have made for the security level, the system: Encrypts payment card numbers when they are saved Masks payment card numbers in the service confirmation message You make the settings for encryption and masking in Customizing of the SAP Business Suite back-end system under Cross Application Components -> Payment Cards -> Basic Settings -> Maintain Security Settings for Payment Cards . In addition, to ensure secure handling of payment card information in the SAP Business Suite, you must deactivate the recording of service calls in the PI monitor (also see SAP note 1032588). Enhancements There are two Business Add-Ins available to enhance the current operation: Read Payment Card (PYCD_ESOA_PAYTCARDBYIDQR), enhancement spot PYCD_SPOT_ESOA_PAYT_CARD Method INBOUND_PROCESSING of this BAdI is processed at the beginning of the operation. Using this method you can run checks and modify the input data.Method OUTBOUND_PROCESSING is processed at the end of the operation. Using this method you can modify the values in the response message before they are sent to the consumer. Mapping of Payment Card Type (BSBP_ESAMAP_PAYMNTCRDTYPE), enhancement spot BSBP_ESAMAP_PAYMNTCRDTYPEUsing Method MAP_EXT2INT, you can implement your own value mapping for the external field TypeCode to the payment card type (data element CC_INSTITUTE) in the SAP Buisness Suite back-end system.Using Method MAP_INT2EXT, you can implement your own value mapping for the payment card type (data element CC_INSTITUTE) in the SAP Business Suite back-end system to the external field TypeCode.
1.13.2 Utilities Business Partner Data Management Utilities Business Partner Data Management allows a company to manage all data for market participants in the Utilities sector that is required to control its business processes, such as grid usage requests, invoicing, payment processes, and so on.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 21 of 130
Technical Data Entity Type
Process Component
Software Component Version
ESM ERP 606
Technical Name
UtilitiesBusinessPartnerDataManagement
Namespace
http://sap.com/xi/ESM/ERP
Business Context and Use The Utilities Business Partner Data Management process component is used for applications in the Utilities industry to support divisions such as electricity, gas, and water. Market participants in both regulated energy markets and liberalized energy markets can use this process component. In liberalized markets, the market participant distributor performing the metering point administrator role, as well as the market participant supplier performing the roles of balance supplier and customer service responsible, need to operate on the basis of data for the Utilities business partner. The process component content can be applied by front end or back end users working with data in the Utilities business partner environment. Utilities business partner data consists of the address, communication identification and role-specific data for the service provider – distinguished in more detail by market roles - offering market services. The content of this process component enables you to search for and identify the Utilities business partner, and respectively, the service provider data. The process component is applied when a balance supplier registers with the metering point administrator (performed by the distributor) for grid usage to supply the newly acquired or moved-in customer (see process component Utilities Grid Usage Processing). It can also be used in a situation where a new meter administrator takes over the administration and operation services for a customer's meter.
Notes on SAP Implementation The target group must run the IS-U back-end application component to use the operations found in Utilities Business Partner Data Management .
1.13.2.1 Utilities Service Provider A Utilities Service Provider is a market participant in the utilities sector which offers services at a Utilities Point Of Delivery.
Technical Data Entity Type
Business Object
Software Component Version
ESM ERP 606
Technical Name
UtilitiesServiceProvider
Object Category
Master Data Object
Business Context and Use A Utilities Service Provider can be represented by various market participants in the utilities industry supporting divisions such as electricity, gas and water. Examples of these market participants are a distributor, supplier, meter operator or metered data responsible at distribution grid level or a transmission system operator, and wholesaler/ shipper at transmission grid level. These market participants offer specific market services such as grid usage, energy supply, meter installation & maintenance and measurement data provision. These market services are represented in the application as services at the Utilities Point Of Delivery. The business object Utilities Service Provider contains master data to be applied for inbound and outbound communication, address data and identification data required to identify the market participant in market communication.
Notes on SAP Implementation All service interfaces for this business object can only be used if the business function set Utilities is activated.
1.13.2.1.1 Manage Utilities Service Provider In An interface used to manage data for a utilities service provider.
Technical Data Entity Type
Service Interface
Category
A2X
Direction
inbound
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 22 of 130
Business Context and Use The Manage Utilities Service Provider In inbound service interface contains an operation that reads the basic data from the business object Utilities Service Provider, such as address or communication data using the service provider external identification.
1.13.2.1.1.1 Read Utilities Service Provider Basic Data To read utilities service provider basic data by ID.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
UtilitiesServiceProviderERPBasicDataByIDQueryResponse_In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Web Service Definition (Back End)
ISU_SERVPROVBDIDQR
Category
A2X
Direction
inbound
Mode
synchronous
Idempotency
no
Change/Update Behavior
not applicable
P2P Communication Enabled
true
Business Context and Use In liberalized energy markets, different market parties query master data to handle end customer processes. This service operation provides the master data for a service provider. This master data is relevant for communication in liberalized energy markets and can be used in different processes, for example, inbound validation of the service provider, determination of information for outbound processing, providing information for portal applications, and so on.
Related Operations The Find Utilities Service Provider by Identification inbound operation allows you to find the list of roles and identifications for a service provider.
Features The query returns the information related to the service provider, such as a list of roles and a list of identification with the code list agency if this has been defined. It also provides master data such as person name or organization name, address information and address and dependent communication data for the business partner assigned to the service provider. The query status is added to the log to indicate the success or failure of the operation.
Error Handling The operation returns an error message in the log if no input is provided or this input is incorrect.
Message Types UtilitiesServiceProviderERPBasicDataByIDQuery_sync UtilitiesServiceProviderERPBasicDataByIDResponse_sync
Notes on SAP Implementation Enhancements The new kernel-based BAdI definition ISU_SE_SERVPROVBDIDQR is available in the enhancement spot ISU_SPOT_SE_SERVPROV for this inbound operation, and is used to extend the customer-specific logic used to map the application data.
1.13.2.1.2 Query Utilities Service Provider In PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 23 of 130
1.13.2.1.2 Query Utilities Service Provider In An interface used to find data for a utilities service provider.
Technical Data Entity Type
Service Interface
Category
A2X
Direction
inbound
Business Context and Use The Query Utilities Service Provider In inbound service interface contains an operation that is required to query for the Utilities Service Provider business object using its external identification.
1.13.2.1.2.1 Find Utilities Service Provider by Identification To find a utilities service provider by identification.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
UtilitiesServiceProviderERPSimpleByIdentificationQueryResponse_In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Web Service Definition (Back End)
ISU_SERVPROV001QR
Category
A2X
Direction
inbound
Mode
synchronous
Idempotency
no
Change/Update Behavior
not applicable
P2P Communication Enabled
true
Business Context and Use The Find Utilities Service Provider by Identification service operation is used in the liberalized utilities markets where different market participants collaborate with each other. This service operation can be used to verify a market participant (service provider) using their external identification in a market message.
Related Operations The Read Utilities Service Provider Basic Data inbound operation is used to read the master data for the business partner assigned to the service provider using its internal ID.
Features This inbound operation performs a query to find the Utilities Service Provider by providing its external Identification (mandatory) and service type (optional). If the code list agency is defined for the requested external identification, it should also be provided. The query returns the information related to the service provider: Service provider ID, list of role and list of identification. The query result is also recorded in the log, for example, ‘Successful processing’, when the service provider is found.
Error Handling The operation returns error messages in the log if no input is provided or the input is incorrect.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 24 of 130
Message Types UtilitiesServiceProviderERPSimpleByIdentificationQuery_sync UtilitiesServiceProviderERPSimpleByIdentificationResponse_sync
Notes on SAP Implementation Enhancements The new kernel-based BAdI definition ISU_SE_SERVPROV001QR is available in the enhancement spot ISU_SPOT_SE_SERVPROV for this inbound operation. You can use this BAdI definition to extend the customer-specific logic used to map application data.
1.13.3 Measurement Processing Measurement Processing groups business objects and the related service operations needed to process measurement data.
Technical Data Entity Type
Process Component
Software Component Version
ESM ERP 606
Technical Name
MeasurementProcessing
Namespace
http://sap.com/xi/ESM/ERP
Business Context and Use The Measurement Processing process component covers the exchange of measurement relevant master data and meter readings. With the help of these services, you can request meter readings for a specific date, cancel such a request, upload the corresponding meter readings, and identify and read the corresponding meter reading documents. In the context of smart meters, the communication takes place asynchronously between SAP systems and a meter data synchronization and unification (MDUS) system.
Constraints The target group must run the IS-U back-end application component in order to use the operations that Measurement Processing contains.
Notes on SAP Implementation Prerequisites In order to use the operations contained in the Measurement Processing process component, you must run SAP ERP Industry Extension Utilities, Waste & Recycling, the SAP for Utilities back-end component. To be able to use the operations in the Measurement Reading business object, you must run the Measuring Points and Counters (PM-EQM-SF-MPC) application component.
Processing The Measurement Processing process component enables communication with data of the following SAP ECC application components: Meter Reading in the Utilities Industry (IS-U/DM-MR) industry-specific component Measuring Points and Counters (PM-EQM-SF-MPC)
1.13.3.1 Measurement Reading A Measurement Reading is a reading taken from a measuring device. On the basis of this reading, maintenance activities are performed at installation points or on individual materials. For example, the temperature of a coolant pipe is measured in Celsius and entered as 25 degrees Celsius.
Technical Data Entity Type
Business Object
Software Component Version
ESM ERP 606
Technical Name
MeasurementReading
Object Category
Business Process Object
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 25 of 130
Business Context and Use The Measurement Reading business object is used by maintenance technicians to manage and search for measurement readings.
1.13.3.1.1 Manage Measurement Reading In An interface to perform maintenance functions for measurement readings.
Technical Data Entity Type
Service Interface
Category
SAP A2A
Direction
inbound
Business Context and Use This inbound service groups together operations that are used by maintenance technicians to create, display, check, and cancel measurement readings.
1.13.3.1.1.1 Cancel Measurement Reading Technical Data Entity Type
Service Operation
Software Component Version
ESA ECC-SE 605
Release State
released
Technical Name
MeasurementReadingERPCancelRequestConfirmation_In
Namespace
http://sap.com/xi/EA-APPL/SE/Global
Application Component
PM
Web Service Definition (Back End)
ECC_MSMTRDNGCNCRC
Category
SAP A2A
Direction
inbound
Mode
synchronous
Idempotency
yes
Change/Update Behavior
not applicable
P2P Communication Enabled
true
Business Context and Use This inbound operation is used by maintenance technicians to cancel a measurement reading.
Features This inbound operation processes the following message types: MeasurementReadingERPCancelRequest_sync MeasurementReadingERPCancelConfirmation_sync The following value must be supplied: MeasurementReadingID
Message Types MeasurementReadingERPCancelConfirmation_sync MeasurementReadingERPCancelRequest_sync
Prerequisites A measurement reading that has not been canceled must exist in the system. You can create a measurement reading with either the appropriate operation or
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 26 of 130
transaction IK11 in the back-end system.
Notes on SAP Implementation Prerequisites You are running the Measuring Points and Counters (PM-EQM-SF-MPC) application component.
Processing The EAM_SE_MSMTRDNGCRTRC Business Add-In (enhancement spot EAM_SPOT_SE_MSMTRDNG) is available for this operation.
1.13.3.1.1.2 Check Measurement Reading Creation Technical Data Entity Type
Service Operation
Software Component Version
ESA ECC-SE 605
Release State
released
Technical Name
MeasurementReadingERPCreateCheckQueryResponse_In
Namespace
http://sap.com/xi/EA-APPL/SE/Global
Application Component
PM
Web Service Definition (Back End)
ECC_MSMTRDNGCRTCHKQR
Direction
inbound
Mode
synchronous
Idempotency
no
Change/Update Behavior
not applicable
P2P Communication Enabled
true
Business Context and Use This inbound operation is used by maintenance technicians to check the consistency of a measurement reading before it is created.
Features This inbound operation processes the following message types: MeasurementReadingERPCreateCheckQuery_sync MeasurementReadingERPCreateCheckResponse_sync
Linear Asset Management LinearInformation provides the linear attributes of a technical asset in a measurement reading. This information can be used to localize a technical asset along a technical linear asset in a measurement reading. The elements located directly below the node Linear Information are defined by the data type MeasurementReadingLinearInformationElements . These elements are: StartLinearTechnicalAssetMarkerID: optionalStartLinearTechnicalAssetMarkerID identifies a marker of a StartPointMeasure in a linear technical asset or segment in a measurement reading. EndLinearTechnicalAssetMarkerID: optionalEndLinearTechnicalAssetMarkerID identifies a marker of an EndPointMeasure in a linear technical asset or segment in a measurement reading. StartPointMeasure: optionalStartPoint identifies the start position of a technical asset along a linear asset technical asset or segment in a measurement reading. EndPointMeasure: optionalEndPoint identifies the end position of a technical asset along a linear technical asset or segment in a measurement reading. LengthMeasure: optionalLength identifies the length of a linear technical asset or segment in a measurement reading. StartMarkerLengthMeasure: optionalStartMarkerLengthMeasure identifies the length between the StartPointMeasure and StartLinearTechnicalAssetMarkerID of a linear technical asset or segment in a measurement reading. EndMarkerLengthMeasure: optionalEndMarkerLengthMeasure identifies the length between the EndMarkerLengthMeasure and EndLinearTechnicalAssetMarkerID of a linear technical asset or segment in a measurement reading. LinearInformationFirstOffset identifies the localization of a technical asset in relation to a reference point or line of a technical asset in a measurement reading. LinearInformationSecondOffset identifies the localization of a technical asset in relation to a second reference point or line of a technical asset in a measurement reading. Integrity Conditions: the subelements for StartPointMeasure , EndPointMeasure and LengthMeasure are set to optional. However, the representation can only contain one of the following data sets: 1. StartPointMeasure
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 27 of 130
2. StartPointMeasure and EndPointMeasure 3. StartPointMeasure and EndPointMeasure and LengthMeasure 4. StartPointMeasure and LengthMeasure.
Message Types MeasurementReadingERPCreateCheckQuery_sync MeasurementReadingERPCreateCheckResponse_sync
Prerequisites Before you create a measurement reading, you must create at least one measuring device in the system. Use transaction IK01 to create a measuring device. You have configured the Measuring Points and Counters (PM-EQM-SF-MPC) application component to suit your requirements.
Notes on SAP Implementation Prerequisites You are running the Measuring Points and Counters (PM-EQM-SF-MPC) application component.
Processing If the variables DateTime and RecordingPersonFormattedName are not filled, the system generates default values for these variables. These are generated as follows: DateTime – Today's date and current time RecordingPersonFormattedName – Name of the user that is logged on (sy-uname) The EAM_SE_MSMTRDNGCRTRC Business Add-In (enhancement spot EAM_SPOT_SE_MSMTRDNG) is available for this operation.
Configuration for Linear Asset Management You have activated the EAM, Linear Asset Management 1 (LOG_EAM_LINEAR_1) business function. You have made any relevant Customizing settings for measurement readings used in Linear Asset Management. You have defined offset types in Customizing for Plant Maintenance and Customer Service under Master Data in Plant Maintenance and Customer Service Technical Objects Linear Asset Management Define Offset Types.
1.13.3.1.1.3 Create Measurement Reading Technical Data Entity Type
Service Operation
Software Component Version
ESA ECC-SE 605
Release State
released
Technical Name
MeasurementReadingERPCreateRequestConfirmation_In
Namespace
http://sap.com/xi/EA-APPL/SE/Global
Application Component
PM
Web Service Definition (Back End)
ECC_MSMTRDNGCRTRC
Direction
inbound
Mode
synchronous
Idempotency
yes
Change/Update Behavior
not applicable
P2P Communication Enabled
true
Business Context and Use This inbound operation is used by maintenance technicians to create a measurement reading.
Features This inbound operation processes the following message types: MeasurementReadingERPCreateRequest_sync MeasurementReadingERPCreateConfirmation_sync
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 28 of 130
Linear Asset Management Linear information provides linear attributes of a technical asset in a measurement reading. This information can be used to localize a technical asset along a technical linear asset in a measurement reading.The elements located directly at the node Linear Information are defined by the data type: MeasurementReadingLinearInformationElements. These elements are: StartLinearTechnicalAssetMarkerID: optionalStartLinearTechnicalAssetMarkerID identifies a marker of StartPointMeasure in a linear technical asset or segment in a measurement reading. EndLinearTechnicalAssetMarkerID: optionalEndLinearTechnicalAssetMarkerID identifies a marker of EndPointMeasure in a linear technical asset or segment in a measurement reading. StartPointMeasure: optionalStartPoint identifies the start position of a technical asset along a linear asset technical asset or segment in a measurement reading. EndPointMeasure: optionalEndPoint identifies the end position of a technical asset along a linear technical asset or segment in a measurement reading. LengthMeasure: optionalLength identifies the length of a linear technical asset or segment in a measurement reading. StartMarkerLengthMeasure: optionalStartMarkerLengthMeasure identifies the length between StartPointMeasure and StartLinearTechnicalAssetMarkerID of a linear technical asset or segment in a measurement reading. EndMarkerLengthMeasure: optionalEndMarkerLengthMeasure identifies the length between EndMarkerLengthMeasure and EndLinearTechnicalAssetMarkerID of a linear technical asset or segment in a measurement reading. LinearInformationFirstOffset identifies the localization of a technical asset in relation to a reference point or line of a technical asset in a measurement reading. LinearInformationSecondOffset identifies the localization of a technical asset in relation to a second reference point or line of a technical asset in a measurement reading. Integrity Conditions:The subelements for StartPointMeasure, EndPointMeasure and LenghtMeasure are set to optional. However, the representation can only comprise one of the following data sets: 1. StartPointMeasure 2. StartPointMeasure and EndPointMeasure 3. StartPointMeasure and EndPointMeasure and LenghtMeasure 4. StartPointMeasure and LenghtMeasure.
Message Types MeasurementReadingERPCreateConfirmation_sync MeasurementReadingERPCreateRequest_sync
Prerequisites Before you create a measurement reading, at least one measuring device must be created in the system. Use transaction IK01 to create a measuring device. You have configured the Measuring Points and Counters (PM-EQM-SF-MPC) application component to suit your requirements.
Notes on SAP Implementation Prerequisites You run the Measuring Points and Counters (PM-EQM-SF-MPC) application component.
Processing If the variables DateTime and RecordingPersonFormattedName are not filled, default values are generated for these variables. These are generated in the following way: DateTime – Today's date and current time RecordingPersonFormattedName – Name of the user that is logged on (sy-uname) The EAM_SE_MSMTRDNGCRTRC Business Add-In (enhancement spot EAM_SPOT_SE_MSMTRDNG) is available for this operation. This service operation is designed as Idempotency.
Configuration for Linear Asset Management You have activated the EAM, Linear Asset Management 1 (LOG_EAM_LINEAR_1) business function. You have made any relevant Customizing settings for measurement readings used in Linear Asset Management. You have defined offset types in Customizing for Plant Maintenance and Customer Service under Master Data in Plant Maintenance and Customer Service Technical Objects Linear Asset Management Define Offset Types.
1.13.3.1.1.4 Read Measurement Reading Technical Data Entity Type
Service Operation
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 29 of 130
Software Component Version
ESA ECC-SE 605
Release State
released
Technical Name
MeasurementReadingERPByIDQueryResponse_In
Namespace
http://sap.com/xi/EA-APPL/SE/Global
Application Component
PM
Web Service Definition (Back End)
ECC_MSMTRDNGIDQR
Direction
inbound
Mode
synchronous
Idempotency
no
Change/Update Behavior
not applicable
P2P Communication Enabled
true
Business Context and Use This inbound operation is used by maintenance technicians to display a measurement reading.
Features This inbound operation processes the following message types: MeasurementReadingERPByIDQuery_sync MeasurementReadingERPByIDResponse_sync The following value must be supplied: MeasurementReadingID
Linear Asset Management LinearInformation provides linear attributes of a technical asset in a measurement reading. This information can be used to localize a technical asset along a technical linear asset in a measurement reading. The elements located directly at the node Linear Information are defined by the data type: MeasurementReadingLinearInformationElements. These elements are: StartLinearTechnicalAssetMarkerID: optionalStartLinearTechnicalAssetMarkerID identifies a marker of StartPointMeasure in a linear technical asset or segment in a measurement reading. EndLinearTechnicalAssetMarkerID: optionalEndLinearTechnicalAssetMarkerID identifies a marker of EndPointMeasure in a linear technical asset or segment in a measurement reading. StartPointMeasure: optionalStartPoint identifies the start position of a technical asset along a linear asset technical asset or segment in a measurement reading. EndPointMeasure: optionalEndPoint identifies the end position of a technical asset along a linear technical asset or segment in a measurement reading. LengthMeasure: optionalLength identifies the length of a linear technical asset or segment in a measurement reading. StartMarkerLengthMeasure: optionalStartMarkerLengthMeasure identifies the length between StartPointMeasure and StartLinearTechnicalAssetMarkerID of a linear technical asset or segment in a measurement reading. EndMarkerLengthMeasure: optionalEndMarkerLengthMeasure identifies the length between EndMarkerLengthMeasure and EndLinearTechnicalAssetMarkerID of a linear technical asset or segment in a measurement reading. LinearInformationFirstOffset identifies the localization of a technical asset in relation to a reference point or line of a technical asset in a measurement reading. LinearInformationSecondOffset identifies the localization of a technical asset in relation to a second reference point or line of a technical asset in a measurement reading. Integrity Conditions:The subelements for StartPointMeasure, EndPointMeasure and LenghtMeasure are set to optional. However, the representation can only comprise one of the following data sets: 1. StartPointMeasure 2. StartPointMeasure and EndPointMeasure 3. StartPointMeasure and EndPointMeasure and LenghtMeasure 4. StartPointMeasure and LenghtMeasure.
Message Types MeasurementReadingERPByIDQuery_sync MeasurementReadingERPByIDResponse_sync
Prerequisites At least one measurement reading must exist in the system. You can create a measurement reading with either the appropriate operation or transaction IK11 in the back-end system.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 30 of 130
Notes on SAP Implementation Prerequisites You run the Measuring Points and Counters (PM-EQM-SF-MPC) application component.
Processing The EAM_SE_MSMTRDNGCRTRC Business Add-In (enhancement spot EAM_SPOT_SE_MSMTRDNG) is available for this operation.
Configuration for Linear Asset Management You have activated the EAM, Linear Asset Management 1 (LOG_EAM_LINEAR_1) business function. You have made any relevant Customizing settings for measurement readings used in Linear Asset Management. You have defined offset types in Customizing for Plant Maintenance and Customer Service under Master Data in Plant Maintenance and Customer Service Technical Objects Linear Asset Management Define Offset Types.
1.13.3.1.2 Measurement Reading In Inbound Asynchronous Service Interface for Measurement Reading
Technical Data Entity Type
Service Interface
Category
SAP A2A
Direction
Inbound
1.13.3.1.2.1 Create Measurement Reading as Bulk To create measurement readings.
Technical Data Entity Type
Service Operation
Software Component Version
EA-APPL 606
Release State
released
Technical Name
MeasurementReadingERPBulkCreateRequest_In
Namespace
http://sap.com/xi/PLM/Global2
Direction
inbound
Mode
asynchronous
Idempotency
no
P2P Communication Enabled
no
Message Types MeasurementReadingERPBulkCreateRequest_sync
1.13.3.1.3 Query Measurement Reading In An interface to find measurement readings for maintenance purposes.
Technical Data Entity Type
Service Interface
Category
A2X
Direction
inbound
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 31 of 130
Business Context and Use This inbound service interface groups together operations that are used by maintenance technicians to find measurement readings.
1.13.3.1.3.1 Find Latest Measurement Reading Technical Data Entity Type
Service Operation
Software Component Version
ESA ECC-SE 605
Release State
released
Technical Name
LatestMeasurementReadingERPByMeasuringDeviceIDQueryResponse_In
Namespace
http://sap.com/xi/EA-APPL/SE/Global
Application Component
PM
Web Service Definition (Back End)
ECC_LSTMSMTRDNGBYMSRDEVIDQR
Direction
inbound
Mode
synchronous
Idempotency
no
Change/Update Behavior
not applicable
P2P Communication Enabled
true
Business Context and Use This inbound operation is used by maintenance technicians to display the last measurement reading for a measuring device.
Features This inbound operation processes the following message types: LatestMeasurementReadingERPByMeasuringDeviceIDQuery_sync LatestMeasurementReadingERPByMeasuringDeviceIDResponse_sync The following value must be supplied: MeasuringDeviceID
Linear Asset Management LinearInformation provides linear attributes of a technical asset in a measurement reading. This information can be used to localize a technical asset along a technical linear asset in a measurement reading. The elements located directly at the node Linear Information are defined by the data type: MeasurementReadingLinearInformationElements. These elements are: StartLinearTechnicalAssetMarkerID: optionalStartLinearTechnicalAssetMarkerID identifies a marker of StartPointMeasure in a linear technical asset or segment in a measurement reading. EndLinearTechnicalAssetMarkerID: optionalEndLinearTechnicalAssetMarkerID identifies a marker of EndPointMeasure in a linear technical asset or segment in a measurement reading. StartPointMeasure: optionalStartPoint identifies the start position of a technical asset along a linear asset technical asset or segment in a measurement reading. EndPointMeasure: optionalEndPoint identifies the end position of a technical asset along a linear technical asset or segment in a measurement reading. LengthMeasure: optionalLength identifies the length of a linear technical asset or segment in a measurement reading. StartMarkerLengthMeasure: optionalStartMarkerLengthMeasure identifies the length between StartPointMeasure and StartLinearTechnicalAssetMarkerID of a linear technical asset or segment in a measurement reading. EndMarkerLengthMeasure: optionalEndMarkerLengthMeasure identifies the length between EndMarkerLengthMeasure and EndLinearTechnicalAssetMarkerID of a linear technical asset or segment in a measurement reading. LinearInformationFirstOffset identifies the localization of a technical asset in relation to a reference point or line of a technical asset in a measurement reading. LinearInformationSecondOffset identifies the localization of a technical asset in relation to a second reference point or line of a technical asset in a measurement reading. Integrity Conditions: The subelements for StartPointMeasure, EndPointMeasure and LenghtMeasure are set to optional. However, the representation can only comprise one of the following data sets:1. StartPointMeasure2. StartPointMeasure and EndPointMeasure3. StartPointMeasure and EndPointMeasure and LenghtMeasure4. StartPointMeasure and LenghtMeasure.
Message Types LatestMeasurementReadingERPByMeasuringDeviceIDQuery_sync LatestMeasurementReadingERPByMeasuringDeviceIDResponse_sync
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 32 of 130
Prerequisites At least one measuring device must exist in the system. Use transaction IK01 to create a measuring device.
Notes on SAP Implementation Prerequisites You run the Measuring Points and Counters (PM-EQM-SF-MPC) application component.
Processing The EAM_SE_LSTMSMTRDNGBYMSRDEVIDQR business add-in (enhancement spot EAM_SPOT_SE_MSMTRDNG) is available for this operation.
Configuration for Linear Asset Management You have activated the EAM, Linear Asset Management 1 (LOG_EAM_LINEAR_1) business function. You have made any relevant Customizing settings for measurement readings used in Linear Asset Management. You have defined offset types in Customizing for Plant Maintenance and Customer Service under Master Data in Plant Maintenance and Customer Service Technical Objects Linear Asset Management Define Offset Types.
1.13.3.1.3.2 Find Measurement Reading ERP by Measuring Device Technical Data Entity Type
Service Operation
Software Component Version
SAP APPL 6.06
Release State
released
Technical Name
MeasurementReadingERPByMeasuringDeviceIDQueryResponse_In
Namespace
http://sap.com/xi/APPL/Global2
Application Component
PM
Web Service Definition (Back End)
ECC_MSMTRDNGBYMSRDEVIDQR
Direction
inbound
Mode
synchronous
Idempotency
no
Change/Update Behavior
not applicable
P2P Communication Enabled
true
Business Context and Use In a measurement processing scenario, measurement devices are installed at specific locations and supply maintenance providers with measurement readings. Maintenance activities are then performed on the basis of these readings. Find Measurement Reading ERP By Measuring Device is used to find all measurement readings taken by a given measuring device before a specified point in time.
Features To find the measurement reading for a measuring device before a specified point in time, the following information is needed: The ID of the measuring device for which you would like the measurement reading (MeasuringDeviceID element) The point in time before which you would like the measurement reading for (CutoffMeasurementReadingDateTime element). If you do not specify a point in time, the operation will automatically fill the current date and time. The value for the QueryHitsMaximumNumberValue element is 100 by default. If only the latest measurement (according to given time point) is needed, enter 1. If you enter a value for the QueryHitsMaximumNumberValue element, do not set the UnlimitedQueryHitsIndicator.
Linear Asset Management LinearInformation provides linear attributes of a technical asset in a measurement reading. This information can be used to localize a technical asset along a technical linear asset in a measurement reading. The elements located directly at the node Linear Information are defined by the data type: MeasurementReadingLinearInformationElements. These elements are: StartLinearTechnicalAssetMarkerID: optionalStartLinearTechnicalAssetMarkerID identifies a marker of StartPointMeasure in a linear technical asset or segment in a measurement reading. EndLinearTechnicalAssetMarkerID: optionalEndLinearTechnicalAssetMarkerID identifies a marker of EndPointMeasure in a linear technical asset or segment in a measurement reading.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 33 of 130
StartPointMeasure: optionalStartPoint identifies the start position of a technical asset along a linear asset technical asset or segment in a measurement reading. EndPointMeasure: optionalEndPoint identifies the end position of a technical asset along a linear technical asset or segment in a measurement reading. LengthMeasure: optionalLength identifies the length of a linear technical asset or segment in a measurement reading. StartMarkerLengthMeasure: optionalStartMarkerLengthMeasure identifies the length between StartPointMeasure and StartLinearTechnicalAssetMarkerID of a linear technical asset or segment in a measurement reading. EndMarkerLengthMeasure: optionalEndMarkerLengthMeasure identifies the length between EndMarkerLengthMeasure and EndLinearTechnicalAssetMarkerID of a linear technical asset or segment in a measurement reading. LinearInformationFirstOffset identifies the localization of a technical asset in relation to a reference point or line of a technical asset in a measurement reading. LinearInformationSecondOffset identifies the localization of a technical asset in relation to a second reference point or line of a technical asset in a measurement reading. Integrity Conditions: The subelements for StartPointMeasure, EndPointMeasure and LenghtMeasure are set to optional. However, the representation can only comprise one of the following data sets: 1. StartPointMeasure 2. StartPointMeasure and EndPointMeasure 3. StartPointMeasure and EndPointMeasure and LenghtMeasure 4. StartPointMeasure and LenghtMeasure.
Message Types MeasurementReadingERPByMeasuringDeviceIDQuery_sync MeasurementReadingERPByMeasuringDeviceIDResponse_sync
Notes on SAP Implementation Enhancements The EAM_APPL_SE_MSMTRDNGBYMSRDEVID Business Add-in (BAdI) is available for this operation.
Configuration for Linear Asset Management You have activated the EAM, Linear Asset Management 1 (LOG_EAM_LINEAR_1) business function. You have made any relevant Customizing settings for measurement readings used in Linear Asset Management. You have defined offset types in Customizing for Plant Maintenance and Customer Service under Master Data in Plant Maintenance and Customer Service Technical Objects Linear Asset Management Define Offset Types.
1.13.3.1.3.3 Find Measurement Reading by Elements Technical Data Entity Type
Service Operation
Software Component Version
ESA ECC-SE 605
Release State
released
Technical Name
MeasurementReadingERPSimpleByElementsQueryResponse_In
Namespace
http://sap.com/xi/EA-APPL/SE/Global
Application Component
PM
Web Service Definition (Back End)
ECC_MSMTRDNG001QR
Direction
inbound
Mode
synchronous
Idempotency
no
Change/Update Behavior
not applicable
P2P Communication Enabled
true
Business Context and Use This inbound operation is used by maintenance technicians to display a list of measurement readings that match the chosen selection criteria.
Features This inbound operation processes the following message types: MeasurementReadingERPSimpleByElementsQuery_sync
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 34 of 130
MeasurementReadingERPSimpleByElementsResponse_sync One of the following values must be supplied: MeasuringDeviceID InstallationPointID IndividualMaterialID
Message Types MeasurementReadingERPSimpleByElementsQuery_sync MeasurementReadingERPSimpleByElementsResponse_sync
Prerequisites At least one measurement reading must exist in the system. A measurement reading can be created with either the appropriate operation or transaction IK11 in the back-end system.
Notes on SAP Implementation Prerequisites You run the Measuring Points and Counters (PM-EQM-SF-MPC) application component.
Processing The EAM_SE_MSMTRDNG001QR business add-in (enhancement spot EAM_SPOT_SE_MSMTRDNG) is available for this operation.
1.13.3.2 Meter Reading Card Meter reading card for transferring meter reading data.
Technical Data Entity Type
Business Object
Software Component Version
ESM ERP 606
Technical Name
MeterReadingCard
Object Category
Business Process Object
Business Context and Use The Meter Reading Card business object contains operations that enable the transfer of meter reading data.
Notes on SAP Implementation You must activate the Utilities business function set (ISU_UTIL_1) to use the service interfaces for this business object.
1.13.3.2.1 Manage Meter Reading Card An interface to manage meter reading cards.
Technical Data Entity Type
Service Interface
Category
A2X
Direction
inbound
Business Context and Use The Manage Meter Reading Card inbound service interface groups together operations that are relevant to the management of meter reading cards.
1.13.3.2.1.1 Change Meter Reading Card PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 35 of 130
1.13.3.2.1.1 Change Meter Reading Card Query and response for processing meter reading data.
Technical Data Entity Type
Service Operation
Software Component Version
ESA ECC-SE 605
Release State
released
Technical Name
MeterReadingCardChangeRequestConfirmation_In
Namespace
http://sap.com/xi/IS-U/SE/Global
Application Component
IS-U
Web Service Definition (Back End)
ISU_METERREADINGCARDCHGRC
Direction
inbound
Mode
synchronous
Idempotency
no
Change/Update Behavior
not applicable
P2P Communication Enabled
true
Business Context and Use The Change Meter Reading Card inbound operation can be used to receive and process meter reading data.
Features When this operation is executed, the meter reading results are stored in the SAP for Utilities System.
Error Handling A plausibility check of the received meter reading data is provided by downstream processes.
Message Types MeterReadingCardChangeConfirmation MeterReadingCardChangeRequest
Notes on SAP Implementation Switch Framework You must activate the Utilities business function set (ISU_UTIL_1).
Configuration This operation is suitable for the Utilities Industry Solutions sector. To use this operation, you must implement the SAP for Utilities (IS-U) application component. Note that users require the correct authorization to create meter reading results (authorization object E_MR_DOC).
Enhancements The ISU_SE_METERREADINGCARD_CHGRC Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot ISU_SPOT_SE_EET. This BAdI allows you to create customer-specific logic for the inbound and outbound mapping of application data.
1.13.3.3 Meter Reading Document A Meter Reading Document is a document that contains data with regard to a planned and performed meter reading for one measurement task.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 36 of 130
Technical Data Entity Type
Business Object
Software Component Version
ESM ERP 606
Technical Name
MeterReadingDocument
Object Category
Business Process Object
Business Context and Use The business object Meter Reading Document enables the management of meter readings and meter reading results in SAP for Utilities. Readings are either taken periodically for periodic billing, according to the measurement task, or aperiodically, such as for control meter readings and readings at the time of device replacement, removal, or disconnection. Readings can also be taken for a certain activity, such as a move-in or a removal. In this case, the meter reading is triggered directly by the activity.
Notes on SAP Implementation You must activate the Utilities (ISU_UTIL_1) business function set to use the service interfaces of this business object.
1.13.3.3.1 Manage Meter Reading Document In An interface to process meter reading documents.
Technical Data Entity Type
Service Interface
Category
A2X
Direction
inbound
Business Context and Use The service interface Manage Meter Reading Document In groups inbound service operations (A2X) to process the Meter Reading Document, and is contained in the Measurement Processing process component. These service operations are used to read meter reading document data, to create meter reading documents and meter reading results, and to cancel meter reading documents in the ERP system. In order to handle meter readings, these services can be used in customer self-service processes and portal applications.
1.13.3.3.1.1 Cancel Meter Reading Document To cancel a meter reading document.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
MeterReadingDocumentERPCancellationRequestConfirmation_In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Web Service Definition (Back End)
ISU_MRDOCCNCRC
Category
A2X
Direction
inbound
Mode
synchronous
Idempotency
yes
Change/Update Behavior
not applicable
P2P Communication Enabled
true
Business Context and Use PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 37 of 130
The Cancel Meter Reading Document inbound service operation cancels a meter reading document. The operation can only be performed if the meter reading is not already being used in an invoice request (meaning that it is billed) and for documents with the following meter reading reasons: 1 – Periodic 2 – Interim With Billing 5 – Service Territory Transfer With Billing 9 – Interim Without Billing 10 – Control You can use Create Meter Reading Document With Reference To Utilities Device to create meter reading documents.
Features To cancel a meter reading document, you must provide the following value: Meter Reading Document ID If the service operation is successful, it deletes the meter reading document with the ID that is identified. The BusinessDocumentProcessingResultCode is defined accordingly.
Error Handling Typical errors are: General mapping error: MeterReadingDocumentID (Int. MR doc. ID) is initial – you must provide an ID Meter reading document does not exist – there is no meter reading document with the specified ID Meter reading documents with this reason cannot be cancelled – you can only cancel meter reading documents with meter reading reasons 1, 2, 5, 9, and 10, respectively. Cancellation is not possible for the selected entry – see the additional information for this log item (WebURI). One reason could be that the meter reading has already been billed.
Message Types MeterReadingDocumentERPCancellationConfirmation_sync MeterReadingDocumentERPCancellationRequest_sync
Notes on SAP Implementation To use this service operation, the Utilities application component (IS-U) should be implemented, and the Utilities business function set must be activated. Note that users should have unrestricted authorization to cancel meter reading documents. The ISU_SE_MRDOCCNCRC Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot: ISU_SPOT_SE_MRD. This BAdI allows customer-specific logic to be used for the inbound/outbound mapping of application data. The implementations are sorted according to the field layer of a BAdI implementation: SAP standard, partner, customer, and so on.
1.13.3.3.1.2 Cancel Meter Reading Document Result To cancel a meter reading document result.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Notes on Release State Technical Name
MeterReadingDocumentERPResultCancellationRequestConfirmation_In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Web Service Definition (Back End)
ISU_MRDRESULTCNCRC
Category
A2X
Direction
inbound
Mode
synchronous
Idempotency
yes
Change/Update Behavior
not applicable
P2P Communication Enabled
true
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 38 of 130
Business Context and Use The Cancel Meter Reading Document Result inbound service operation cancels a meter reading document result. The operation can only be performed if the meter reading is not already being used in an invoice request (meaning that it is billed). You can use the service operation Create Meter Reading Document Result to create a result for a meter reading document.
Features To cancel a meter reading result, the following value must be provided: Meter Reading Document ID If the service operation is successful, it deletes the result node for the meter reading document and changes the status of the meter reading document from Result Received to Result Requested . The BusinessDocumentProcessingResultCode is defined accordingly.
Error Handling Typical errors are: General mapping error: MeterReadingDocumentID (Int. MR doc. ID) is initial – you must provide an ID Meter reading document does not exist – there is no meter reading document with the specified ID The meter reading document result cannot be cancelled – the result node does not exist The meter reading cannot be reset because it has been billed
Message Types MeterReadingDocumentERPResultCancellationConfirmation_sync MeterReadingDocumentERPResultCancellationRequest_sync
Notes on SAP Implementation To use this service operation, the Utilities application component (IS-U) should be implemented, and the Utilities business function set must be activated. Note that users should have authorization to change valid and invalid meter reading results (action ’04’ Correct implausible meter reading results and ‘05’ Correct plausible meter reading results, respectively). The ISU_SE_MRDRESULTCNCRC Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot: ISU_SPOT_SE_MRD. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
1.13.3.3.2.10 Create Meter Reading Document Result To create a new result for a Meter Reading Document.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
MeterReadingDocumentERPResultCreateRequestConfirmation_In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Web Service Definition (Back End)
ISU_MRDRESULTCRTRC
Category
A2X
Direction
inbound
Mode
synchronous
Idempotency
yes
Change/Update Behavior
not applicable
P2P Communication Enabled
true
Business Context and Use The Create Meter Reading Document Result is used to create a result for an existing Meter Reading Document. The service corresponds to uploading meter reading document results in the back-end (BAPI_MTRREADDOC_UPLOAD).
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 39 of 130
Features When this service is executed, the result for a Meter Reading Document IDs is created. The following values must be provided: MeterReadingDocumentID MeterReadingResultValue If the operation is successful, the response contains a message in the log. The BusinessDocumentProcessingResultCode is defined accordingly. The Meter Reading Document ID is always returned.
Error Handling Typical errors are: General mapping error: MeterReadingDocumentID (Int. MR doc. ID) is initial.
Message Types MeterReadingDocumentERPResultCreateConfirmation_sync MeterReadingDocumentERPResultCreateRequest_sync
Prerequisites To use this service operation, the Utilities (IS-U) application component should be implemented.
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated.
Configuration This operation is suitable for the Utilities Industry Solutions sector. To use this operation, customers must run the IS-U application component. Note that users should have the correct authorization to create a Meter Reading Document Result.
Constraints The ISU_SE_MRDRESULTCRTRC Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot: ISU_SPOT_SE_MRD. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
1.13.3.3.1.4 Create Meter Reading Document With Reference To Utilities Device To create new meter reading documents for a utilities device.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
MeterReadingDocumentERPWithReferenceToUtilitiesDeviceCreateRequestConfir mation_In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Web Service Definition (Back End)
ISU_MRDOCCRT001RC
Category
A2X
Direction
inbound
Mode
synchronous
Idempotency
yes
Change/Update Behavior
not applicable
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 40 of 130
P2P Communication Enabled
true
Business Context and Use The Create Meter Reading Document With Reference To Utilities Device operation is used to create a Meter Reading Document for a utilities device. It is only possible to create all meter reading documents for all registers in a utilities device. Note that each register corresponds to a Utilities Measurement Task.
Features The following values must be provided: Utilities Device ID MeterReadingReasonCode ScheduledMeterReadingDate If the operation is successful, the response contains a list of the IDs of the meter reading documents created with the corresponding utilities device register ID and meter reading category code. The BusinessDocumentProcessingResultCode is defined accordingly.
Error Handling Typical errors are: General mapping error: UtilitiesDeviceID (Equipment) is initial; MeterReadingReasonCode (MR reason) is initial; MeterReadingReasonCode (MR reason) is initial.
Message Types MeterReadingDocumentERPWithReferenceToUtilitiesDeviceCreateConfirmation_sync MeterReadingDocumentERPWithReferenceToUtilitiesDeviceCreateRequest_sync
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated.
Configuration This operation is suitable for the Utilities Industry Solutions sector. Customers must run the IS-U application component to use it. Note that users should have unrestricted authorization to create meter reading document and have authorization for activity ‘13’ (Create Order) for authorization object E_MR_DOC, E_MR_DOC1, E_MR_DOC2.
Enhancements The ISU_SE_MRDOCCRT001RC Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot: ISU_SPOT_SE_MRD. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
1.13.3.3.1.5 Read Meter Reading Document Basic Data To read the basic data for a meter reading document.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
MeterReadingDocumentERPBasicDataByIDQueryResponse_In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Web Service Definition (Back End)
ISU_MRDOCBDIDQR
Category
A2X
Direction
inbound
Mode
synchronous
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 41 of 130
Idempotency
no
Change/Update Behavior
not applicable
P2P Communication Enabled
true
Business Context and Use The Read Meter Reading Document Basic Data service operation is used to read the basic data of a Meter Reading Document, in particular (scheduled) meter reading dates, the reason for the meter reading, and the meter reading result (if it is already maintained for the Meter Reading Document. Note: The reason for the meter reading is only returned if it is unambiguous. The entire result node is omitted if there is no meter reading maintained for this document.
Features When this service is executed, the basic data of a Meter Reading Document is returned. You have to provide the MeterReadingDocumentID.
Error Handling Typical errors are: No objects correspond to the selection criteria General mapping error, MeterReadingDOcumentID (Int. MR doc. ID) is initial
Message Types MeterReadingDocumentERPBasicDataByIDQuery_sync MeterReadingDocumentERPBasicDataByIDResponse_sync
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated.
Configuration This operation is suitable for the Utilities Industry Solutions sector. It is necessary that the customer runs the IS-U application component in order to use it. Note that users should have the proper authorization in order to display the Meter Reading Document. Therefore, they need the permission for activity ‘11’ (Display Order) for authorization object E_MR_DOC, E_MR_DOC1, E_MR_DOC2.
Enhancements The ISU_SE_MRDOCBDIDQR Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot: ISU_SPOT_SE_MRD. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer. In particular, you should implement this BAdI to select the most important meter reading reason code if there is more than one reason entered for a Meter Reading Document.
1.13.3.3.2 Meter Reading Document In An interface to send requests and receive confirmations for data handling with meter reading documents.
Technical Data Entity Type
Service Interface
Category
SAP A2A
Direction
inbound
Business Context and Use This inbound service interface contains service operations used to do the following: Confirm the creation and cancellation of meter reading documents in the meter data unification and synchronization (MDUS) system Check the content of discrete meter results Confirm the upload of discrete meter reading results in SAP ERP
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 42 of 130
This service can be used in asynchronous processes.
Notes on SAP Implementation For information, see Create Meter Reading Document Result.
1.13.3.3.2.1 Change Meter Reading Document Result as Bulk To change a meter reading document result as bulk.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
MeterReadingDocumentERPResultBulkChangeRequest_In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Web Service Definition (Back End)
ISU_MRDRESULTCHGBLKRQ
Category
SAP A2A
Direction
inbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
Type2
P2P Communication Enabled
yes
Business Context and Use The Change Meter Reading Document Result as Bulk inbound service operation allows you to change the meter reading results sent by the meter data unification and synchronization (MDUS) system in SAP for Utilities. The bulk service allows you to change multiple meter reading results within one enterprise service call.
Related Operations The corresponding outbound operation is Confirm Meter Reading Document Result Change as Bulk in the Measurement Processing process component.
Features This inbound service operation is used to change existing meter reading document results as part of a mass process. The service starts the BAPI_MTRREADDOC_UPLOAD BAPI, which uploads the meter reading document results to the SAP for Utilities back-end system. The following values must be provided for the bulk message: MessageHeader - UUID The following values must be provided for each single message within this inbound operation: Meter reading document ID Result - actual date and actual time of the meter reading Result - meter reading result value
Processing For information, see Bulk, Bundle, Collection.
Error Handling Typical errors include: The meter reading document ID or actual date or meter reading result value is initial. The user does not have the proper authorization to correct the meter reading results. The meter reading result has already been billed. The process cannot be carried out because it is locked by another user.
Forward Error Handling The Change Meter Reading Document Result as Bulk operation supports Forward Error Handling. The following error categories are used:
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 43 of 130
PRE.AUE : Authorization Error PRE.TEE.LRE : Lock Request Error PRE : Processing Error
Message Types Meter Reading Document ERP Result Bulk Change Request
Notes on SAP Implementation Switch Framework To use this service operation, you must activate the Utilities business function set (ISU_UTIL_1).
Configuration Users must have the appropriate authorization to correct the meter reading results in SAP for Utilities.
Enhancements The BAdI for Change Meter Reading Document Result as Bulk and Confirm Meter Reading Document Result Change as Bulk (ISU_SE_MRDRESULTCHGBLKRCI_ASYN) Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot ISU_SPOT_SE_MRD. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data.
1.13.3.3.2.3 Change Based on Smart Meter Meter Reading Document Result Creation Confirmation To receive a confirmation about the change of meter reading document results.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 605
Release State
Released
Technical Name
SmartMeterMeterReadingDocumentERPResultCreateConfirmation_In
Namespace
http://sap.com/xi/IS-U/Global
Application Component
IS-U
Category
SAP A2A
Direction
inbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
true
Business Context and Use The SmartMeterMeterReadingDocumentERPResultCreateConfirmation_In service operation is used to confirm the creation of a meter reading document result. For more information about use cases for this service operation, see the Enterprise Services Advanced Meter Infrastructure WIKI at http://wiki.scn.sap.com/wiki/display/ESpackages/Advanced+Metering+Infrastructure
, use case group 3.
Features The following graphic illustrates both the interface, the fields and cardinality of this service operation. You can use the Utilities data type catalog at http://service.sap.com/~sapidb/011000358700001049282012E ( service.sap.com/utilities SAP for Utilities SAP for Utilities - Product Information IS-U/CCS General Cookbook&Guidelines Utilities Data Type Catalog ) to search for information about specific fields.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 44 of 130
Interface, fields and cardinality of the service operation
The MeterReadingDocument should provide the following values: The MeterReadingDocumentID The confirmation message UUID The request message UUID stored in the field ReferenceUUID in the confirmation message header The log that describes the creation status for each meter reading document result in the AMI System.
Related Operations The bulk counterpart for this service operation is the SmartMeterMeterReadingDocumentERPResultBulkCreateConfirmation_In operation The outbound counterpart for this inbound operation is the SmartMeterMeterReadingDocumentERPResultCreationRequest_Out operation
Prerequisites To use this service operation, the Utilities (IS-U) application component should be implemented.
Integration This service operation belongs to the Meter Reading Document In service interface.
Notes on SAP Implementation Switch Framework The Utilities Business Function Set must be activated and you must switch on the ISU_AMI_2 business function. Configuration This operation is suitable for the Utilities Industry Solutions sector. However, it is only available to customers who are running the IS-U application component.
Note Users should have the appropriate authorization to Correct plausible and implausible meter reading results (E_MR_ACTVT: 04, 05) in SAP for Utilities.
Enhancements The Business Add-In (BAdI) ISU_SE_MRDRESSMCRTRCO_ASYN is available for this service operation. This BAdI allows you to use a customer-specific logic for the inbound/outbound mapping of application data. This BAdI is available in the enhancement spot ISU_SPOT_SE_MRD. The BAdI can be implemented several times. The implementations are sorted according to the content of the field Layer of a BAdI implementation , for example, SAP standard, partner, or customer.
Error Handling Typical general processing and/or mapping errors are:
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 45 of 130
MeterReadingDocumentID not provided Message UUID not provided For more information about monitoring your process integration, see the SAP Process Integration (PI) Handbook.
Forward Error Handling This service operation supports Forward Error Handling (FEH). The following error category is used: PRE.AUE : Authorization Error For more information about the individual error categories, see the code list for the global data type LogItemCategoryCode . Information for the Post Processing Office (PPO): This service belongs to the component CA-SOA-ESM-ERP-SCE and process MRDoc004.
ES Bundles This service operation is part of the Advanced Meter Infrastructure ES bundle. For more information about this bundle, see the Enterprise Services WIKI at https://wiki.sdn.sap.com/wiki/display/ESpackages/Advanced+Meter+Infrastructure
.
1.13.3.3.2.3 Change Based on Smart Meter Meter Reading Document Result Creation Confirmation as Bulk To receive a confirmation about the creation of meter reading document results as bulk.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 605
Release State
Released
Technical Name
SmartMeterMeterReadingDocumentERPResultBulkCreateConfirmation_In
Namespace
http://sap.com/xi/IS-U//Global
Application Component
IS-U
Category
SAP A2A
Direction
inbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
true
Business Context and Use The SmartMeterMeterReadingDocumentERPResultBulkCreateConfirmation_In inbound bulk service operation is used to confirm the creation of meter reading document results as a mass request. For more information about use cases for this service operation, see the Enterprise Services Advanced Meter Infrastructure WIKI at http://wiki.scn.sap.com/wiki/display/ESpackages/Advanced+Metering+Infrastructure
, use case group 3.
Features The following graphic illustrates both the interface, the fields and cardinality of this service operation. You can use the Utilities data type catalog at http://service.sap.com/~sapidb/011000358700001049282012E ( service.sap.com/utilities SAP for Utilities SAP for Utilities - Product Information IS-U/CCS General Cookbook&Guidelines Utilities Data Type Catalog ) to search for information about specific fields.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 46 of 130
Interface, fields and cardinality of the service operation
Every SmartMeterMeterReadingDocumentERPResultCreateConfirmationMessage should provide the following values: The MeterReadingDocumentID The (single) confirmation message UUID The request message UUID stored in the field ReferenceUUID in the confirmation message header The log that describes the creation status for each meter reading document result in the bulk message The UUID of the bulk confirmation message and the bulk request message stored in the ReferenceUUID should also be supplied.
Related Operations The single counterpart for this service operation is the SmartMeterMeterReadingDocumentERPResultCreateConfirmation_In operation The outbound counterpart for this inbound operation is the SmartMeterMeterReadingDocumentERPResultBulkCreateRequest_Out operation
Prerequisites To use this service operation, the Utilities (IS-U) application component should be implemented.
Integration This service operation belongs to the Meter Reading Document In service interface.
Notes on SAP Implementation Switch Framework The Utilities Business Function Set must be activated and you must switch on the ISU_AMI_2 business function. Configuration This operation is suitable for the Utilities Industry Solutions sector. However, it is only available to customers who are running the IS-U application component.
Note Users should have the appropriate authorization to Correct plausible and implausible meter reading results (E_MR_ACTVT: 04, 05) in SAP for Utilities.
Enhancements The Business Add-In (BAdI) ISU_SE_MRDRESSMCHGBLKRCO_ASYN is available for this service operation. This BAdI allows you to use a customer-specific logic for the inbound/outbound mapping of application data. This BAdI is available in the enhancement spot ISU_SPOT_SE_MRD. The BAdI can be implemented several times. The implementations are sorted according to the field Layer of a BAdI implementation , for example, SAP standard, partner, or customer.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 47 of 130
Error Handling Typical general processing and/or mapping errors are: MeterReadingDocumentID not provided Message UUID not provided For more information about monitoring your process integration, see the SAP Process Integration (PI) Handbook.
Forward Error Handling This service operation supports Forward Error Handling (FEH). The following error category is used: PRE.AUE : Authorization Error For more information about the individual error categories, see the code list for the global data type LogItemCategoryCode . Information for the Post Processing Office (PPO): This service belongs to the component CA-SOA-ESM-ERP-SCE and process MRDoc006.
ES Bundles This service operation is part of the Advanced Meter Infrastructure ES bundle. For more information about this bundle, see the Enterprise Services WIKI at https://wiki.sdn.sap.com/wiki/display/ESpackages/Advanced+Meter+Infrastructure
.
1.13.3.3.2.5 Change Based on Smart Meter Meter Reading Document Creation Confirmation To confirm the creation of a Meter Reading Document.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
SmartMeterMeterReadingDocumentERPCreateConfirmation_In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Web Service Definition (Back End)
ISU_MRDOCSMCRTCO
Category
SAP A2A
Direction
inbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use This inbound service operation is used to confirm the creation of a single Meter Reading Document.
Features The following values have to be provided: Meter reading document ID The confirmation message UUID The request message UUID stored in the field reference_UUID of the confirmation message header The log describing the status of the creation of meter reading document in the AMI system
Error Handling Typical errors include: General processing and mapping errors, such as MeterReadingDocumentID is initial, and Message UUID or Reference_UUID not provided. For more information about monitoring your process integration, see SAP NetWeaver Process Integration Library Administrator's Guide Technical Operations for SAP NetWeaver Administration of SAP NetWeaver Systems PI (Process Integration) Monitoring Tools for Monitoring .
Message Types PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 48 of 130
SmartMeterMeterReadingDocumentERPCreateConfirmation
Prerequisites To use this service operation, the Utilities (IS-U) application component should be implemented.
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated and the ISU_AMI_1 business function must be switched on.
Configuration This operation is suitable for the Utilities Industry Solutions sector. To use this operation, customers must run the IS-U application component to use it. Note that users should have the correct authorization to change the meter reading document in IS-U.
Enhancements The Business Add-In (BAdI) ISU_SE_MRDOCSMCRTRC is available for this operation. This BAdI definition is found in the enhancement spot: ISU_SPOT_SE_MRD.You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data.
1.13.3.3.2.5 Change Based on Smart Meter Meter Reading Document Creation Confirmation as Bulk To confirm the mass creation of meter reading documents.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 605
Release State
released
Technical Name
SmartMeterMeterReadingDocumentERPBulkCreateConfirmation_In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Web Service Definition (Back End)
ISU_MRDOCSMCRTBLKCO
Category
SAP A2A
Direction
inbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use This inbound service operation is used to confirm the creation of the Meter Reading Document in bulk.
Features Every object (meter reading document) in the bulk confirmation message should provide the following values: Meter reading document ID The (single) confirmation message UUID The request message UUID stored in the field reference_UUID in the confirmation message header The log that describes the creation status of each meter reading document in the bulk message You must also supply the UUID of the bulk confirmation message and the bulk request message stored in the reference_UUID.
Error Handling Typical errors include: General processing and mapping errors, such as Bulk Confirmation Message UUID and Reference_UUID not provided.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 49 of 130
For information about monitoring your process integration, see SAP NetWeaver Process Integration Library Administrator's Guide Technical Operations for SAP NetWeaver Administration of SAP NetWeaver Systems PI (Process Integration) Monitoring Tools for Monitoring .
Message Types SmartMeterMeterReadingDocumentERPBulkCreateConfirmation
Prerequisites To use this service operation, the Utilities (IS-U) application component should be implemented.
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated and the business function ISU_AMI_1 must be switched on.
Configuration This operation is suitable for the Utilities Industry Solutions sector. However, it can only be used by customers who are running the IS-U application component. Note: Users require the correct authorization to change the meter reading document in IS-U.
Enhancements The Business Add-In (BAdI) ISU_SE_MRDOCSMCRTBLKRCO_ASYN is available for this operation. This BAdI definition is found in the enhancement spot: ISU_SPOT_SE_MRD. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data.
1.13.3.3.2.7 Change Based on Smart Meter Meter Reading Document Result Change Confirmation To receive a confirmation about the change of a meter reading document result.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 605
Release State
Released
Technical Name
SmartMeterMeterReadingDocumentERPResultChangeConfirmation_In
Namespace
http://sap.com/xi/IS-U/Global
Application Component
IS-U
Category
SAP A2A
Direction
inbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
true
Business Context and Use The SmartMeterMeterReadingDocumentERPResultChangeConfirmation_In inbound service operation is used to confirm the change of a meter reading document result. For more information about use cases for this service operation, see the Enterprise Services Advanced Meter Infrastructure WIKI at http://wiki.scn.sap.com/wiki/display/ESpackages/Advanced+Metering+Infrastructure
, use case group 3.
Features The following graphic illustrates both the interface, the fields and cardinality of this service operation. You can use the Utilities data type catalog at http://service.sap.com/~sapidb/011000358700001049282012E ( service.sap.com/utilities SAP for Utilities SAP for Utilities - Product Information IS-U/CCS General Cookbook&Guidelines Utilities Data Type Catalog ) to search for information about specific fields..
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 50 of 130
Interface, fields and cardinality of the service operation
The MeterReadingDocument should provide the following values: The MeterReadingDocumentID The confirmation message UUID The request message UUID stored in the field ReferenceUUID in the confirmation message header The log that describes the change status for each meter reading result in the AMI System
Related Operations The outbound counterpart for this service operation is the SmartMeterMeterReadingDocumentERPResultChangeRequest_Out operation The bulk counterpart for this service operation is the SmartMeterMeterReadingDocumentERPResultBulkChangeConfirmation_In operation
Prerequisites To use this service operation, the Utilities (IS-U) application component should be implemented.
Integration This service operation belongs to the Meter Reading Document In service interface.
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated and you must switch on the ISU_AMI_2 business function. Configuration This operation is suitable for the Utilities Industry Solutions sector. However, it is only available to customers who are running the IS-U application component.
Note Users should have the appropriate authorization to Correct plausible and implausible meter reading results (E_MR_ACTVT: 04, 05) in SAP for Utilities.
Enhancements The Business Add-In (BAdI) ISU_SE_MRDRESSMCHGRCO_ASYN is available for this service operation. This BAdI allows you to use a customer-specific logic for the inbound/outbound mapping of application data. This BAdI is available in the enhancement spot ISU_SPOT_SE_MRD. The BAdI can be implemented several times. The implementations are sorted according to the field Layer of a BAdI implementation , for example, SAP standard, partner, or customer.
Error Handling
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 51 of 130
Typical general processing and/or mapping errors are: MeterReadingDocumentID not provided Message UUID not provided For more information about monitoring your process integration, see the SAP Process Integration (PI) Handbook.
Forward Error Handling This service operation supports Forward Error Handling (FEH). The following error category is used: PRE.AUE : Authorization Error For more information about the individual error categories, see the code list for the global data type LogItemCategoryCode . Information for the Post Processing Office (PPO): This service belongs to the component CA-SOA-ESM-ERP-SCE and process MRDoc005.
ES Bundles This service operation is part of the Advanced Meter Infrastructure ES bundle. For more information about this bundle, see the Enterprise Services WIKI at https://wiki.sdn.sap.com/wiki/display/ESpackages/Advanced+Meter+Infrastructure
.
1.13.3.3.2.7 Change Based on Smart Meter Meter Reading Document Result Change Confirmation as Bulk To receive a confirmation about the change of meter reading document results as bulk.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 605
Release State
Released
Technical Name
SmartMeterMeterReadingDocumentERPResultBulkChangeConfirmation_In
Namespace
http://sap.com/xi/IS-U/Global
Application Component
IS-U
Category
SAP A2A
Direction
inbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
true
Business Context and Use The SmartMeterMeterReadingDocumentERPResultBulkChangeConfirmation_In inbound bulk service operation is used to confirm the change meter reading document results as a mass request. For more information about use cases for this service operation, see the Enterprise Services Advanced Meter Infrastructure WIKI at http://wiki.scn.sap.com/wiki/display/ESpackages/Advanced+Metering+Infrastructure
, use case group 3.
Features The following graphic illustrates both the interface, the fields and cardinality of this service operation. You can use the Utilities data type catalog at http://service.sap.com/~sapidb/011000358700001049282012E ( service.sap.com/utilities SAP for Utilities SAP for Utilities - Product Information IS-U/CCS General Cookbook&Guidelines Utilities Data Type Catalog ) to search for information about specific fields.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 52 of 130
Interface, fields and cardinality of the service operation
Every SmartMeterMeterReadingDocumentERPResultCreateConfirmationMessage in the bulk request message should provide the following values: The MeterReadingDocumentID The (single) confirmation message UUID The request message UUID stored in the field ReferenceUUID in the confirmation message header The log that describes the change status for each meter reading document result in the bulk message The UUID of the bulk confirmation message and the bulk request message stored in the ReferenceUUID should also be supplied.
Related Operations The single counterpart for this service operation is the SmartMeterMeterReadingDocumentERPResultChangeConfirmation_In operation The outbound counterpart for this inbound operation is the SmartMeterMeterReadingDocumentERPResultBulkChngeRequest_Out operation
Prerequisites To use this service operation, the Utilities (IS-U) application component should be implemented.
Integration This service operation belongs to the Meter Reading Document In service interface.
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated and you must switch on the ISU_AMI_2 business function. Configuration This operation is suitable for the Utilities Industry Solutions sector. However, it is only available to customers who are running the IS-U application component.
Note Users should have the appropriate authorization to Correct plausible and implausible meter reading results (E_MR_ACTVT: 04, 05) in SAP for Utilities.
Enhancements The Business Add-In (BAdI) ISU_SE_MRDRESSMCRTRCO_ASYN is available for this service operation. This BAdI allows you to use a customer-specific logic for the inbound/outbound mapping of application data. This BAdI is available in the enhancement spot ISU_SPOT_SE_MRD. The BAdI can be implemented several times. The implementations are sorted according to the field Layer of a BAdI implementation , for example, SAP standard, partner, or customer.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 53 of 130
Error Handling Typical general processing and/or mapping errors are: MeterReadingDocumentID not provided Message UUID not provided For more information about monitoring your process integration, see the SAP Process Integration (PI) Handbook.
Forward Error Handling This service operation supports Forward Error Handling (FEH). The following error category is used: PRE.AUE : Authorization Error For more information about the individual error categories, see the code list for the global data type LogItemCategoryCode .
ES Bundles This service operation is part of the Advanced Meter Infrastructure ES bundle. For more information about this bundle, see the Enterprise Services WIKI at https://wiki.sdn.sap.com/wiki/display/ESpackages/Advanced+Meter+Infrastructure
.
1.13.3.3.2.9 Change Based on Smart Meter Meter Reading Document Cancellation Confirmation To confirm the cancellation of meter reading documents.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
SmartMeterMeterReadingDocumentERPCancellationConfirmation_In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Web Service Definition (Back End)
ISU_MRDOCSMCNCCO
Category
SAP A2A
Direction
inbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use This inbound service operation is used to confirm the cancellation of the Meter Reading Document from the Advanced Metering System (AMS) to IS-U.
Features The following values have to be provided: MessageHeader - UUID MessageHeader- ReferenceUUID MeterReadingDocument - Meter reading document ID The log that describes the status of the cancellation of meter reading document from the AMS
Error Handling General processing and mapping errors include: Missing log data, MessageHeader->UUID or MessageHeader->ReferenceUUID are not provided, and meter reading document ID is initial.
Message Types Smart Meter Meter Reading Document ERP Cancellation Confirmation
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 54 of 130
Prerequisites To use this service operation, the Utilities (IS-U) application component should be implemented.
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated and the business function ISU_AMI_1 must be switched on.
Configuration This operation is suitable for the Utilities Industry Solutions sector. However, it can only be used by customers who are running the IS-U application component. Note that users require the correct authorization to change the meter reading document in IS-U.
Enhancements The ISU_SE_MRDOCSMCNCRCO_ASYN Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot: ISU_SPOT_SE_MRD. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data.
1.13.3.3.2.9 Change Based on Smart Meter Meter Reading Document Cancellation Confirmation as Bulk To confirm the cancellation of a Meter Reading Document as a mass process.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
SmartMeterMeterReadingDocumentERPBulkCancellationConfirmation_In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Web Service Definition (Back End)
ISU_MRDOCSMCNCBLKCO
Category
SAP A2A
Direction
inbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use This inbound service operation is used to confirm the cancellation of the meter reading documents from the Advanced Metering System (AMS) to IS-U as a mass process.
Features The following values have to be provided for the bulk message: MessageHeader - UUID MessageHeader- ReferenceUUID The log that describes the cancellation status of all meter reading documents The following values have to be provided for each single message in this inbound operation: MessageHeader - UUID MessageHeader - ReferenceUUID MeterReadingDocument - Meter Reading Document ID The log that describes the cancellation status of each single meter reading document
Error Handling
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 55 of 130
General processing and mapping errors, such as: Missing log MessageHeader->UUID or MessageHeader->ReferenceUUID is not provided Meter reading document ID is initial
Message Types SmartMeterMeterReadingDocumentERPBulkCancellationConfirmation
Prerequisites To use this service operation, the Utilities (IS-U) application component should be implemented.
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated and the business function ISU_AMI_1 must be switched on.
Configuration This operation is suitable for the Utilities Industry Solutions sector. However, it can only be used by customers who are running the IS-U application component. Note that users require the correct authorization to change the meter reading document in IS-U.
Enhancements The ISU_SE_MRDOCSMCNCBLKRCO_ASYN Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot: ISU_SPOT_SE_MRD. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
1.13.3.3.2.10 Create Meter Reading Document Result To create a new meter reading document with result or new result for an existing meter reading document.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
MeterReadingDocumentERPResultCreateRequest_In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Web Service Definition (Back End)
ISU_MRDRESULTCRTRQ
Category
SAP A2A
Direction
inbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use The Create Meter Reading Document Result service operation is used to create a new result for an existing Meter Reading Document or to create a new Meter Reading Document with result. The service corresponds to the upload of meter reading results with BAPI_MTRREADDOC_UPLOAD .
Features This inbound operation processes the message type MeterReadingDocumentERPResultCreateRequest. The following values have to be provided: Result->Actual Date and time of the meter reading Result->Meter Reading Result Value
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 56 of 130
Exactly one of the identification variants for creating or finding of meter reading document: Meter Reading Document ID Utilities Measurement Task ID and Utilities Object Identification System Code Text Utilities Device ID and Utilities Object Identification System Code Text Utilities Point Of Delivery Party ID and Utilities Object Identification System Code Text
Error Handling Typical errors are: Actual time of the meter reading or meter reading result value is not provided. Actual date of the meter reading is initial. The identification variant isn’t provided or is invalid.
Forward Error Handling The Create Meter Reading Document Result operation supports Forward Error Handling (FEH), from EHP5 onwards. The following error categories are used: PRE.AUE : Authorization Error PRE : Processing Error PRE.TEE.LPE : Lock promotion error For more information about the individual error categories, see the code list for the global data type LogItemCategoryCode . To activate FEH, implement and activate BAdI ISU_SE_FEH_EXCEPTION: Set parameter XY_IS_FEH_PROCESSING in method IF_EX_ISU_SE_FEH_EXCEPTION~CHECK_FEH_USAGE to 'X' for the related service specified by the parameters X_SERV_BO_NAME ='MRDOC' and X_SERV_OPERATION = 'MRDRESULTCRTRQ' or set the filter values accordingly. Information for the Post Processing Office (PPO): This service belongs to the component CA-SOA-ESM-ERP-SCE and process MRDOC002.
Message Types Meter Reading Document ERP Result Create Request
Prerequisites To use this service operation, the application component Utilities (IS-U) should be implemented.
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated.
Configuration This operation is suitable for the Utilities Industry Solutions sector. To use this operation, customers must run the IS-U application component. Note that users should have the correct authorization to create the meter reading result in IS-U.
Enhancements The ISU_SE_MRDRESULTCRTRCI_ASYN Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot: ISU_SPOT_SE_MRD. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data.
1.13.3.3.2.11 Create Meter Reading Document Result as Bulk To create a new Meter Reading Document with results or new results for an existing Meter Reading Document as a mass process.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
MeterReadingDocumentERPResultBulkCreateRequest_In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Web Service Definition (Back End)
ISU_MRDRESULTCRTBLKRQ
Category
SAP A2A
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 57 of 130
Direction
inbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use The Create Meter Reading Document Result as Bulk inbound service operation is used to create new results for existing meter reading documents or to create a new Meter Reading Document with results as a mass process. The service triggers the uploading of Meter Reading Document results in the back-end using BAPI_MTRREADDOC_UPLOAD.
Features The following values have to be provided for the bulk message: MessageHeader - UUID The following values have to be provided for each single message within this inbound operation: Result - actual date and actual time of the meter reading Result - meter reading result value Exactly one of the identification variants for the creation or the finding of the meter reading document: Meter Reading Document ID Utilities Measurement Task ID and Utilities Object Identification System Code Text Utilities Device ID and Utilities Object Identification System Code Text Utilities Point Of Delivery Party ID and Utilities Object Identification System Code Text
Error Handling Typical errors are: Actual time of the meter reading or meter reading result value is not provided Actual date of meter reading is initial The identification variant is not provided or is invalid
Forward Error Handling As of EHP5, the Create Meter Reading Document Result as Bulk operation supports Forward Error Handling (FEH). The following error categories are used: PRE.AUE : Authorization Error PRE : Processing Error PRE.TEE.LPE : Lock promotion error For more information about the individual error categories, see the code list for the global data type LogItemCategoryCode. To activate FEH, implement and activate BAdI ISU_SE_FEH_EXCEPTION: Set parameter XY_IS_FEH_PROCESSING for method IF_EX_ISU_SE_FEH_EXCEPTION~CHECK_FEH_USAGE to 'X' for the related service specified by the parameters X_SERV_BO_NAME = 'MRDOC' and X_SERV_OPERATION = 'MRDRESULTCRTBLKRQ' or define the filter values accordingly.
Message Types Meter Reading Document ERP Result Bulk Create Request
Prerequisites To use this service operation, the Utilities (IS-U) application component should be implemented.
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated.
Configuration This operation is suitable for the Utilities Industry Solutions sector. To use this operation, customers must run the IS-U application component. Note that users should have the correct authorization to create the meter reading results in IS-U.
Enhancements The ISU_SE_MRDRESULTCRTBLKRCI_ASYN Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot:
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 58 of 130
ISU_SPOT_SE_MRD. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data.
1.13.3.3.3 Meter Reading Document Out An interface to send requests and receive confirmations for data handling with meter reading documents.
Technical Data Entity Type
Service Interface
Category
SAP A2A
Direction
outbound
Business Context and Use This outbound service interface contains service operations that are used to do the following: Create and cancel meter reading documents in the meter data unification and synchronization (MDUS) system Check the content of discrete meter results Confirm the upload of discrete meter readings in SAP ERP This service can be used in asynchronous processes.
Notes on SAP Implementation To use this service operation, activate the Utilities business function set (ISU_UTIL_1).
1.13.3.3.3.1 Notify Meter Reading Document Out Definition An interface used to send notifications for meter reading documents.
Technical Data Entity Type
Service Interface
Category
SAP A2A
Direction
outbound
Business Context and Use The Notify Meter Reading Document Out service interface groups the outbound operations that are used to send notifications for meter reading documents when devices are installed, removed, and replaced.
Integration This service interface is used in the following process component interactions: Measurement Processing - Measurement Processing (3rd party) (notify MRD, bulk) Measurement Processing - Measurement Processing (3rd party) (notify MRD, single)
Service Operations Notify of Meter Reading Document Result as Bulk
To send a notification about meter reading document result as bulk.
1.13.3.3.3.1.1 Notify of Meter Reading Document Result as Bulk To send a notification about meter reading document results as bulk.
Technical Data Entity Type
Service Operation
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 59 of 130
Software Component Version
IS-UT 607
Release State
Released
Technical Name
MeterReadingDocumentERPResultBulkNotification_Out
Namespace
http://sap.com/xi/IS-U/SE/Global
Application Component
IS-U
Category
SAP A2A
Direction
outbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
no
Business Context and Use In the context of deregulated markets, the Notify of Meter Reading Document Result as Bulk outbound service operation is used to inform an external system about the meter reading document results as a bulk. The operation contains important information about: Meter reading results Consumptions (calculated quantity) (optional) .
Features The Notify of Meter Reading Document Result as Bulk outbound operation is triggered using the mass activity transaction EDATEXEXECUTEMA when executable data exchange tasks based on the data exchange basis process EXPMRCONS exist and have the status Planned . If consumption determination is not active, the service communicates the recorded meter reading. If consumption determination is active, the service communicates the recorded meter reading and the calculated consumption. The attribute resultCalculatedQuantityCompleteTransmissionIndicator for the element Result is always set to true. If the attribute resultCalculatedQuantityCompleteTransmissionIndicator is true, the element CalculatedQuantity is transferred completely. This means that elements that are not transferred in the message are implicitly regarded by the recipient as being deleted. If the meter reading document was deleted or reset, or a meter reading result changes from plausible to implausible, the ResultDeletedIndicator is set to true. The service only communicates the MeterReadingDate and MeterReadingTime in the element Result. The following figures illustrate both the interface, the fields and cardinality of this service operation. You can use the Utilities data type catalog at http://service.sap.com/~sapidb/011000358700001049282012E ( service.sap.com/utilities SAP for Utilities SAP for Utilities - Product Information IS-U/CCS General Cookbook&Guidelines Utilities Data Type Catalog ) to search for information about specific fields.
Interface, fields and cardinality of the service operation - 1 -
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 60 of 130
Interface, fields and cardinality of the service operation - 2 -
Interface, fields and cardinality of the service operation - 3 -
Integration This service operation belongs to the Notify Meter Reading Document Out service interface.
Notes on SAP Implementation To use this service operation, you must implement the application component Utilities (IS-U) and you must activate the Utilities business function set. Note that users need authorization to perform device installation, removal and replacement in IS-U. Enhancements The Business Add-In (BAdI) ISU_SE_MRDRESULTBLKNO_ASYN is available for this operation. This BAdI definition is available in the enhancement spot ISU_SPOT_SE_MRD.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 61 of 130
You can use this BAdI to create a customer-specific logic for the outbound distribution of application data. The implementations are sorted according to the field Layer of a BAdI implementation , for example, SAP standard, partner, or customer.
Related Items Measurement Processing process component Meter Reading Document business object Meter Reading Document ERP Result Bulk Notification message type
1.13.3.3.3.2 Confirm Meter Reading Document Result Creation To confirm the creation of a new Meter Reading Document with a result or new result for an existing Meter Reading Document.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
MeterReadingDocumentERPResultCreateConfirmation_Out
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Category
SAP A2A
Direction
outbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use This outbound service operation is used to confirm the creation of a new result for an existing Meter Reading Document, or the creation of a new Meter Reading Document with a result.
Features The following values are provided: MessageHeader - UUID MessageHeader - Reference_UUID The log which describes the status of the creation of Meter Reading Document with Result
Message Types Meter Reading Document ERP Result Create Confirmation
Prerequisites To use this service operation, the Utilities (IS-U) application component should be implemented.
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated.
Configuration This operation is suitable for the Utilities Industry Solutions sector. However, it can only be used by customers who are running the IS-U application component.
Enhancements The ISU_SE_MRDRESULTCRTRCI_ASYN Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 62 of 130
ISU_SPOT_SE_MRD. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data.
1.13.3.3.3.3 Confirm Meter Reading Document Result Creation as Bulk To confirm the creation of new meter reading documents with results, or the creation of new results for existing meter reading documents as a mass process.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
MeterReadingDocumentERPResultBulkCreateConfirmation_Out
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Category
SAP A2A
Direction
outbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use This outbound service operation is used to confirm the creation of new results for existing or of new meter reading documents with results as a mass process.
Features The following values are provided for the bulk message: MessageHeader - UUID MessageHeader- ReferenceUUID The log describing the status of the creation of all Meter Reading Documents with Results The following values will be provided for each single message in this outbound operation: MessageHeader - UUID MessageHeader - ReferenceUUID The log describing the status of the creation of each single Meter Reading Document Result
Message Types Meter Reading Document ERP Result Bulk Create Confirmation
Prerequisites To use this service operation, the Utilities (IS-U) application component should be implemented.
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated.
Configuration This operation is suitable for the Utilities Industry Solutions sector. However, it can only be used by customers who are running the IS-U application component.
Enhancements The ISU_SE_MRDRESULTCRTBLKRCI_ASYN Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot: ISU_SPOT_SE_MRD. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data.
1.13.3.3.3.4 Confirm Meter Reading Document Result Change as
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 63 of 130
1.13.3.3.3.4 Confirm Meter Reading Document Result Change as Bulk To send a confirmation about the change of a meter reading document result as bulk.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
MeterReadingDocumentERPResultBulkChangeConfirmation_Out
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Category
SAP A2A
Direction
outbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use The Confirm Meter Reading Document Result Change as Bulk outbound service operation allows you to send a confirmation when the SAP for Utilities System successfully receives the meter reading results from the meter data unification and synchronization (MDUS) system. The bulk service allows multiple meter reading results to be handled in one enterprise service call.
Related Operations The corresponding inbound operation is Change Meter Reading Document Result as Bulk in the Measurement Processing process component.
Features This outbound service operation is used to confirm the change of the existing meter reading document results as a mass process. The following values are provided for the bulk message: MessageHeader - UUID MessageHeader- ReferenceUUID The log describing the status of the change for all of the meter reading document results The following values are provided for each single message in this outbound operation: MessageHeader - UUID MessageHeader - ReferenceUUID Meter reading document ID The log describing the status of the change for each meter reading document result
Processing For information, see Bulk, Bundle, Collection.
Message Types Meter Reading Document ERP Result Bulk Change Confirmation
Notes on SAP Implementation Switch Framework To use this service operation, you must activate the Utilities business function set.
Enhancements The BAdI for Change Meter Reading Document Result as Bulk and Confirm Meter Reading Document Result Change as Bulk (ISU_SE_MRDRESULTCHGBLKRCI_ASYN) Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot ISU_SPOT_SE_MRD.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 64 of 130
You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
1.13.3.3.3.5 Request Smart Meter Meter Reading Document Creation To request the creation of a meter reading document.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
SmartMeterMeterReadingDocumentERPCreateRequest_Out
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Category
SAP A2A
Direction
outbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use This outbound service operation is used to send a meter reading request. Once a meter reading order has been created in the IS-U backend system, an outbound request message will be sent to request the creation of a single meter reading document in the AMI system.
Features The following values have to be provided: MeterReadingDocumentID MeterReadingReasonCode ScheduledMeterReadingDate UtilitiesMeasurementTaskID UtilitiesDeviceID UtilitiesAdvancedMeteringSystemID UtilitiesPointOfDeliveryPartyID
Error Handling Typical errors include: General processing and mapping errors: MeterReadingDocumentID (Int. MR doc. ID) is initial; Message UUID not provided. To get information on monitoring your process integration, see SAP NetWeaver Process Integration Library Administrator's Guide Technical Operations for SAP NetWeaver Administration of SAP NetWeaver Systems PI (Process Integration) Monitoring Tools for Monitoring
Message Types Smart Meter Meter Reading Document ERP Create Request
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated. Furthermore, the ISU_AMI_1 business function must be switched on.
Configuration This operation is suitable for the Utilities Industry Solutions sector. The customer must run the IS-U application component to use it.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 65 of 130
Enhancements The Business Add-In (BAdI) ISU_SE_MRDOCSMCRTRCO_ASYN is available for this operation. This BAdI definition is found in the enhancement spot: ISU_SPOT_SE_MRD. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data.
1.13.3.3.3.6 Request Smart Meter Meter Reading Document Creation as Bulk To request the mass creation of meter reading documents.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
SmartMeterMeterReadingDocumentERPBulkCreateRequest_Out
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Category
SAP A2A
Direction
outbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use This outbound service operation requests the mass creation of meter reading documents. In SAP for Utilities, meter reading documents can be created as a mass process. This process triggers an outbound bulk message processing, which is sent to request the creation of these meter reading documents in the advanced metering infrastructure (AMI) system.
Features In the bulk request message, each object (meter reading document) should provide the following values: MeterReadingDocumentID MeterReadingReasonCode ScheduledMeterReadingDate UtilitiesMeasurementTaskID UtilitiesDeviceID UtilitiesAdvancedMeteringSystemID UtilitiesPointOfDeliveryPartyID The UUID of the (single) request message Furthermore, the UUID of the bulk request message header should also be supplied.
Error Handling Typical errors include: General processing and mapping errors like MeterReadingDocumentID (Int. MR doc. ID) is initial; Message request UUID not provided, and so on. For more information on monitoring your process integration, see SAP NetWeaver Process Integration Library Administrator's Guide Technical Operations for SAP NetWeaver Administration of SAP NetWeaver Systems PI (Process Integration) Monitoring Tools for Monitoring .
Message Types SmartMeterMeterReadingDocumentERPBulkCreateRequest
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated. Furthermore, the business function ISU_AMI_1 must be switched on.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 66 of 130
Configuration This operation is suitable for the Utilities Industry Solutions sector. It is necessary that the customer runs the IS-U application component in order to use it.
Enhancements The Business Add-In (BAdI) ISU_SE_MRDOCSMCRTBLKRCO_ASYN is available for this operation. This BAdI definition is found in the enhancement spot: ISU_SPOT_SE_MRD. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data.
1.13.3.3.3.7 Request Smart Meter Meter Reading Document Cancellation To send a cancellation of a meter reading document.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 605
Release State
released
Technical Name
SmartMeterMeterReadingDocumentERPCancellationRequest_Out
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Category
SAP A2A
Direction
outbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use This outbound service operation is used to send a cancellation of a meter reading document from IS-U to the Advanced Metering System (AMS).
Features The following values are provided: MessageHeader-UUID Meter Reading Document ID UtilitiesDeviceSmartMeter- Utilities Advanced Metering System ID
Message Types Smart Meter Meter Reading Document ERP Cancellation Request
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated. Furthermore, the business function ISU_AMI_1 must be switched on.
Configuration This operation is suitable for the Utilities Industry Solutions sector. The customer must run the IS-U application component to use it. Users require the proper authorization to cancel the meter reading documents in IS-U.
Enhancements The ISU_SE_MRDOCSMCNCRCO_ASYN Business Add-In (BAdI) is available for this operation. This BAdI definition is found in enhancement spot: ISU_SPOT_SE_MRD. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data.
1.13.3.3.3.8 Request Smart Meter Meter Reading Document PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 67 of 130
1.13.3.3.3.8 Request Smart Meter Meter Reading Document Cancellation as Bulk The service is used to confirm the mass cancellation of Meter Reading Documents.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 605
Release State
released
Technical Name
SmartMeterMeterReadingDocumentERPBulkCancellationRequest_Out
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Category
SAP A2A
Direction
outbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use The Request Smart Meter Meter Reading Document Cancellation as Bulk service operation is used to confirm the cancellation of Meter Reading Documents in bulk.
Features The following values will be provided for the bulk message: MessageHeader - UUID The following values will be provided for each single message inside this outbound operation : MessageHeader - UUID Meter Reading Document ID UtilitiesDeviceSmartMeter - Utilities Advanced Metering System ID
Message Types Smart Meter Meter Reading Document ERP Bulk Cancellation Request
Prerequisites To use this service operation, the application component Utilities (IS-U) should be implemented.
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated. Furthermore, the Business Function ISU_AMI_1 must be switched on.
Configuration This operation is suitable for the Utilities Industry Solutions sector. It is necessary that the customer runs the IS-U application component in order to use it. Note that users should have the proper authorization in order to cancel the meter reading documents in IS-U.
Enhancements The ISU_SE_MRDOCSMCNCRCO_ASYN Business Add-In (BAdI) is available for this operation. This BAdI definition is found in enhancement spot: ISU_SPOT_SE_MRD. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data.
1.13.3.3.3.9 Request Smart Meter Meter Reading Document PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 68 of 130
1.13.3.3.3.9 Request Smart Meter Meter Reading Document Result Creation To request the creation of a meter reading document result.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 605
Release State
Released
Technical Name
SmartMeterMeterReadingDocumentERPResultCreateRequest_Out
Namespace
http://sap.com/xi/IS-U/Global
Application Component
IS-U
Category
SAP A2A
Direction
outbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
true
Business Context and Use The SmartMeterMeterReadingDocumentERPResultCreateRequest_Out outbound service operation is used to send a request to create a meter reading document result. For more information about use cases for this service operation, see the Enterprise Services Advanced Meter Infrastructure WIKI at https://wiki.sdn.sap.com/wiki/display/ESpackages/Advanced+Meter+Infrastructure
, use case group 3.
Note The service operation is not called automatically; you must implement the BAdI ISU_AMI_SEND_MR. For more information about the implementation and when it is called, see the BAdI documentation. This BAdI is available in the enhancement spot ISU_AMI_SEND_MR.
Features The following graphic illustrates both the interface, the fields, and cardinality of this service operation. You can use the SAP Global Data Types Catalog (GDT catalog) to search for information about specific fields.
Interface, fields and cardinality of the service operation
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 69 of 130
The MeterReadingDocument should provide the following values: MeterReadingDocumentID MeterReadingReasonCode UtilitiesMeasurementTaskID UtilitiesDeviceID UtilitiesAdvancedMeteringSystemID MeterReadingDate MeterReadingTime ActualMeterReadingDate (optinal) ActualMeterReadingTime (optional) MeterReadingTypeCode MeterReadingResultValue The UUID of the request message should also be supplied.
Related Operations The bulk counterpart for this service operation is the SmartMeterMeterReadingDocumentERPResultBulkCreateRequest_Out operation The inbound counterpart for this outbound operation is the SmartMeterMeterReadingDocumentERPResultCreateConfirmation_In operation
Prerequisites To use this service operation, the Utilities (IS-U) application component should be implemented.
Integration This service operation belongs to the Meter Reading Document Out service interface.
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated and you must switch on the ISU_AMI_2 business function. Configuration This operation is suitable for the Utilities Industry Solutions sector. However, it is only available to customers who are running the IS-U application component. Enhancements The Business Add-In (BAdI) ISU_SE_MRDRESSMCRTRCO_ASYN is available for this service operation. This BAdI allows you to use a customer-specific logic for the inbound/outbound mapping of application data. This BAdI is available in the enhancement spot ISU_SPOT_SE_MRD. The BAdI can be implemented several times. The implementations are sorted according to the field Layer of a BAdI implementation , for example, SAP standard, partner, or customer.
Error Handling Typical general processing and/or mapping errors are: MeterReadingDocumentID not provided Message UUID not provided For more information about monitoring your process integration, see the SAP Process Integration (PI) Handbook.
ES Bundles This service operation is part of the Advanced Meter Infrastructure ES bundle. For more information about this bundle, see the Enterprise Services WIKI at https://wiki.sdn.sap.com/wiki/display/ESpackages/Advanced+Meter+Infrastructure
.
1.13.3.3.3.10 Request Smart Meter Meter Reading Document Result Creation as Bulk To request the creation of a meter reading document results as bulk.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 605
Release State
Released
Technical Name
SmartMeterMeterReadingDocumentERPResultBulkCreateRequest_Out
Namespace
http://sap.com/xi/IS-U/Global
Application Component
IS-U
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 70 of 130
Category
SAP A2A
Direction
outbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
true
Business Context and Use The SmartMeterMeterReadingDocumentERPResultBulkCreateRequest_Out outbound bulk service operation is used to send a mass request to create meter reading document results. For more information about use cases for this service operation, see the Enterprise Services Advanced Meter Infrastructure WIKI at https://wiki.sdn.sap.com/wiki/display/ESpackages/Advanced+Meter+Infrastructure
, use case group 3.
Note The service operation is not called automatically; you must implement the BAdI ISU_AMI_SEND_MR. For more information about the implementation and when it is called, see the BAdI documentation. This BAdI is available in the enhancement spot ISU_AMI_SEND_MR.
Features The following graphic illustrates both the interface, the fields, and cardinality of this service operation. You can use the Utilities data type catalog at http://service.sap.com/~sapidb/011000358700001049282012E ( service.sap.com/utilities SAP for Utilities SAP for Utilities - Product Information IS-U/CCS General Cookbook&Guidelines Utilities Data Type Catalog ) to search for information about specific fields.
Interface, fields and cardinality of the service operation
Every SmartMeterMeterReadingDocumentERPResultCreateRequestMessage should provide the following values: MeterReadingDocumentID MeterReadingReasonCode UtilitiesMeasurementTaskID UtilitiesDeviceID UtilitiesAdvancedMeteringSystemID MeterReadingDate MeterReadingTime ActualMeterReadingDate (optional) ActualMeterReadingTime (optional) MeterReadingTypeCode MeterReadingResultValue The UUID of the bulk request message should also be supplied.
Related Operations The single counterpart for this service operation is the SmartMeterMeterReadingDocumentERPResultCreateRequest_Out operation
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 71 of 130
The inbound counterpart for this outbound operation is the SmartMeterMeterReadingDocumentERPResultBulkCreateConfirmation_In operation
Prerequisites To use this service operation, the Utilities (IS-U) application component should be implemented.
Integration This service operation belongs to the Meter Reading Document Out service interface.
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated and you must switch on the ISU_AMI_2 business function. Configuration This operation is suitable for the Utilities Industry Solutions sector. However, it is only available to customers who are running the IS-U application component. Enhancements The Business Add-In (BAdI) ISU_SE_MRDRESSMCRTBLKRCO_ASYN is available for this service operation. This BAdI allows you to use a customerspecific logic for the inbound/outbound mapping of application data. This BAdI is available in the enhancement spot ISU_SPOT_SE_MRD. The BAdI can be implemented several times. The implementations are sorted according to the field Layer of a BAdI implementation , for example, SAP standard, partner, or customer.
Error Handling Typical general processing and/or mapping errors are: MeterReadingDocumentID not provided Message UUID not provided For more information about monitoring your process integration, see the SAP Process Integration (PI) Handbook.
ES Bundles This service operation is part of the Advanced Meter Infrastructure ES bundle. For more information about this bundle, see the Enterprise Services WIKI at https://wiki.sdn.sap.com/wiki/display/ESpackages/Advanced+Meter+Infrastructure
.
1.13.3.3.3.11 Request Smart Meter Meter Reading Document Result Change To request the change of a meter reading document result.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 605
Release State
Released
Technical Name
SmartMeterMeterReadingDocumentERPResultChangeRequest_Out
Namespace
http://sap.com/xi/IS-U/Global
Application Component
IS-U
Category
SAP A2A
Direction
outbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
true
Business Context and Use The SmartMeterMeterReadingDocumentERPResultChangeRequest_Out outbound service operation is used to send a request to change a meter reading document result. For more information about use cases for this service operation, see the Enterprise Services Advanced Meter Infrastructure WIKI at https://wiki.sdn.sap.com/wiki/display/ESpackages/Advanced+Meter+Infrastructure
, use case group 3.
Note The service operation is not triggered automatically; you must implement the BAdI ISU_AMI_SEND_MR. For more information about the implementation
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 72 of 130
and when it is called, see the BAdI documentation. This BAdI is available in the enhancement spot ISU_AMI_SEND_MR.
Features The following graphic illustrates both the interface, the fields and cardinality of this service operation. You can use the Utilities data type catalog at http://service.sap.com/~sapidb/011000358700001049282012E ( service.sap.com/utilities SAP for Utilities SAP for Utilities - Product Information IS-U/CCS General Cookbook&Guidelines Utilities Data Type Catalog ) to search for information about specific fields.
Interface, fields and cardinality of the service operation
The MeterReadingDocument should provide the following values: MeterReadingDocumentID UtilitiesAdvancedMeteringSystemID MeterReadingDate MeterReadingTime ActualMeterReadingDate (optional) ActualMeterReadingTime (optional) MeterReadingTypeCode MeterReadingResultValue The UUID of the request message should also be supplied.
Related Operations The bulk counterpart for this service operation is the SmartMeterMeterReadingDocumentERPResultBulkChangeRequest_Out operation The inbound counterpart for this outbound operation is the SmartMeterMeterReadingDocumentERPResultChangeConfirmation_In operation
Prerequisites To use this service operation, the Utilities (IS-U) application component should be implemented.
Integration This service operation belongs to the Meter Reading Document Out service interface.
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated and you must switch on the ISU_AMI_2 business function. Configuration This operation is suitable for the Utilities Industry Solutions sector. However, it is only available to customers who are running the IS-U application component.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 73 of 130
Enhancements The Business Add-In (BAdI) ISU_SE_MRDRESSMCHGRCO_ASYN is available for this service operation. This BAdI allows you to use a customer-specific logic for the inbound/outbound mapping of application data. This BAdI is available in the enhancement spot ISU_SPOT_SE_MRD. The BAdI can be implemented several times. The implementations are sorted according to the content of the field Layer of a BAdI implementation , for example, SAP standard, partner, or customer.
Error Handling Typical general processing and/or mapping errors are: MeterReadingDocumentID not provided Message UUID not provided For more information about monitoring your process integration, see the SAP Process Integration (PI) Handbook.
ES Bundles This service operation is part of the Advanced Meter Infrastructure ES bundle. For more information about this bundle, see the Enterprise Services WIKI at https://wiki.sdn.sap.com/wiki/display/ESpackages/Advanced+Meter+Infrastructure
.
1.13.3.3.3.12 Request Smart Meter Meter Reading Document Result Change as Bulk To request the change of meter reading document results as bulk.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 605
Release State
Released
Technical Name
SmartMeterMeterReadingDocumentERPResultBulkChangeRequest_Out
Namespace
http://sap.com/xi/IS-U/Global
Application Component
IS-U
Category
SAP A2A
Direction
outbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
true
Business Context and Use The SmartMeterMeterReadingDocumentERPResultBulkChangeRequest_Out outbound bulk service operation is used to send a mass request to change meter reading document results. For more information about use cases for this service operation, see the enterprise service Advanced Meter Infrastructure WIKI at https://wiki.sdn.sap.com/wiki/display/ESpackages/Advanced+Meter+Infrastructure
, use case group 3.
Note The service operation is not called automatically; you must implement the BAdI ISU_AMI_SEND_MR. For information about the implementation and when it is called, see the BAdI documentation. This BAdI is available in the enhancement spot ISU_AMI_SEND_MR.
Features The following graphic illustrates both the interface, the fields and cardinality of this service operation. You can use the Utilities data type catalog at http://service.sap.com/~sapidb/011000358700001049282012E ( service.sap.com/utilities SAP for Utilities SAP for Utilities - Product Information IS-U/CCS General Cookbook&Guidelines Utilities Data Type Catalog ) to search for information about specific fields.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 74 of 130
Interface, fields and cardinality of the service operation
Every SmartMeterMeterReadingDocumentERPResultChangeRequestMessage should provide the following values: MeterReadingDocumentID UtilitiesAdvancedMeteringSystemID MeterReadingDate MeterReadingTime ActualMeterReadingDate (optional) ActualMeterReadingTime (optional) MeterReadingTypeCode MeterReadingResultValue The UUID of the bulk request message should also be supplied.
Related Operations The single counterpart for this service operation is the SmartMeterMeterReadingDocumentERPResultChangeRequest_Out operation The inbound counterpart for this outbound operation is the SmartMeterMeterReadingDocumentERPResultBulkChangeConfirmation_In operation
Prerequisites To use this service operation, the Utilities (IS-U) application component should be implemented.
Integration This service operation belongs to the Meter Reading Document Out service interface.
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated and you must switch on the ISU_AMI_2 business function. Configuration This operation is suitable for the Utilities Industry Solutions sector. However, it is only available to customers who are running the IS-U application component. Enhancements The Business Add-In (BAdI) ISU_SE_MRDRESSMCHGBLKRCO_ASYN is available for this service operation. This BAdI allows you to use a customerspecific logic for the inbound/outbound mapping of application data. This BAdI is available in the enhancement spot ISU_SPOT_SE_MRD. The BAdI can be implemented several times. The implementations are sorted according to the field Layer of a BAdI implementation , for example, SAP standard, partner, or customer.
Error Handling
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 75 of 130
Typical general processing and/or mapping errors are: MeterReadingDocumentID not providedl Message UUID not provided For more information about monitoring your process integration, see the SAP Process Integration (PI) Handbook.
ES Bundles This service operation is part of the Advanced Meter Infrastructure ES bundle. For more information about this bundle, see the Enterprise Services WIKI at https://wiki.sdn.sap.com/wiki/display/ESpackages/Advanced+Meter+Infrastructure
.
1.13.3.3.4 Query Meter Reading Document In An interface to find meter reading documents and corresponding meter readings.
Technical Data Entity Type
Service Interface
Category
A2X
Direction
inbound
Business Context and Use The service interface Query Meter Reading Document In contains the inbound query operations for the business object Meter Reading Document . This service is used to find meter reading documents and their corresponding discrete meter readings with the help of known device IDs. For example, this service can be consumed within self-service or portal applications. This service is designed for synchronous communication.
1.13.3.3.4.1 Find Meter Reading Document Result by Utilities Device To find meter reading document results for a utilities device, as well as additional selection criteria.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
MeterReadingDocumentERPResultByUtilitiesDeviceQueryResponse_In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Web Service Definition (Back End)
ISU_MRDOC002QR
Category
A2X
Direction
inbound
Mode
synchronous
Idempotency
no
Change/Update Behavior
not applicable
P2P Communication Enabled
true
Business Context and Use This inbound operation performs a query for all meter reading documents with results assigned to a Utilities device.
Features When this service is executed, a list of Meter Reading Document IDs is retrieved. The following values must be provided: Utilities Device ID Optionally, you can restrict the query by providing additional parameters.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 76 of 130
Error Handling Typical errors are: No objects correspond to the selection criteria General mapping error; UtilitiesDeviceID (Equipment) is initial
Message Types MeterReadingDocumentERPResultByUtilitiesDeviceQuery_sync MeterReadingDocumentERPResultByUtilitiesDeviceResponse_sync
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated.
Configuration This operation is suitable for the Utilities Industry Solutions sector. It is necessary that the customer runs the IS-U application component in order to use it. Note that users should have the proper authorization to display the Meter Reading Document, that is, permission for activity ‘11’ (Display Order) for authorization objects E_MR_DOC, E_MR_DOC1, E_MR_DOC2.
Enhancements The ISU_SE_MRDOC002QR Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot: ISU_SPOT_SE_MRD. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer. You should implement this BAdI to select the most important MeterReadingReasonCode if more than one reason is maintained for a Meter Reading Document.
1.13.3.3.4.2 Find Meter Reading Document by Utilities Device To find meter reading documents for a utilities device, as well as additional selection criteria such as the status, reason, or date.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
MeterReadingDocumentERPSimpleByUtilitiesDeviceQueryResponse_In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Web Service Definition (Back End)
ISU_MRDOC001QR
Category
A2X
Direction
inbound
Mode
synchronous
Idempotency
no
Change/Update Behavior
not applicable
P2P Communication Enabled
true
Business Context and Use This inbound operation performs a query for all meter reading documents assigned to a Utilities device.
Features When this service is executed, a list of meter reading documents IDs is retrieved. The following values must be provided: Utilities Device ID Optionally, you can restrict the query by providing additional parameters.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 77 of 130
Error Handling Typical errors are: No objects correspond to the selection criteria General mapping error; UtilitiesDeviceID (Equipment) is initial
Message Types MeterReadingDocumentERPSimpleByUtilitiesDeviceQuery_sync MeterReadingDocumentERPSimpleByUtilitiesDeviceResponse_sync
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated.
Configuration This operation is suitable for the Utilities Industry Solutions sector. It is necessary that the customer runs the IS-U application component in order to use it. Note: Users should have the proper authorization to display the meter reading document, that is, permission for activity #11 (Display Order) for authorization objects E_MR_DOC, E_MR_DOC1, E_MR_DOC2.
Enhancements The ISU_SE_MRDOC001QR Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot: ISU_SPOT_SE_MRD. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer. You should implement this BAdI to select the most important MeterReadingReasonCode if multiple reasons are maintained for a meter reading document.
1.13.3.4 Utilities Measurement Task A Utilities Measurement Task is a task used to provide measurements with time-dependent specifications in the Utilities sector, for example, consumption, energy, volume, power, and so on.
Technical Data Entity Type
Business Object
Software Component Version
ESM ERP 606
Technical Name
UtilitiesMeasurementTask
Object Category
Master Data Object
Business Context and Use A Utilities Measurement Task can be performed by a physical register within a device such as a meter and can be described by an OBIS code.
Notes on SAP Implementation All service interfaces of this business object can only be used if the Utilities business function set is activated.
1.13.3.4.1 Manage Utilities Measurement Task In An interface to read measurement task data.
Technical Data Entity Type
Service Interface
Category
A2X
Direction
inbound
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 78 of 130
Business Context and Use The service interface Manage Utilities Measurement Task In contains the inbound operations (A2X) for the business object Utilities Measurement Task . This service allows reading measurement task data, such as the time-of-use information of a specific register. For example, the service can be used in customer self-service processes to provide the correct register structure and number of registers.
1.13.3.4.1.1 Read Utilities Measurement Task Basic Data To read basic data for a utilities measurement task.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
UtilitiesMeasurementTaskERPBasicDataByIDQueryResponse_In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Web Service Definition (Back End)
ISU_MeasurementTaskIDQR
Category
A2X
Direction
inbound
Mode
synchronous
Idempotency
no
Change/Update Behavior
not applicable
P2P Communication Enabled
true
Business Context and Use This inbound operation returns Utilities Measurement Task basic data for a Utilities Measurement Task ID.
Features When this operation is executed, the basic Utilities Measurement Task data, related to the provided Utilities Measurement Task ID, is returned. A Utilities Measurement Task ID is mandatory. If you do not provide one, you will receive an error message and no results will be returned.
Error Handling If you do not enter a Utilities Measurement Task ID, you will receive an error message. No Utilities Measurement Task basic data will be found if you enter an invalid Utilities Measurement Task ID. Note that users should have the proper authorization in order to display Utilities Measurement Task basic data.
Message Types UtilitiesMeasurementTaskERPBasicDataByIDQuery_sync UtilitiesMeasurementTaskERPBasicDataByIDResponse_sync
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated.
Configuration This operation is suitable for the Utilities Industry Solutions sector. It is necessary that the customer runs the IS-U application component in order to use it. Note that users should have the proper authorization in order to display the contracts (authorization object E_LOG_REG).
Enhancements The ISU_SE_MEASTASKIDQR Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot: ISU_SPOT_SE_MEASTASK. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 79 of 130
1.13.3.4.2 Notify Utilities Measurement Task Out An interface to send notifications for utilities measurement task.
Technical Data Entity Type
Service Interface
Category
SAP A2A
Direction
outbound
Business Context and Use The service interface Notify Utilities Measurement Task Out contains the outbound operation (SAP A2A for the business object Utilities Measurement Task. It is used to inform the meter data unification and synchronization system (MDUS) about a point of delivery that is assigned to a specific measurement task. The point of delivery is a unique identifier in liberalized energy markets for specific end-user customers. It can therefore be used in the MDUS for identifying processes as well.
1.13.3.4.2.1 Notify of Smart Meter Measurement Task Point Of Delivery Assigned as Bulk To send a notification about the assignment of a point of delivery to a measurement task as bulk.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
Released
Technical Name
SmartMeterUtilitiesMeasurementTaskERPPointOfDeliveryBulkAssignedNotification _Out
Namespace
http://sap.com/xi/IS-U/Global2
Category
SAP A2A
Direction
outbound
Mode
asynchronous
Idempotency
no
P2P Communication Enabled
no
Business Context and Use The Notify of Smart Meter Measurement Task Point Of Delivery Assigned as Bulk outbound bulk service operation can be used to send a bulk of old and new external Point of Delivery IDs (PoD IDs). This service should only be used if the old external PoD ID was already filled and therefore does not contain an initial value. As soon as the device is installed for billing, the PoD is available in SAP for Utilities in the context of where the device was installed. Since the PoD is sometimes used to send out meter reading requests and receive meter reading results in return, a notification containing the PoDs external ID is sent from ISU to the AMI System via XI. The services are triggered when data is changed at register level and when multiple registers exist for a specific device: Full Installation (EG31) Full Meter Removal (EG32) Billing-Related Installation (EG34) Full Meter Replacement (EG30) Device Modification (EG42) (change interval length for an installed smart meter) Billing-Related Removal (EG35)
Features When changing the external ID of the PoD, the information about the new ID of the PoD has to be distributed to the AMI system. Therefore, you require a notification that contains both the old and the new external ID of the PoD. The following elements in the bulk request message are mandatory for every object: Utilities Measurement Task ID @UtilitiesPoint of DeliveryAssignmentListCompleteTransmissionIndicator
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 80 of 130
StartDate StartTime EndDate EndTime UtilitiesPointOfDeliveryPartyID UtilitiesDeviceID UtilitiesAdvancedMeteringSystemID When the element @UtilitiesPointOfDeliveryAssignmentListCompleteTransmissionIndicator is selected: If the node UtilitiesPointOfDeliveryAssignment is not part of the message, all entries for Utilities Point Of Delivery Assignments in the AMI System are deleted. If the node UtilitiesPointOfDeliveryAssignment is part of the message, all entries for Utilities Point Of Delivery Assignments in the message are changed in the AMI System and the other entries which are not part of the message are deleted. When the element @UtilitiesPointOfDeliveryAssignmentListCompleteTransmissionIndicator is not selected: If the node UtilitiesPointOfDeliveryAssignment is not part of the message, no entries for Utilities Point Of Delivery Assignments are changed in the AMI System. If the node UtilitiesPointOfDeliveryAssignment is part of the message, all entries for Utilities Point Of Delivery Assignments in the message are changed in the AMI System. If you do not provide one or more of the mandatory elements, the system displays an error message and no information is sent to the AMI System.
Error Handling If you do not enter one of the mandatory elements mentioned under Features , the system displays an error message.
Prerequisites To use this service operation, the Utilities (IS-U) application component should be implemented.
Notes on SAP Implementation Switch Framework To use this service operation, activate the Utilities business function set (ISU_UTIL_1). Configuration This operation is suitable for the Utilities Industry Solutions sector. However, it is only available to customers who are running the IS-U application component. Enhancements The Business Add-In (BAdI) ISU_SE_MTSMPODBLKNOO_ASYN is available for this service operation. This BAdI allows you to use a customer-specific logic for the outbound mapping of application data. This BAdI is available in the enhancement spot ISU_SPOT_SE_MEASTASK. The BAdI can be implemented several times. The implementations are sorted according to the field layer of a BAdI implementation, for example SAP standard, partner, or customer.
1.13.3.4.2.2 Notify of Smart Meter Utilities Measurement Task Device Assignment To send a notification about the assignment of a device to a measurement task.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
SmartMeterUtilitiesMeasurementTaskERPDeviceAssignmentNotification_Out
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Category
SAP A2A
Direction
outbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 81 of 130
This service operation is used to inform an external system, such as a Meter Data Synchronization and Unification System (MDUS) about new or changed device allocations on register level (table EZUZ).
Message Types Smart Meter Utilities Measurement Task ERP Device Assignment Notification
Notes on SAP Implementation To use this service operation, the application component Utilities (IS-U) should be implemented, that is, the Utilities business function set must be activated.
Enhancements The ISU_SE_MEASTASKSMDEVNOO_ASYN Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot: ISU_SPOT_SE_MEASTASK. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data. The implementations are sorted according to the content of the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
1.13.3.4.2.3 Notify of Smart Meter Utilities Measurement Task Point Of Delivery Assigned To send a notification regarding the PoD external ID, from the IS-U to the AMI system.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Notes on Release State Technical Name
SmartMeterUtilitiesMeasurementTaskERPPointOfDeliveryAssignedNotification_Out
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Category
SAP A2A
Direction
outbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use This service allows the sending of old and new external PoD IDs. It should only be used if the old external PoD ID was already filled (not initial). As soon as the device is installed for billing, the PoD is known in IS-U in the context of where the device was installed. Since the PoD is sometimes used for sending out meter reading requests and receiving meter reading results in return, a notification containing the PoDs external ID is sent from IS-U to the AMI system via XI.
Features When changing the external ID of the PoD, the information regarding the new ID of the PoD has to be distributed to the AMI system. Therefore a notification containing the old and the new external ID of the PoD is needed. The following elements are mandatory: Utilities Measurement Task ID @UtilitiesPoint of DeliveryAssignmentListCompleteTransmissionIndicator StartDate StartTime EndDate EndTime UtilitiesPointOfDeliveryPartyID UtilitiesDeviceID UtilitiesAdvancedMeteringSystemID When the element @UtilitiesPointOfDeliveryAssignmentListCompleteTransmissionIndicator is set: If the node UtilitiesPointOfDeliveryAssignment is not part of the message, all entries for Utilities Point Of Delivery assignments in the AMI system will be deleted.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 82 of 130
If the node UtilitiesPointOfDeliveryAssignment is part of the message, all entries for Utilities Point Of Delivery assignments in the message will be changed in the AMI system and the other entries which are not part of the message will be deleted. When the element @UtilitiesPointOfDeliveryAssignmentListCompleteTransmissionIndicator is not set: If the node UtilitiesPointOfDeliveryAssignment is not part of the message, no entries for Utilities Point Of Delivery Assignments are changed in the AMI system. If the node UtilitiesPointOfDeliveryAssignment is part of the message, all entries for Utilities Point Of Delivery Assignments in the message will be changed in the AMI system. If you do not provide one or more of the mandatory elements, you will receive an error message and no information will be sent to the AMI system.
Error Handling If you do not enter any one of the mandatory elements mentioned above, you will receive an error.
Message Types SmartMeterUtilitiesMeasurementTaskERPPointOfDeliveryAssignedNotification
Prerequisites To use this service operation, the application component Utilities (IS-U) should be implemented.
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated.
Configuration This operation is suitable for the Utilities Industry Solutions sector. It is necessary that the customer runs the IS-U application component in order to use it.
Enhancements The Business Add-In (BAdI) ISU_SE_MEASTASKSMPODNOO_A is available for this operation. This BAdI definition is found in the enhancement spot ISU_SPOT_SE_MEASTASK. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data.
1.13.3.4.3 Query Utilities Measurement Task In An interface to find a measurement task using a point of delivery.
Technical Data Entity Type
Service Interface
Category
A2X
Direction
inbound
Business Context and Use The service interface Query Utilities Measurement Task In contains the inbound query operations for the business object Utilities Measurement Task.
1.13.3.4.3.1 Find Utilities Measurement Task by Utilities Point Of Delivery ID To find a list of utilities measurement tasks for a utilities point of delivery internal ID.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 83 of 130
Technical Name
UtilitiesMeasurementTaskERPSimpleByUtilitiesPointOfDeliveryIDQueryResponse_ In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Web Service Definition (Back End)
ISU_MeasurementTask001QR
Category
A2X
Direction
inbound
Mode
synchronous
Idempotency
no
Change/Update Behavior
not applicable
P2P Communication Enabled
true
Business Context and Use This inbound operation performs a query for a Utilities Measurement Task assigned to a Utilities Point Of Delivery Internal ID.
Features When this operation is executed, a list of Utilities Measurement Tasks, that are related to the provided Utilities Point Of Delivery Internal ID, is returned. A Utilities Point Of Delivery Internal ID is mandatory; if you do not provide one, you will receive an error message and no results will be returned.
Error Handling If you do not enter a Utilities Point Of Delivery Internal ID, you will receive an error message. No Utilities Measurement Task will be found if you enter an invalid Utilities Point Of Delivery Internal ID. Users should have the proper authorization to display Utilities Measurement Task basic data.
Message Types UtilitiesMeasurementTaskERPSimpleByUtilitiesPointOfDeliveryIDQuery_sync UtilitiesMeasurementTaskERPSimpleByUtilitiesPointOfDeliveryIDResponse_sync
Prerequisites To use this service operation, the Utilities (IS-U) application component should be implemented.
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated.
Configuration This operation is suitable for the Utilities Industry Solutions sector. It is necessary that the customer runs the IS-U application component in order to use it. Note that users should have the proper authorization to display the contracts (authorization object E_LOG_REG).
Enhancements The ISU_SE_MEASTASK001QR Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot: ISU_SPOT_SE_MEASTASK. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data.
1.13.3.4.4 Utilities Measurement Task In An interface to receive confirmations for data handling with utilities measurement task.
Technical Data Entity Type
Service Interface
Category
SAP A2A
Direction
inbound
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 84 of 130
Business Context and Use The service interface Utilities Measurement Task In contains the inbound operations for the business object Utilities Measurement Task. This service is used to confirm a previously asynchronously communicated change of measurement task from SAP to the meter data unification and synchronization system (MDUS). The MDUS system uses the service to confirm the change to the measurement task data.
1.13.3.4.4.1 Change Based on Smart Meter Measurement Task Change Confirmation as Bulk To receive a confirmation about the change of utilities measurement task as bulk.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
SmartMeterUtilitiesMeasurementTaskERPBulkChangeConfirmation_In
Namespace
http://sap.com/xi/IS-U/Global2
Category
SAP A2A
Direction
inbound
Mode
asynchronous
Idempotency
no
P2P Communication Enabled
no
Business Context and Use The Change Based on Smart Meter Measurement Task Change Confirmation as Bulk inbound bulk service operation can be used to receive a confirmation if a bulk request for changing the utilities measurement task basic data is sent to the Advanced Metering Infrastructure (AMI).
Features When changing relevant register information (such as TOU information, register category or interval length), this information has to be sent to AMI. Firstly, a request for changing the basic data is sent to AMI (SmartMeterUtilitiesMeasurementTaskERPChangeRequest_Out). Following this, the corresponding confirmation (SmartMeterUtilitiesMeasurementTaskERPChangeConfirmation_In) is received. This service consists of the following nodes: UtilitiesMeasurementTask UtilitiesDevice The following elements are mandatory: Utilities Measurement Task ID UtilitiesDeviceID If one or more mandatory elements are not provided, the system displays an error message.
Error Handling The SmartMeterUtilitiesMeasurementTaskERPBulkChangeConfirmation_In operation supports Forward Error Handling (FEH). The following error category is used: PRE.AUE Authorization error For more information about individual error categories, see the code list for the global data type LogItemCategoryCode.
Message Types Smart Meter Utilities Measurement Task ERP Bulk Change Confirmation
Prerequisites To use this service operation, the Utilities (IS-U) application component should be implemented.
Notes on SAP Implementation PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 85 of 130
Switch Framework To use this service operation, activate the Utilities business function set (ISU_UTIL_1). Configuration This operation is suitable for the Utilities Industry Solutions sector. However, it is only available to customers who are running the IS-U application component. Enhancements The Business Add-In (BAdI) ISU_SE_MTSMCHGBLKRCO_ASYN is available for this service operation. This BAdI allows you to use a customer-specific logic for the inbound/outbound mapping of application data. This BAdI is available in the enhancement spot ISU_SPOT_SE_DEVICE. The BAdI can be implemented several times. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
More Information The outbound counterpart for this inbound operation is the Request Utilities Device Smart Meter Change as Bulk (UtilitiesDeviceERPSmartMeterBulkChangeRequest_Out) operation.
1.13.3.4.4.2 Change Based on Smart Meter Utilities Measurement Task Change Confirmation To receive a confirmation for measurement task basic data that has been changed.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
SmartMeterUtilitiesMeasurementTaskERPChangeConfirmation_In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Web Service Definition (Back End)
ISU_MEASTASKSMCHGCO
Category
SAP A2A
Direction
inbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
Type1
P2P Communication Enabled
yes
Business Context and Use After sending a request to change the utilities measurement task basic data to AMI, the corresponding confirmation is received in IS-U. The confirmation confirms the change of the corresponding data. If an error occurs during processing, the data received previously should not be processed at all and a negative confirmation should be sent. The confirmation should be processed within a BAdI in the IS-U System, which provides customers with a means of creating their own monitoring functionality.
Features When changing relevant register information, such as TOU information, register category or interval length, this information has to be sent to AMI. Firstly, a request for changing the basic data is sent to AMI (SmartMeterUtilitiesMeasurementTaskERPChangeRequest_Out). Secondly, the corresponding confirmation (SmartMeterUtilitiesMeasurementTaskERPChangeConfirmation_In ) is received. This service consists of the following nodes: UtilitiesMeasurementTask UtilitiesDevice The following elements are mandatory: Utilities Measurement Task ID UtilitiesDeviceID If one or more mandatory elements are not provided, the system displays an error message.
Error Handling The system also displays an error message if any of the mandatory elements mentioned above are not provided.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 86 of 130
Message Types Smart Meter Utilities Measurement Task ERP Change Confirmation
Prerequisites To use this service operation, the application component Utilities (IS-U) should be implemented.
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated.
Configuration This operation is suitable for the Utilities Industry Solutions sector. However, it can only be used by customers who are running the IS-U application component.
Enhancements The Business Add-In (BAdI) ISU_SE_MEASTASKSMCHGRCO_ASYN is available for this operation. This BAdI definition is found in the enhancement spot ISU_SPOT_SE_MEASTASK. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data.
1.13.3.4.5 Utilities Measurement Task Out An interface to send requests for data handling with utilities measurement tasks.
Technical Data Entity Type
Service Interface
Category
SAP A2A
Direction
outbound
Business Context and Use The Utilities Measurement Task Out outbound service interface groups operations for the business object Utilities Measurement Task. It is used in the context of smart meters to asynchronously request a change of measurement task data in the meter data unification and synchronization system (MDUS). For example, a change of measurement task data occurs if time-of-use information regarding a specific measurement task is changed.
Notes on SAP Implementation For information, see Request Smart Meter Utilities Measurement Task Change.
1.13.3.4.5.1 Request Smart Meter Utilities Measurement Task Change To request the changing of measurement task basic data. When changing relevant register information (for example, TOU information or interval length), this information has to be sent to AMI.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 605
Release State
released
Technical Name
SmartMeterUtilitiesMeasurementTaskERPChangeRequest_Out
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Category
SAP A2A
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 87 of 130
Direction
outbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
Type1
P2P Communication Enabled
yes
Business Context and Use This service allows changing measurement task basic data at AMI side. The service is used, whenever key information regarding measurement task is changed within IS-U (for example, TOU information, Register category, and Interval Length ID). The selection date for Advance Metering System should be the change date. If this date is not available, the current system date (sy-datum) should be used.
Features When changing relevant register information, for example, TOU information, register category or interval length, this information has to be sent to AMI. Firstly, a request for changing the basic data is sent to AMI. Secondly, the corresponding confirmation (SmartMeterUtilitiesMeasurementTaskERPChangeConfirmation_In) is received. The following elements are mandatory: Utilities Measurement Task ID Time Zone Code StartDate EndDate MeasureUnitCode DecimalValuePrecision UtilitiesDeviceID UtilitiesAdvancedMeteringSystemID If you do not provide one or more of the mandatory elements, you will receive an error message and no information will be sent to AMI.
Error Handling If you do not enter any one of the mandatory elements mentioned above, you will receive an error.
Message Types SmartMeterUtilitiesMeasurementTaskERPChangeRequest
Prerequisites To use this service operation, the application component Utilities (IS-U) should be implemented.
Notes on SAP Implementation Switch Framework The Business Function Set Utilities must be activated.
Configuration This operation is suitable for the Utilities Industry Solutions sector. It is necessary that the customer runs the IS-U application component in order to use it.
Enhancements The Business Add-In (BAdI) ISU_SE_MEASTASKSMCHGRCO_ASYN is available for this operation. This BAdI definition is contained in the Enhancement Spot ISU_SPOT_SE_MEASTASK. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data.
1.13.3.4.5.2 Request Smart Meter Utilities Measurement Task Change as Bulk To request the change of smart meter utilities measurement task as bulk.
Technical Data
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 88 of 130
Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
SmartMeterUtilitiesMeasurementTaskERPBulkChangeRequest_Out
Namespace
http://sap.com/xi/IS-U/Global2
Category
SAP A2A
Direction
outbound
Mode
asynchronous
Idempotency
no
P2P Communication Enabled
no
Business Context and Use The Request Smart Meter Utilities Measurement Task Change as Bulk outbound bulk service operation can be used to request a bulk change of smart meter utilities measurement tasks in the AMI System.
Features The service is used when key information regarding multiple measurement tasks (for example, TOU information, register category, interval length ID) is changed in IS-U. The selection date for the advanced metering system should be the change date. If this date is not available, the current system date (sydatum) should be used. The service is triggered when data is changed at register level and multiple registers for a specific device are involved: Device Modification (EG42) In a first step, a request for changing the basic data is sent to AMI. Following this, the corresponding confirmation (SmartMeterUtilitiesMeasurementTaskERPBulkChangeConfirmation_In) is received.
Error Handling The following elements in the bulk request message are mandatory for every object: Utilities Measurement Task ID Time Zone Code StartDate EndDate MeasureUnitCode DecimalValuePrecision UtilitiesDeviceID UtilitiesAdvancedMeteringSystemID If you do not provide one or more of the mandatory elements, the system displays an error message and no information is sent to AMI. You should also provide the UUID of the bulk request message.
Message Types Smart Meter Utilities Measurement Task ERP Bulk Change Request
Prerequisites To use this service operation, the Utilities (IS-U) application component should be implemented.
Notes on SAP Implementation Switch Framework To use this service operation, activate the Utilities business function set (ISU_UTIL_1). Configuration This operation is suitable for the Utilities Industry Solutions sector. However, it is only available to customers who are running the IS-U application component. Enhancements The Business Add-In (BAdI) ISU_SE_MTSMCHGBLKRCO_ASYN is available for this service operation. This BAdI allows you to use a customer-specific logic for the inbound/outbound mapping of application data. This BAdI is available in the enhancement spot ISU_SPOT_SE_MEASTASK. The BAdI can be implemented several times. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
More Information The inbound counterpart for this outbound operation is the Change based on Smart Meter Measurement Task Change Confirmation as Bulk
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 89 of 130
(SmartMeterUtilitiesMeasurementTaskERPBulkChangeConfirmation_In) operation.
1.13.4 Service Contract Processing Service Contract Processing handles the maintenance of contractual agreements that are concluded between service providers and customers for specific time periods. They serve as a basis for processing service requests and service orders in a customer service and support environment. In service contracts it is possible to specify the type and scope of services that are provided to the customer, as well as particular service levels.
Technical Data Entity Type
Process Component
Software Component Version
ESM ERP 606
Technical Name
ServiceContractProcessing
Namespace
http://sap.com/xi/ESM/ERP
1.13.5 Utilities Connection Processing Utilities connection processing covers processes that change the connection status of a Utilities point of delivery or utilitiesdDevice. The status can be changed upon request.
Technical Data Entity Type
Process Component
Software Component Version
ESM ERP 606
Technical Name
UtilitiesConnectionProcessing
Namespace
http://sap.com/xi/ESM/ERP
Business Context and Use The Utilities Connection Processing process component provides services for the utilities connection status change request in an A2A scenario to an external application. These cover the reconnection or disconnection of a utilities device. An external application can be, for example, a meter data synchronization and unification system – MDUS. Request messages are sent from the Utilities Connection Processing process component to application components (for example, Advanced Metering Infrastructure (AMI)) to manage the utilities connection status. This allows smart meters to be controlled remotely using requests from the Utilities Connection Processing process component.
Notes on SAP Implementation The target group must run the IS-U back-end application component to use the operations found in Utilities Connection Processing .
1.13.5.1 Utilities Connection Status Change Request A request to change the status of a utilities connection. A utilities connection can be linked to one or more utilities devices. Its connection status can be connected and disconnected.
Technical Data Entity Type
Business Object
Software Component Version
ESM ERP 606
Technical Name
UtilitiesConnectionStatusChangeRequest
Object Category
Business Process Object
Business Context and Use The Utilities Connection Status Change Request business object is used to manage disconnection and reconnection orders for an advanced metering infrastructure (AMI) device for the utilities industry. In the case of AMI, the services connected to the business object are used to inform a meter data unification and synchronization (MDUS) system about disconnection, reconnection, or cancellation of such disconnection and reconnection orders.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 90 of 130
Notes on SAP Implementation All service interfaces for this business object can only be used if the Utilities business function set (ISU_UTIL_1) is activated.
1.13.5.1.1 Utilities Connection Status Change Request In An interface used to receive confirmations for data handling with smart meter utilities connection status change requests.
Technical Data Entity Type
Service Interface
Category
SAP A2A
Direction
inbound
Business Context and Use The Utilities Connection Status Change Request In inbound service interface groups operations for the Utilities Connection Status Change Request business object. The service operations are used to receive confirmations from a meter data unification and synchronization (MDUS) system regarding: The disconnection or reconnection of an AMI device The cancellation of a disconnection or reconnection order
1.13.5.1.1.1 Change Based on Smart Meter Connection Status Change Request Bulk Create Conf. To receive a confirmation about the creation of a smart meter utilities connection status change request as bulk.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
SmartMeterUtilitiesConnectionStatusChangeRequestERPBulkCreateConfirmation_ In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Web Service Definition (Back End)
ISU_CONNSTSREQSMCRTBLKCO
Category
SAP A2A
Direction
inbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use The Change Based on Smart Meter Connection Status Change Request Bulk Create Conf. inbound service operation is used to confirm a disconnection of a smart meter. The confirmation service is called by the meter data unification and synchronization (MDUS) system to confirm a disconnection order created by SAP for Utilities. The bulk service allows the system to handle multiple confirmations of disconnection orders within one enterprise service call.
Related Operations The corresponding outbound operation is Request Smart Meter Utilities Connection Status Change Request Creation as Bulk.
Features For information, see Change based on Smart Meter Connection Status Change Request Create Confirmation.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 91 of 130
Processing For information, see Bulk, Bundle, Collection.
Error Handling For information, see Change based on Smart Meter Connection Status Change Request Create Confirmation.
Message Types SmartMeterUtilitiesConnectionStatusChangeRequestERPBulkCreateConfirmation
Notes on SAP Implementation Enhancements The BAdI for Utilities Connection Status Bulk Create Request Confirmation (ISU_SE_CNSTSRQSMCRTBLKRCO_ASYN) Business Add-In (BAdI) is available for this operation. This BAdI is found in the enhancement spot ISU_SPOT_SE_CONNSTSREQ. It allows you to create customer-specific inbound and outbound mapping for pre- and post-processing.
1.13.5.1.1.2 Change Based on Smart Meter Connection Status Change Request Cancellation Conf. To receive a confirmation about the cancellation of a smart meter utilities connection status change request.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
SmartMeterUtilitiesConnectionStatusChangeRequestERPCancellationConfirmatio n_In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Web Service Definition (Back End)
ISU_CONNSTSREQSMCNCCO
Category
SAP A2A
Direction
inbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use This inbound service operation is used to receive a confirmation from a Meter Data Unification and Synchronization System (MDUS) about the cancellation of disconnection requests or reconnection requests. These requests are updated with the status information 'cancellation'. The prerequisite for this service is that a remote cancellation for disconnection or reconnection is triggered to the external system (MDUS) for an AMI device. After this service operation is performed, the confirmation status for disconnection or reconnection is changed. If the confirmation is positive, the request status is: Remote Disc. Cancellation Executed Remote Recon. Cancellation Executed If the confirmation is negative, the request status is: Remote Disc. Cancellation Failed Remote Recon. Cancellation Failed
Features The inbound service Change Based on Smart Meter Connection Status Change Request Cancellation Conf. is used to confirm the new disconnection/reconnection of a specific smart meter. The operation is sent from an external system back to the SAP system. This service operation is used by SAP for Utilities, transaction EC87 ‘Display Disconnection Document’, to confirm the status of a Utilities smart
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 92 of 130
metering device. The operation can only be triggered if the device is an AMI device (smart meter). To trigger the operation, the user must first request the cancellation of a remote disconnection or reconnection. The operation is confirmed by the MDUS (an external system). The MDUS sends a cancellation confirmation of a disconnection/reconnection of a specific smart meter. The CancellationConfirmation updates the status of the smart meter.
Error Handling Forward Error Handling The Change Based on Smart Meter Connection Status Change Request Cancellation Conf. operation supports Forward Error Handling (FEH). The following error categories are used: PRE.AUE : Authorization Error PRE.TEE.LRE : Lock Request Error PRE.IDE : Identification Error PRE : Processing Error For more information about the individual error categories, see the code list for the global data type LogItemCategoryCode.
Message Types SmartMeterUtilitiesConnectionStatusChangeRequestERPCancellationConfirmation
Notes on SAP Implementation To use this service operation, the application component Utilities (IS-U) should be implemented and the Utilities business function set must be activated.
Enhancements The ISU_SE_CONNSTSREQSMCNCRCO_ASYN Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot: ISU_SPOT_SE_CONNSTSREQ. You can use this BAdI to create a customer-specific logic for the outbound mapping of application data. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
1.13.5.1.1.3 Change Based on Smart Meter Connection Status Change Request Create Confirmation To receive a confirmation about the creation of a smart meter utilities connection status change request.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
SmartMeterUtilitiesConnectionStatusChangeRequestERPCreateConfirmation_In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Web Service Definition (Back End)
ISU_CONNSTSREQSMCRTCO
Category
SAP A2A
Direction
inbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use This inbound service operation is used to receive a confirmation from a Meter Data Unification and Synchronization System (MDUS) about a disconnection or reconnection request. These requests are used to handle the disconnection or reconnection of an AMI device and the corresponding utility installation. Within this inbound service operation, a disconnection or reconnection is actually performed by the MDUS. As a result, a confirmation message is sent from the MDUS to SAP for Utilities. Within SAP for Utilities, the result of the original disconnection or reconnection request is updated with the status of the corresponding AMI device and the date/time of disconnection or reconnection within a disconnection document. The prerequisite for this service operation is that a remote disconnection or reconnection was triggered to the external system (MDUS) for an AMI device. Disconnection or reconnection results cannot be entered manually for AMI devices (smart meters). However, if meter readings are also required, a corresponding meter reading document also has to be created and sent to the MDUS in follow-up processes.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 93 of 130
After this service operation is executed, the confirmation status for the disconnection or reconnection is changed. If the confirmation is positive, the request status is: Remote Disconnection Confirmed Remote Disconnection Executed Remote Reconnection Confirmed Remote Reconnection Executed If the confirmation is negative, the request status is: Remote Disconnection Failed Remote Reconnection Failed
Features The inbound service operation Change Based on Smart Meter Connection Status Change Request Create Confirmation is used to confirm the new disconnection/reconnection of a specific smart meter. The operation is sent from an external system back into the SAP system. This service operation is used by SAP for Utilities, transaction EC87 ‘Display Disconnection Document’, to confirm the status of a Utilities AMI device (smart meter). To trigger the operation, the device must be an AMI device and the user has to request a cancellation of a remote disconnection or reconnection. The operation is confirmed by the MDUS (an external system). The MDUS sends a confirmation of a disconnection/reconnection of a specific smart meter. The Change Based on Smart Meter Connection Status Change Request Create Confirmation operation updates the status of the smart meter.
Error Handling Forward Error Handling The Change Based on Smart Meter Connection Status Change Request Create Confirmation operation supports Forward Error Handling (FEH). The following error categories are used: PRE.AUE : Authorization Error PRE.TEE.LRE : Lock request Error PRE.IDE :Identification Error PRE : Processing Error For more information about the individual error categories, see the code list for the global data type LogItemCategoryCode.
Message Types Smart Meter Utilities Connection Status Change Request ERP Create Confirmation
Notes on SAP Implementation To use this service operation, the application component Utilities (IS-U) should be implemented and the Utilities business function set must be activated.
Enhancements The ISU_SE_CONNSTSREQSMCRTRCO_ASYN Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot: ISU_SPOT_SE_CONNSTSREQ. You can use this BAdI to create a customer-specific logic for the outbound mapping of application data. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
1.13.5.1.2 Utilities Connection Status Change Request Out An interface used to request information about the disconnection and reconnection information for an AMI device.
Technical Data Entity Type
Service Interface
Category
SAP A2A
Direction
outbound
Business Context and Use The Utilities Connection Status Change Request Out outbound service interface groups operations for the business object Utilities Connection Status Change Request. These service operations are used to send information to a meter data unification and synchronization (MDUS) system about: The disconnection or reconnection of an AMI device The cancellation of a disconnection or reconnection order.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 94 of 130
1.13.5.1.2.3 Request Smart Meter Utilities Connection Status Change Request Cancellation To request the cancellation of a smart meter utilities connection status change request.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
SmartMeterUtilitiesConnectionStatusChangeRequestERPCancellationRequest_Ou t
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Category
SAP A2A
Direction
outbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use This outbound service operation is used to inform a Meter Data Unification and Synchronization System (MDUS) about the cancellation of a disconnection request or reconnection request. These requests are updated with the status information 'cancellation'. After this service operation is executed, the confirmation status for the disconnection or reconnection is: Remote Disc. Cancellation Requested Remote Recon. Cancellation Requested Within this process, a disconnection request or reconnection request that has already been sent to the MDUS is cancelled. Cancellation of a disconnection request or reconnection request is only possible if no disconnection or reconnection has already taken place. This outbound service is triggered by the manual processing of the disconnection or reconnection request by using the reverse function in the change disconnection document (transaction EC86) or by using the mass activity Send Disconnection/Reconnection Orders using transaction EAMIDISCSEND01. Disconnection reversal processes are necessary in the following use cases: A customer pays open items before the disconnection has been executed. A failure in the communication between SAP for Utilities and the MDUS has occurred and a reversal of the disconnection order is necessary. An erroneous disconnection order has been captured (for example, the wrong AMI devices have been selected). If follow-up documents have been created and are still in processing mode, these documents also have to be reversed. For example, an open notification work item for customer approval has to be closed automatically within this process. There could also be the case that follow-up processes have already been triggered and a reversal is not possible, for example: The requested disconnection has already been performed. In this case a reconnection order has to be created instead. Reconnection reversal processes are necessary in the following situations: A failure in the communication between SAP for Utilities and the MDUS has occurred and a reversal of the reconnection order is necessary. An erroneous reconnection order has been captured (for example, the wrong AMI devices have been selected) If follow-up documents have been created and are still in processing mode, these documents have to be reversed as well. For example, an open notification work item for customer approval has to be closed automatically within this process. There could also be the case that follow-up processes have already been triggered and a reversal is not possible, for example: The requested reconnection has already been executed. In this case, a disconnection order has to be created instead.
Features The outbound service Request Smart Meter Utilities Connection Status Change Request Cancellation performs a request to create a cancellation of a disconnection or a reconnection of a specific smart meter. The operation is sent from the SAP system to an external system. This service operation is used by SAP for Utilities, transaction EC86 ‘Change Disconnection Document’, to update the status of a Utilities smart metering device. The operation can only be triggered if the device is an AMI (Advanced Metering Infrastructure) device. To trigger the operation, the user should choose the ‘Reverse Disconnection or Reconnection Action’ button. The operation then sends the current status of an AMI device to an external system called MDUS (Meter Data Unification & Synchronization).
Message Types Smart Meter Utilities Connection Status Change Request ERP Cancellation Request
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 95 of 130
Notes on SAP Implementation To use this service operation, the application component Utilities (IS-U) should be implemented and the Utilities business function set must be activated.
Enhancements The ISU_SE_CONNSTSREQSMCNCRCO_ASYN Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot: ISU_SPOT_SE_CONNSTSREQ. You can use this BAdI to create a customer-specific logic for the outbound mapping of application data. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
1.13.5.1.2.3 Request Smart Meter Utilities Connection Status Change Request Creation To request the creation of a smart meter utilities connection status change request.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
SmartMeterUtilitiesConnectionStatusChangeRequestERPCreateRequest_Out
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Category
SAP A2A
Direction
outbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use This outbound service operation is used to handle disconnection and reconnection processes in the AMI (Advanced Meter Infrastructure) environment. This service operation allows communication between SAP for Utilities and a meter data unification and synchronization system (MDUS) regarding a disconnection or reconnection request. The key reasons for disconnection are: Lack of customer payment (credit or collection cause) Confirmed customer request (explicit request) The key reasons for reconnection are: Customer completes the payment (dunning lock removed: credit or collection cause) Confirmed customer request (explicit request) Within this process, a disconnection or reconnection is triggered by the manual processing of the disconnection or reconnection request for a specific AMI device (smart meter) using the function ‘Trigger Immediate Disconnection or Reconnection’ or ‘Trigger Remote Disconnection or Reconnection’ in transaction 'Change Disconnection Document’ (transaction EC86) or by using the mass activity ‘Send Disconnection/Reconnection Orders’ via transaction EAMIDISCSEND01. A message is sent from SAP for Utilities to the MDUS. Within the MDUS, a corresponding disconnection or reconnection request is created and is processed. As a result of the creation of the request, or in the case of error, a confirmation is sent from the MDUS to SAP for Utilities. You can trigger the disconnection or reconnection request (Trigger Immediate Disconnection/Reconnection) in one of two ways: Option 1: Using the dialog functionality 'Change Disconnection Document' (transaction EC86) in the ERP System Option 2: From the SAP CRM system Once this outbound service operation is triggered successfully, the confirmation status for the disconnection or reconnection is: Remote Disconnection Requested Remote Reconnection Requested The previous status of the disconnection or reconnection order must be: Remote Disconnection to be Requested Remote Reconnection to be Requested These order statuses are necessary for the successful execution of this outbound service operation.
Features The outbound service Request Smart Meter Utilities Connection Status Change Request Creation requests the disconnection or reconnection of a specific
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 96 of 130
smart meter. The request is sent from the SAP system to an external system (Meter Data Unification and Synchronization). This service operation is used by SAP for Utilities, transaction EC85 ‘Create Disconnection Document’, and is used to update the status of a utilities smart meter. The operation can only be triggered if the device in question is an AMI (Advanced Metering Infrastructure) device. To trigger the operation, the user must choose the ‘Trigger Remote Disconnection" or "Trigger Remote Reconnection" button. The operation then sends the current status of the AMI device to the MDUS external system. The Request Smart Meter Utilities Connection Status Change Request Creation operation requires the ID of the Utilities Connection Status Change Request message combined with the device that the service wishes to update.
Message Types Smart Meter Utilities Connection Status Change Request ERP Create Request
Notes on SAP Implementation To use this service operation, the application component Utilities (IS-U) should be implemented and the Utilities business function set must be activated.
Enhancements The ISU_SE_CONNSTSREQSMCRTRCO_ASYN Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot: ISU_SPOT_SE_CONNSTSREQ. You can use this BAdI to create a customer-specific logic for the outbound mapping of application data. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
1.13.5.1.2.3 Request Smart Meter Utilities Connection Status Change Request Creation as Bulk To request the creation of a smart meter utilities connection status change request as bulk.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
SmartMeterUtilitiesConnectionStatusChangeRequestERPBulkCreateRequest_Out
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Category
SAP A2A
Direction
outbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use The Request Smart Meter Utilities Connection Status Change Request Creation as Bulk outbound service operation is used to send a disconnection order for a smart meter to the meter data unification and synchronization (MDUS) system. After the MDUS has received the disconnection order, a confirmation is sent back to SAP for Utilities. The bulk service allows the system to handle multiple disconnection orders within one enterprise service call.
Related Operations The Request Smart Meter Utilities Connection Status Change Request Creation outbound operation sends a single disconnection order. The Change based on Smart Meter Connection Status Change Request Bulk Create Conf. inbound operation confirms the disconnection orders.
Features For general information, see Request Smart Meter Utilities Connection Status Change Request Creation. To send a disconnection order, the following information is needed: AMI request ID (ID element) Disconnection activity category (UtilitiesServiceDisconnectionReasonCode element) Date and time of disconnection activity (PlannedProcessingDateTime element) Equipment number (UtilitiesDeviceID element)
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 97 of 130
AMI system ID (UtilitiesAdvancedMeteringSystemID element)
Processing For more information, see Bulk, Bundle, Collection.
Message Types SmartMeterUtilitiesConnectionStatusChangeRequestERPBulkCreateRequest
Notes on SAP Implementation For general information, see Request Smart Meter Utilities Connection Status Change Request Creation .
Enhancements The BAdI for Utilities Connection Status Bulk Createl Request Confirmation (ISU_SE_CNSTSRQSMCRTBLKRCO_ASYN) Business Add-In (BAdI) is available for this operation. This BAdi is found in the enhancement spot ISU_SPOT_SE_CONNSTSREQ. It allows you to create customer-specific inbound and outbound mapping for pre- and post-processing.
1.13.5.1.2.4 Notify Utilities Connection Status Change Request Out Definition An interface used to send notifications for status handling of smart meter utilities connection status change requests.
Technical Data Software Component Version
ESM ERP 607
Technical Name
UtilitiesConnectionProcessingNotifyUtilitiesConnectionStatusChangeRequestOut
Category
SAP A2A
Direction
Outbound
Business Context and Use The Notify Utilities Connection Status Change Request Out service interface groups the outbound operations that are used to send notifications or cancellation notifications about the utilities connection status change request as bulk. You can disconnect and reconnect advanced meters remotely in an Advanced Metering Infrastructure. If remote functions are not available or are not used, the external system (such as MDUS) and the AMI system are not informed about device connection status changes. If smart meters are not used to disconnect or reconnect remotely, these actions have to be performed manually by a service technician and must then be confirmed in the SAP system using the functions Enter Disconnection and/or Enter Reconnection in the transactions Create/Change Disconnection Document (EC85/EC86). The capabilities Enter Disconnection and/or Enter Reconnection in transactions Create/Change Disconnection Document (EC85/EC86) trigger the service SmartMeterUtilitiesConnectionStatusChangeRequestERPBulkNotification_OUT, which sends the disconnection or reconnection to the external system. The initialization report REAMI_MANUAL_DISC_SEND (to synchronize the disconnection status in a setup phase) also triggers this service to update an external system. If a disconnection or a reconnection is cancelled, the cancellation service SmartMeterUtilitiesConnectionStatusChangeRequestERPCancellationBulkNotification_OUT is triggered. If the physical disconnection/reconnection has already been performed manually by a technician, only one notification service is needed. Instead, the remote disconnection/reconnection uses a request and a confirmation service to perform the disconnection/reconnection, and to report this back to the SAP system. The services used are logged in AMI monitoring.
Integration This service interface is used in the following process component interactions: Utilities Connection Processing - MDUS Processing (third party) (notify connection status - single) Utilities Connection Processing - MDUS Processing (third party) (notify connection status - bulk)
Service Operations Create Notification of Utilities Connection Status Change Request as Bulk
To send a notification about the utilities connection status change request as bulk.
Create Cancellation of Notification of Utilities Connection Status Change Request
To send a cancellation notification about the utilities connection status change
as Bulk
request as bulk.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 98 of 130
1.13.5.1.2.4.1 Notify of Smart Meter Utilities Connection Status Change Request as Bulk To send a notification about the utilities connection status change request as bulk.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 605
Release State
Released
Technical Name
SmartMeterUtilitiesConnectionStatusChangeRequestERPBulkNotification_Out
Namespace
http://sap.com/xi/IS-U/Global
Application Component
IS-U
Category
SAP A2A
Direction
outbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
true
Business Context and Use The Utilities Connection Status Change Request business object is used to manage disconnection and reconnection activities for an advanced meter in the utilities industry. In the advanced metering infrastructure (AMI), the services connected to the business object are used to inform a meter data unification and synchronization (MDUS) system about disconnection, reconnection, or cancellation of such disconnection and reconnection activities. The SmartMeterUtilitiesConnectionStatusChangeRequestERPBulkNotification_Out outbound service operation is used to send a notification about disconnection or reconnection as bulk. The possible use cases are the following: Installation of a device at a disconnected installation When you try to install a new device into an installation that contains disconnected devices, a popup is displayed, asking you to decide whether the device that is being installed at a disconnected installation should also be disconnected. If you choose yes , a disconnection notification service is sent to MDUS. Replacement of a device at a disconnected installation When you try to replace a device in an installation that contains disconnected devices, a disconnected device is automatically replaced with a disconnected device and a reconnection notification service is sent to MDUS. Removal of a device from a disconnected installation In this case, a reconnection notification service is sent to MDUS. The status in the disconnection document is set to removed and disconnected .
Features The following graphic illustrates both the interface, the fields and cardinality of this service operation. You can use the Utilities data type catalog at http://service.sap.com/~sapidb/011000358700001049282012E ( service.sap.com/utilities SAP for Utilities SAP for Utilities - Product Information IS-U/CCS General Cookbook&Guidelines Utilities Data Type Catalog ) to search for information about specific fields.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 99 of 130
Interface, fields and cardinality of the service operation
The UtilitiesConnectionStatusChangeRequest should provide the following values: UtilitiesConnectionStatusChangeRequestID UtilitiesConnectionStatusChangeRequestCategoryCode The following category codes are available: 1 = Disconnection request for the disconnection of a utilities device 2 = Reconnection request for the reconnection of a utilities device UtilitiesServiceDisconnectionReasonCode The following disconnection reason codes are available: 00 = Any reason not matching the reasons in the disconnection reason code list 01 = Service disconnection triggered by dunning with level disconnection 02 = Service disconnection because a house or an apartment is unoccupied 03 = Service disconnection upon customer request 04 = Service disconnection because of technical reasons, e.g. prior to maintenance 05 = Service disconnection because the reason for service activation became obsolete GLOBAL DateTime (date and time at which the service technician disconnects or reconnects an advanced meter) UtilitiesDeviceID UtilitiesAdvancedMeteringSystemID In the SAP system, the sending of notifications from SAP for Utilities to the external system is triggered using the transactions Create / Change Disconnection Document (EC85 and EC86).
Related Items Utilities Device business object Notify Cancellation of Smart Meter Utilities Connection Status Change Request as Bulk service operation
Error Handling Typical general processing and/or mapping errors are: UtilitiesDeviceID not provided Message UUID not provided For more information about monitoring your process integration, see the SAP Process Integration (PI) Handbook.
Integration This service operation belongs to the Notify Utilities Connection Status Change Request Out service interface.
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 100 of 130
Configuration This operation is suitable for the Utilities Industry Solutions sector. However, it is only available to customers who are running the IS-U application component. Enhancements The Business Add-In (BAdI) ISU_SE_CNSTSRQSMBLKNOO_ASYN is available for this operation. This BAdI definition is found in the enhancement spot ISU_SPOT_SE_CONNSTSREQ. You can use this BAdI to create a customer-specific logic for inbound and outbound mapping of application data. The BAdI can be implemented several times. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, customer, and so on.
1.13.5.1.2.4.2 Notify Cancellation of Smart Meter Utilities Connection Status Change Request as Bulk To send a cancellation notification about the utilities connection status change request as bulk.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 605
Release State
Released
Technical Name
SmartMeterUtilitiesConnectionStatusChangeRequestERPCancellationBulkNotificat ion_Out
Namespace
http://sap.com/xi/IS-U/Global
Application Component
IS-U
Category
SAP A2A
Direction
outbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
true
Business Context and Use The Utilities Connection Status Change Request business object is used to manage disconnection and reconnection activities for an advanced meter in the utilities industry. In the advanced metering infrastructure (AMI), the services connected to the business object are used to inform a meter data unification and synchronization (MDUS) system about disconnection, reconnection, or cancellation of such disconnection and reconnection activities. The service operation SmartMeterUtilitiesConnectionStatusChangeRequestERPCancellationBulkNotification_Out is used to cancel a notification about disconnection or reconnection as bulk.
Features The following graphic illustrates both the interface and the fields and cardinality of this service operation. You can use the Utilities data type catalog at http://service.sap.com/~sapidb/011000358700001049282012E ( service.sap.com/utilities SAP for Utilities SAP for Utilities - Product Information IS-U/CCS General Cookbook&Guidelines Utilities Data Type Catalog ) to search for information about specific fields.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 101 of 130
Interface, fields and cardinality of the service operation
The UtilitiesConnectionStatusChangeRequest should provide the following values: UtilitiesConnectionStatusChangeRequestID UtilitiesConnectionStatusChangeRequestCategoryCode The following category codes are available: 1 = Disconnection request for the disconnection of a utilities device 2 = Reconnection request for the reconnection of a utilities device UtilitiesDeviceID UtilitiesAdvancedMeteringSystemID In the SAP system, the sending of notifications from SAP for Utilities to the external system is triggered using the transactions Create / Change Disconnection Document (EC85 and EC86).
Related Items Utilities Device business object.
Error Handling Typical general processing and/or mapping errors are: UtilitiesDeviceID not provided Message UUID not provided For more information about monitoring your process integration, see the SAP Process Integration (PI) Handbook.
Integration This service operation belongs to the Notify Utilities Connection Status Change Request Out service interface.
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated. Configuration This operation is suitable for the Utilities Industry Solutions sector. However, it is only available to customers who are running the IS-U application component. Enhancements The Business Add-In (BAdI) ISU_SE_CNSTSRQSMBLKNOO_ASYN is available for this operation. This BAdI definition is found in the enhancement spot ISU_SE_CNSTSRQSMCNCBLKNOO_ASYN. You can use this BAdI to create a customer-specific logic for inbound and outbound mapping of application data. The BAdI can be implemented several times. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, customer, and so on.
1.13.5.1.3 Utilities Connection Status Management In PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 102 of 130
1.13.5.1.3 Utilities Connection Status Management In An interface used to receive confirmation for data handling with a utilities connection status change request.
Technical Data Entity Type
Service Interface
Category
SAP A2A
Direction
inbound
Business Context and Use The Utilities Connection Status Management In inbound service interface contains operations related to the Utilities Connection Status Change Request business object. This interface enables the exchange of messages confirming the status change of utilities connections. For example, when a device has been physically disconnected, an inbound confirmation message is sent from a remote system (such as the Advanced Metering Infrastructure system) to the SAP for Utilities backend system confirming the disconnection of that device.
Constraints This service interface has been released as of ECC 6.0 EhP2 (IS-U 602). A new version of this service interface is available as of ECC 6.0 EhP5. We strongly recommend using the new service interface Utilities Connection Status Change Request In, instead.
1.13.5.1.3.1 Change Utilities Connection Status Change Request Based on Confirmation To receive a confirmation about the creation and cancellation of a utilities connection status change request.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
deprecated
Notes on Release State
This service operation has been released as of ECC 6.0 EhP2 (IS-U 602). A new version of this service is available as of EhP5 (IS-U 605). SAP strongly recommends using the new service operation Change based on Smart Meter Connection Status Change Request Create Confirmation , instead.
Technical Name
UtilitiesConnectionStatusChangeRequestConfirmation_In
Namespace
http://sap.com/xi/IS-U
Application Component
IS-U
Category
SAP A2A
Direction
inbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
no
Business Context and Use The Change Utilities Connection Status Change Request Based on Confirmation service operation is an inbound service operation of the business object Utilities Connection Status Change Request that enables the exchange of messages confirming the status change of utilities connections, for example, of a (smart) meter. For example, when a device has been disconnected, a confirmation message is sent from the remote system (for example, an Advanced Metering System (AMS) back to the SAP IS-U system to confirm the disconnection of that particular device.
Related Operations Request Utilities Connection Status Change Request Request Utilities Connection Status Change Request Cancellation
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 103 of 130
Features This inbound service is an asynchronous service which is triggered from a remote system (AMS). In the signature of the incoming inbound message, the following GDTs (Global Data Types) are expected to be included with corresponding values Message Header ID: (Used data type: UtilitiesConnectionStatusChangeRequestID) Log
Message Types UtilitiesConnectionStatusChangeRequestConfirmation
Constraints This inbound service operation is used as confirmation to the following request messages: UtilitiesConnectionStatusChangeRequestRequest, ( Activity Category Code: Disconnection) UtilitiesConnectionStatusChangeRequestRequest, (Activity Category Code: Reconnection) UtilitiesConnectionStatusChangeRequestCancelRequest, (Cancellation)
Notes on SAP Implementation B2B and A2A related information The service operation is defined and implemented as an A2A service: the interaction between the service provider (SAP for Utilities) and an external system (AMS) is completely asynchronous. The service integration model requires the following parties to be involved: An SAP for Utilities system Release 2005 or higher An SAP XI system Release 3.0, Release 7.0 or higher A non-SAP (for example, AMI system) or an SAP application other than SAP for Utilities Release ERP2005 or higher
Processing To use this service operation, the Utilities (IS-U) application component should be implemented. The Change Utilities Connection Status Change Request Based on Confirmation inbound confirmation message from the AMS is the response to the following outbound requests that are triggered in the SAP for Utilities backend system: Disconnection or Reconnection request (UtilitiesConnectionStatusChangeRequestRequest) Cancellation of Disconnection request (UtilitiesConnectionStatusChangeRequestRequest).
Enhancements The Add-In (BAdI) BADI_ISU_DISCON_CONFIRM_IN is available for this operation. This BAdI definition is found in the enhancement spot: SPOT_ISU_CONNECTION_IN. You can use this BAdI to create a customer-specific logic for the outbound mapping of application data. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
Switch Framework The Utilities Business Function Set must be activated.
1.13.5.1.4 Utilities Connection Status Management Out An interface used to request information about the status change for utility connections.
Technical Data Entity Type
Service Interface
Category
SAP A2A
Direction
outbound
Business Context and Use The Utilities Connection Status Management Out outbound service interface groups service operations for the Utilities Connection Status Change Request business object. The interface enables the exchange of messages requesting a status change for utility connections (for example, meter). When, for instance, a disconnection order is created in SAP for the Utilities backend system (for example, due to technical reason or a customer request), SAP for Utilities calls this outbound service interface to send a message to a remote system (for example, the Advanced Metering Infrastructure system) requesting the corresponding device to be disconnected.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 104 of 130
Constraints This service interface has been released as of ECC 6.0 EhP2 (IS-U 602). A new version of this service interface is available as of ECC 6.0 EhP5. We strongly recommend using the new service interface Utilities Connection Status Change Request Out, instead.
1.13.5.1.4.1 Request Utilities Connection Status Change Request To request the creation of a utilities connection status change request.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
deprecated
Notes on Release State
This service operation has been released as of ECC 6.0 EhP2 (IS-U 602). A new version of this service is available as of ECC 6.0 EhP5 ( (IS-U 605) . SAP strongly recommends using the new service operation Request Smart Meter Utilities Connection Status Change Request Creation, instead.
Technical Name
UtilitiesConnectionStatusChangeRequestRequest_Out
Namespace
http://sap.com/xi/IS-U
Application Component
IS-U
Category
SAP A2A
Direction
outbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
no
Business Context and Use The Request Utilities Connection Status Change Request outbound service operation is related to the business object Utilities Connection Status Change Request business object that enables the exchange of messages requesting a status change for Utilities connections, for example, meters. The process starts with the creation of a disconnection document that refers to different utilities master data objects (for example, business partner, contract account, contract, premise, device, and so on) and can contain multiple disconnection orders and reconnection orders for the master data object referenced. When, for instance, a device has to be disconnected due to technical reasons or a customer request, a disconnection document is created in the SAP for Utilities backend system, which refers to different utilities master data objects (for example, business partner, contract account, contract, premise, device, and so on) and can contain multiple disconnection orders and reconnection orders for the master data object referenced. The disconnection order represents an order for disconnection that can either be executed automatically using AMI (Advanced Metering Infrastructure) or physically, by field service employees, which is the traditional way of disconnection. Once the disconnection document has been created, the back-office employee creates a disconnection order, an outbound request message is sent from the SAP for Utilities backend system to a remote system (AMI) asking for the disconnection of that particular device. This service operation can be used subsequently to request a reconnection of a disconnected device.
Features The outbound service is an asynchronous service which is triggered from the SAP for Utilities backend system. In the signature of the service operation, the following GDT (Global Data Type) is provided with the following corresponding values: Message Header - Used data type BusinessDocumentMessageHeader ID - Unique identifier for a Utilities connection status change request data type: UtilitiesConnectionStatusChangeRequestID Device Activity ID - Unique identifier for an item of a Utilities connection status change request data type: UtilitiesConnectionStatusChangeRquestActivityID Device Activity Category Code - Coded representation of the category of a Utilities connection status change. Data type: UtilitiesConnectionStatusChangeRequestActivityCategoryCode
Error Handling Since this is an outbound asynchronous service, Forward Error Handling is not used.
Message Types UtilitiesConnectionStatusChangeRequestRequest
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 105 of 130
Prerequisites To trigger the outbound request message, a disconnection or reconnection order should be created in the SAP for Utilities backend system.
Constraints Typically, disconnection is triggered by the dunning of open items, which is part of the Contract Accounting (CA) module. An event is raised in the SAP for Utilities backend system to trigger the disconnection of a device. Alternatively, a disconnection can be triggered manually, for example, upon receiving an end customer request or for technical reasons such as maintenance. A reconnection is triggered by posting incoming payments that are going to be used to settle dunning items. Alternatively, reconnection can be triggered manually upon request from a utilities end customer (for example, the reconnection of a vacation home). The disconnection outbound service performs a request to create a new disconnection/reconnection of a specific meter. The operation is sent from the SAP system to an external system (for example, an Advanced Metering System (AMS)). In the SAP for Utilities system, the transaction EC85 ‘Create Disconnection Document’ can be used to update the status of a Utilities device. The operation then sends the current status of the device to an external system (AMS), which can remotely control smart meters when requests are received from Utilities Connection Processing. The service is consumed in asynchronous interaction patterns and in conjunction with the SAP exchange Infrastructure (XI) acting as a service consumption intermediary. In this case, the service consumer (AMS) does not interact directly with the SAP for Utilities backend system. XI itself interacts with the backend system through XI service proxies. The interaction in the other direction works in a similar way. So XI mediates the entire message traffic between SAP for Utilities and the AMS.
Notes on SAP Implementation B2B and A2A related information The service operation is defined and implemented as an A2A service: the interaction between service provider (SAP for Utilities) and an external system (AMI) is completely asynchronous. The service integration model requires the following parties to be involved: An SAP for Utilities system Release 2005 or higher An SAP XI system Release 3.0 Release 7.0 or higher A non-SAP (for example, AMI system) or an SAP application other than SAP for Utilities Release ERP2005 or higher.
Processing To use this service operation, the Utilities (IS-U) application component should be implemented.
Enhancements The Business Add-In (BAdI) BADI_ISU_DISCON_REQU_OUT is available for this operation. The BAdI definition is found in the enhancement spot SPOT_ISU_CONNECTION_IN. You can use this BAdI to create a customer-specific logic for the outbound mapping of application data. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
Switch Framework The Utilities business function set must be activated.
1.13.5.1.4.2 Request Utilities Connection Status Change Request Cancellation To request the cancellation of a utilities connection status change request.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
deprecated
Notes on Release State
This service operation has been released as of ECC 6.0 EhP2 (IS-U 602). A new version of this service is available as of ECC 6.0 EhP5 (IS-U 605). SAP strongly recommends using the new service operation Request Smart Meter Utilities Connection Status Change Request Cancellation, instead.
Technical Name
UtilitiesConnectionStatusChangeRequestCancelRequest_Out
Namespace
http://sap.com/xi/IS-U
Application Component
IS-U
Category
SAP A2A
Direction
outbound
Mode
asynchronous
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 106 of 130
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
no
Business Context and Use This service is an outbound service operation for the business object Utilities Connection Status Change Request that enables the exchange of messages requesting the cancellation of a disconnection request. When, for instance, a device is disconnected by mistake, the disconnection document is cancelled in the SAP for Utilities backend system. Once the disconnection document is cancelled, an outbound request message is sent from the SAP for Utilities backend system to a remote system (for example, Advanced Metering Infrastructure (AMI) system) asking for cancellation of the disconnection request sent for that particular device.
Related operations Request Utilities Connection Status Change Request
Features This outbound asynchronous service operation is triggered from the SAP for Utilities backend system. In the signature of the service operation, the following GDTs (Global Data Types) are provided with corresponding values: Message Header ID Device Activity ID
Message Types UtilitiesConnectionStatusChangeRequestCancelRequest
Prerequisites To trigger the outbound cancel request message, a disconnection order should be created in the SAP for Utilities backend system.
Constraints This outbound service performs a request to create a new disconnection/reconnection for a specific utilities device (for example, a smart meter). The operation is sent from the SAP system to an external system (for example, an AMI system).
Example In the SAP for Utilities system, a disconnection order has been incorrectly created and should either be removed or cancelled. Following this process, two requests are sent to the AMI system: a disconnection request and a cancellation request. The status of the device is checked in the AMI system. If the device is still active, the AMI system cancels the previously sent disconnection request message. If, at that point in time, the device should already be disconnected, the cancellation request is ignored. In both cases, the AMI system sends a message back to the SAP for Utilities system confirming the cancellation of that disconnection request. The service is consumed in asynchronous interaction patterns, in conjunction with the SAP exchange infrastructure (XI) acting as a service consumption intermediary. In this case, the service consumer (AMI system) does not interact directly with the SAP for Utilities backend system. The XI itself interacts with the backend system through XI service proxies. The interaction works similarly in the other direction so the XI system mediates the entire message traffic between the SAP for Utilities and the AMI system.
Notes on SAP Implementation B2B and A2A Related Information The service operation is defined and implemented as an A2A service: the interaction between the service provider (SAP for Utilities) and the external system (AMI system) is completely asynchronous. The service integration model requires the following parties to be involved: SAP for Utilities system Release 2005 or higher SAP XI system Release 3.0 Release 7.0 or higher Non-SAP (for example, AMI system) or an SAP application other than SAP for Utilities Release ERP2005 or higher
Processing To use this service operation, the Utilities (IS-U) application component should be implemented.
Enhancements The Business Add-In (BAdI) BADI_ISU_DISCON_CNL_REQU_OUT is available for this operation. The BAdI definition is found in the enhancement spot SPOT_ISU_CONNECTION_IN. You can use this BAdI to create a customer-specific logic for the outbound mapping of application data. The implementations
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 107 of 130
are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
Switch Framework The Utilities business function set must be activated.
1.13.6 Utilities Contract Processing Utilities Contract Processing is a utilities specific process component that groups utilities specific business objects and their service operations needed to process utilities contracts.
Technical Data Entity Type
Process Component
Software Component Version
ESM ERP 606
Technical Name
UtilitiesContractProcessing
Namespace
http://sap.com/xi/ESM/ERP
Business Context and Use The Utilities Contract Processing process component is used to prepare applications in the Utilities industry supporting divisions such as electricity, gas and water. Market participants in regulated energy markets as well as in liberalized energy markets can apply this process component to their processes. In liberalized markets, the market participant distributor performing the market roles Grid Access Provider and Billing Agent, as well as the market participant supplier performing the market roles Balance Supplier, Customer Service Responsible and Billing Agent, need to process utilities contract data. This process component can be applied by front-end or back-end users working with data in the utilities contract environment. Utilities contract data involves the start/end date, division, billing block, price-specifying data, billed consumption, and billing schedule. Users are able to read contractual or billing-related data (such as contract basic data and contract billed consumption). Selected contracts can also be blocked or released for billing. Working with contractual data is the basis for process components covering billing and invoicing processes in the utilities industry (see also Utilities Invoice Processing).
Notes on SAP Implementation The target group must run the IS-U back-end application component to use the operations that Utilities Contract Processing contains.
1.13.7 Utilities Device Management Utilities Device Management is the management of the master data required for devices in the utilities sector.
Technical Data Entity Type
Process Component
Software Component Version
ESM ERP 606
Technical Name
UtilitiesDeviceManagement
Namespace
http://sap.com/xi/ESM/ERP
Business Context and Use The Utilities Device Management process component is used to manage the master data required for devices in the Utilities sector. When smart meters are used, communication takes place asynchronously between SAP systems and a meter data unification and synchronization (MDUS) system. Using these services, it is possible to create device master data in the MDUS system as soon as the corresponding devices are created in the SAP applications. In addition, the attributes of these devices can be communicated to the MDUS system (for example, the characteristics of assigned registers) and a registration notification can be received from the MDUS system as soon as the smart meter has been registered successfully (with the MDUS). It is also possible to read device specifics and corresponding measurement tasks for synchronous applications, such as portal applications.
Notes on SAP Implementation The target group must run the SAP for Utilities back-end application component in order to use the operations that the Utilities Device Management process component contains.
1.13.7.1 Utilities Device PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 108 of 130
A representation of a virtual or physical device used in Utilities processes.
Technical Data Entity Type
Business Object
Software Component Version
ESM ERP 606
Technical Name
UtilitiesDevice
Object Category
Master Data Object
Business Context and Use A Utilities Device business object can be one of the following: Metering device (meters) Controlling device (ripple control receivers) Data processing device (converters) A device that protects or adjusts (pressure regulators)
Notes on SAP Implementation All service interfaces of this business object can only be used if the Utilities business function set is activated.
1.13.7.1.1 Manage Utilities Device In An interface to perform data for a Utilities device.
Technical Data Entity Type
Service Interface
Category
A2X
Direction
Inbound
Business Context and Use The Manage Utilities Device In service interface contains the inbound operations for the Utilities Device business object. This service enables the synchronous reading of Utilities data. For example, it can be used to display the meter ID in a self-service or in portal applications.
1.13.7.1.1.1 Read Utilities Device Basic Data To read the basic data for a Utilities device.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
UtilitiesDeviceERPBasicDataByIDQueryResponse_In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Web Service Definition (Back End)
ISU_DeviceIDQR
Category
A2X
Direction
inbound
Mode
synchronous
Idempotency
no
Change/Update Behavior
not applicable
P2P Communication Enabled
true
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 109 of 130
Business Context and Use This service performs a query for basic device data for the given device ID.
Features When this operation is executed, the basic data of a device that is related to the provided device ID is retrieved. The device ID is mandatory; if you do not provide one, you will receive an error message and no results will be returned.
Error Handling Typical errors are: Missing ID : The user has not entered an ID. This is needed to read basic device data. Device not found : No device was found for the ID entered.
Message Types UtilitiesDeviceERPBasicDataByIDQueryMessage_sync UtilitiesDeviceERPBasicDataByIDResponseMessage_sync
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated. To make sure this service returns a result, devices should exist in your system. To retrieve full data, a device and a device information record are needed.
Configuration This operation is suitable for the Utilities Industry Solutions sector. The customer must run the IS-U application component to use it. Note that users require authorization to display the device (authorization object E_DEVICE).
Enhancements The ISU_SE_DEVICEIDQR Business Add-In (BAdI) is available for this operation. This BAdI definition is found in enhancement spot ISU_SPOT_SE_DEVICE. This BAdI allows you to create customer-specific logic for inbound and outbound mapping of application data.
1.13.7.1.2 Notify Utilities Device In An interface to receive notifications for Utilities devices.
Technical Data Entity Type
Service Interface
Category
SAP A2A
Direction
inbound
Business Context and Use The service interface Notify Utilities Device In contains the inbound operations for the business object Utilities Device. The service is used to asynchronously inform the SAP ERP system about registering a smart meter in the meter data unification and synchronization (MDUS) system. After the registration process, it is possible to address the registered smart meter directly using SAP applications (for example, meter reading processes).
1.13.7.1.2.1 Change Based on Utilities Device Smart Meter Registered Notification To receive a notification about registered utilities device smart meters.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 110 of 130
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
UtilitiesDeviceERPSmartMeterRegisteredNotification_In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Web Service Definition (Back End)
ISU_DEVICESMREGEDNO
Category
SAP A2A
Direction
inbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use This inbound service operation is used to notify a correct assignment of a device to an advanced metering system (AMS).
Features The following values must be provided: UtilitiesDeviceID UtilitiesAdvancedMeteringSystemID
Error Handling Typical errors are: General mapping error: UtilitiesDeviceID is initial; Message UUID not provided.
Forward Error Handling The Change Based on Utilities Device Smart Meter Registered Notification operation supports Forward Error Handling (FEH), from EHP5 onwards. The following error categories are used: PRE.AUE : Authorization Error CON.POC : Possible conflict PRE.TEE.LPE : Lock promotion error For more information about the individual error categories, see the code list for the global data type LogItemCategoryCode. You can use the global data type catalog (GDT catalog) at https://wiki.sdn.sap.com/wiki/display/GDT/SAP%20Global%20Data%20Type%20Catalog about specific fields.
to search for additional information
In order to activate FEH, implement and activate BAdI ISU_SE_FEH_EXCEPTION: Set parameter XY_IS_FEH_PROCESSING of method IF_EX_ISU_SE_FEH_EXCEPTION~CHECK_FEH_USAGE to 'X' for the related service specified by the parameters X_SERV_BO_NAME = 'DEVICE' and X_SERV_OPERATION = 'DEVICESMREGEDNO' or set the filter values accordingly. Information for the Post Processing Office (PPO): This service belongs to the component CA-SOA-ESM-ERP-MD and process UDEV004.
Message Types Utilities Device ERP Smart Meter Registered Notification
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated.
Configuration This operation is suitable for the Utilities Industry Solutions sector. The customer must run the IS-U application component to use it.
Enhancements The ISU_SE_DEVICESMREGEDNOI_ASYNC Business Add-In (BAdI) is available for this operation. This BAdI definition is found in enhancement spot
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 111 of 130
ISU_SPOT_SE_DEVICE. This BAdI allows you to create customer-specific logic for inbound and outbound mapping of application data. The BAdI can be implemented several times. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
1.13.7.1.2.2 Change Based On Utilities Device Smart Meter Registered Notification As Bulk To receive a notification about registered utilities device smart meter as bulk.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
UtilitiesDeviceERPSmartMeterRegisteredBulkNotification_In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Web Service Definition (Back End)
ISU_SMEVENTCRTBLKRQ
Category
SAP A2A
Direction
inbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use The Change Based on Utilities Device Smart Meter Registered Notification as Bulk inbound service operation is used to notify correct assignments of devices to an advanced metering system (AMS) as a bulk.
Features The following values must be provided on item level: UtilitiesDeviceID UtilitiesAdvancedMeteringSystemID
Processing For information, see Bulk, Bundle, Collection.
Error Handling Forward Error Handling The Change Based on Utilities Device Smart Meter Registered Notification as Bulk service operation supports Forward Error Handling (FEH). The following error categories are used: PRE.AUE : Authorization Error CON.POC : Possible Conflict PRE.TEE.LPE : Lock Promotion Error In order to activate FEH, implement and activate BAdI ISU_SE_FEH_EXCEPTION: Set parameter XY_IS_FEH_PROCESSING of method IF_EX_ISU_SE_FEH_EXCEPTION~CHECK_FEH_USAGE to 'X' for the related service specified by the parameters X_SERV_BO_NAME = 'DEVICE' and X_SERV_OPERATION = 'DEVICESMRGDBLKNO' or set the filter values accordingly. Information for the Post Processing Office (PPO): This service belongs to the component CA-SOA-ESM-ERP-MD and process UDEV008.
Notes on SAP Implementation Configuration This operation is suitable for the Utilities Industry Solutions sector. The customer must run the IS-U application component to use it.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 112 of 130
Enhancements The ISU_SE_DEVICESMRGDBLKNOI_ASYNC Business Add-In (BAdI) is available for this operation. This BAdI definition is found in enhancement spot ISU_SPOT_SE_DEVICE. This BAdI allows you to create a customer-specific logic for inbound and outbound mapping of application data. The BAdI can be implemented several times. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
1.13.7.1.3 Notify Utilities Device Out An interface to send notifications for Utilities devices.
Technical Data Entity Type
Service Interface
Category
SAP A2A
Direction
outbound
Business Context and Use The Notify Utilities Device Out outbound interface groups outbound notification operations for the business object Utilities Device. The service operations are used in order to inform a meter data unification and synchronization (MDUS) system about: The installation of a device in a device location (providing data such as the address of the device location) The allocation of another device to the AMI meter, for example, a breaker or a transformer
1.13.7.1.3.1 Notify of Utilities Device Smart Meter Location To send a notification about a Utilities device smart meter location.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
UtilitiesDeviceERPSmartMeterLocationNotification_Out
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Category
SAP A2A
Direction
outbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use The outbound service operation is used to inform an external system, such as a Meter Data Synchronization and Unification (MDUS) system about the physical location of a device. The interface contains valuable information about: The corresponding address of a device The higher-level connection object
Features The Notify of Utilities Device Smart Meter Location outbound operation is triggered when the installation point assignments within the device have been changed using the following processes: Device installation Device removal Device replacement and reversal Technical installation, removal or replacement The notification message is sent to the advanced metering system (AMS).
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 113 of 130
The following fields need to be provided to trigger this outbound operation: MessageHeader: UUID UtilitiesDeviceID: LocationListCompleteTransmissionIndicator SmartMeter: UtilitiesAdvancedMeteringSystemID
Error Handling General processing and/or mapping errors: UtilitiesDeviceID is initial; Message UUID not provided.
Message Types UtilitiesDeviceERPSmartMeterLocationNotification
Notes on SAP Implementation To use this service operation, the Utilities application component (IS-U) should be implemented and the Utilities business function set must be activated. Note that users need authorization to carry out device installation, removal and replacement in IS-U.
Enhancements The ISU_SE_DEVICESMLOCNOO_ASYN Business Add-In (BAdI) is available for this operation. This BAdI definition is found in enhancement spot ISU_SPOT_SE_DEVICE. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
1.13.7.1.3.2 Notify of Utilities Device Smart Meter Location as Bulk To send a notification about a Utilities device smart meter location as bulk.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
UtilitiesDeviceERPSmartMeterLocationBulkNotification_Out
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Category
SAP A2A
Direction
outbound
Mode
asynchronous
Business Context and Use The Notify of Utilities Device Smart Meter Location as Bulk outbound service operation is used to inform an external system, such as a Meter Data Synchronization and Unification (MDUS) system about the physical location of devices as a bulk. The interface contains valuable information about: The corresponding address of a device The higher-level connection object
Features The Notify of Utilities Device Smart Meter Location as Bulk outbound operation is triggered when the installation point assignments within multiple devices are changed using the following processes: Device installation Device removal Device replacement and reversal Technical installation, removal or replacement The notification message is sent out to the Advanced Metering System (AMS). The following fields need to be provided to trigger this outbound operation: MessageHeader: UUID UtilitiesDeviceID: LocationListCompleteTransmissionIndicator SmartMeter: UtilitiesAdvancedMeteringSystemID
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 114 of 130
Error Handling General processing and/or mapping errors: UtilitiesDeviceID is initial; Message UUID is not provided.
Message Types UtilitiesDeviceERPSmartMeterLocationBulkNotification
Notes on SAP Implementation To use this service operation, the application component Utilities (IS-U) should be implemented. This requires you to activate the Utilities business function set. Note that users need authorization to carry out the device installation, removal and replacement in IS-U.
Enhancements The Business Add-In (BAdI) ISU_SE_DEVICESMLOCBLKNOO_ASYN is available for this operation. This BAdI definition is available in the enhancement spot ISU_SPOT_SE_DEVICE. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
More Information Related Items Utilities Device business object Utilities Device ERP Smart Meter Location Notification message type Meter Data Unification & Synchronization (MDUS) Processing (3rd party) process component
1.13.7.1.3.3 Notify of Utilities Device Smart Meter Relationship To send a notification about a registered Utilities device smart meter.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
UtilitiesDeviceERPSmartMeterRelationshipNotification_Out
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Category
SAP A2A
Direction
outbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use The Notify of Utilities Device Smart Meter Relationship outbound service operation is used to inform an external system, such as a Meter Data Unification and Synchronization (MDUS) system about new or changed device allocations at device level (table EZUG), for example, in the case of new device allocation type locking device/breaker. This might help determine the object of a disconnection/reconnection process (either the AMI meter or the allocated breaker).
Features This outbound operation is triggered when device allocations at device level have been changed using the following processes: Maintain device allocation, reversal technical installation/removal/replacement and technical removal. This notification message is sent to the advanced metering system (AMS). The following fields need to be provided in order to trigger this outbound operation: MessageHeader: UUID UtilitiesDeviceID RelationshipListCompleteTransmissionIndicator
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 115 of 130
SmartMeter: UtilitiesAdvancedMeteringSystemID
Error Handling General processing and/or mapping errors: UtilitiesDeviceID is initial; Message UUID not provided.
Message Types UtilitiesDeviceERPSmartMeterRelationshipNotification
Notes on SAP Implementation To use this service operation, the Utilities application component (IS-U) should be implemented and the Utilities business function set must be activated. Note that users need authorization to maintain the device allocation in IS-U.
Enhancements The ISU_SE_DEVICESMRELSHPNOO_ASYN Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot: ISU_SPOT_SE_DEVICE. This BAdI allows you to create customer-specific logic for outbound mapping of application data. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
1.13.7.1.3.4 Notify of Utilities Device Smart Meter Text as Bulk To send a text notification to a Utilities device smart meter as bulk.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
UtilitiesDeviceERPSmartMeterTextBulkNotification_Out
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Category
SAP A2A
Direction
outbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use The Notify of Utilities Device Smart Meter Text as Bulk outbound service operation allows you to send text messages to any smart meter device that can receive text, such as an in-house display that is connected to a smart meter. The call center or the back office agent can use this new communication path to send messages to the smart meter display. The system can also automatically send dunning notifications to the smart meter display.
Features This outbound operation is used to send text messages to the smart meter. The meter data unification and synchronization (MDUS) system is used to communicate with the smart meter. The notification message is sent to the advanced metering system (AMS) as a mass process. To send the text messages to the smart meter, the following information is needed: UtilitiesDeviceID SmartMeter: Utilities Advanced Metering System ID Text: ID CreationDateTime TextPlainContent: Text For more information, see the UtilisDvceERPSmrtMtrTxtBulkNotifMsg message data type.
Processing
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 116 of 130
For more information, see Bulk, Bundle, Collection.
Message Types Utilities Device ERP Smart Meter Text Bulk Notification
Notes on SAP Implementation Switch Framework To use this service operation, you must activate the Utilities business function set (ISU_UTIL_1).
Configuration Users must have the proper authorization to send messages to devices in the SAP for Utilities back-end system (authorization object E_AMI_MSG).
Enhancements The BAdI for Utilities Device Smart Meter Text Notification as Bulk (ISU_SE_DEVICESMTXTBLKNOO_ASYN) Business Add-In (BAdI) is available for this operation. This BAdI definition is found in enhancement spot ISU_SPOT_SE_DEVICE. This BAdI allows you to create customer-specific logic for outbound mapping of application data. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
1.13.7.1.5 Query Utilities Device In An interface to send a query about the operational state of an AMI device.
Technical Data Entity Type
Service Interface
Category
SAP A2A
Direction
inbound
Business Context and Use The Query Utilities Device In inbound service interface contains a query operation for the Utilities Device business object. The Change Based on Utilities Device Smart Meter Operational State by ID Response service operation provides information regarding the current operational state of an AMI device.
1.13.7.1.4.1 Change Based on Utilities Device Smart Meter Operational State by ID Response To receive the operational state of a utilities device smart meter by ID.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
UtilitiesDeviceERPSmartMeterOperationalStateByIDResponse_In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Web Service Definition (Back End)
ISU_DEVSMOPLSTATEIDRP
Category
SAP A2A
Direction
inbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 117 of 130
P2P Communication Enabled
yes
Business Context and Use This inbound service operation is used to get the status (including dates and times) of a device from an external system, such as a Meter Data Unification and Synchronization (MDUS) system.
Related Operations This service operation interacts with service operation Query Utilities Device Smart Meter Operational State by ID, which requests this status, and is normally used by a back office agent. The status helps to identify if a repair or other activity is needed for a specific device.
Features The inbound service operation Change based on Utilities Device Smart Meter Operational State by ID Response is used to send a response regarding the operational state of the device from the Advanced Metering System (AMS). The following values will be provided in this inbound operation: UtilitiesDeviceID The log, which describes the process status of the query.
Error Handling Typical errors include: General processing and mapping errors like missing log; MessageHeader: UUID or MessageHeader: ReferenceUUID are not provided; Utilities Device ID is initial Missing authorization to save operational state of device (E_AMI_OPST)
Forward Error Handling The Change Based on Utilities Device Smart Meter Operational State by ID Response operation supports Forward Error Handling (FEH). The following error categories are used: PRE.AUE : Authorization Error For more information about the individual error categories, see the code list for the global data type LogItemCategoryCode. Information for the Post Processing Office (PPO): This service belongs to the component CA-SOA-ESM-ERP-MD and process UDEV001.
Message Types Utilities Device ERP Smart Meter Operational State by ID Response
Notes on SAP Implementation To use this service operation, the Utilities application component (IS-U) should be implemented and the Utilities business function set must be activated. Note that users should have an authorization to save the operational state of device (E_AMI_OPST).
Enhancements The ISU_SE_DEVSMOPLSTATEIDQRO_ASYN Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the Enhancement Spot: ISU_SPOT_SE_DEVICE. This BAdI allows customer-specific logic for inbound mapping of application data. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
1.13.7.1.5 Query Utilities Device In An interface to perform data transfer for a Utilities device.
Technical Data Entity Type
Service Interface
Category
A2X
Direction
inbound
Business Context and Use The Query Utilities Device In inbound service interface contains a query operation for the Utilities Device business object.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 118 of 130
1.13.7.1.5.1 Find Utilities Device by Utilities Measurement Task This service performs a query for a Utilities device related to a Utilities measurement task.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
UtilitiesDeviceERPSimpleByUtilitiesMeasurementTaskQueryResponse_In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Web Service Definition (Back End)
ISU_DEVICE001QR
Category
A2X
Direction
inbound
Mode
synchronous
Idempotency
no
Change/Update Behavior
not applicable
P2P Communication Enabled
true
Business Context and Use This inbound operation performs a query for a Utilities device related to a Utilities measurement task.
Features When this operation is executed, the Utilities Device that is related to the provided Utilities measurement task ID is retrieved. A Utilities measurement task ID is mandatory. If you do not provide one, you will receive an error message and no results will be returned.
Error Handling If you do not enter a Utilities measurement task ID, you will receive an error. No Utilities device will be found if you enter an invalid Utilities measurement task ID.
Message Types UtilitiesDeviceERPSimpleByUtilitiesMeasurementTaskQuery_sync UtilitiesDeviceERPSimpleByUtilitiesMeasurementTaskResponse_sync
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated.
Configuration This operation is suitable for the Utilities Industry Solutions sector. It is necessary that the customer runs the IS-U application component in order to use it. Note that users require authorization to display the Utilities device (authorization object E_DEV_CHNG).
Enhancements The ISU_SE_DEVICE001QR Business Add-In (BAdI) is available for this operation. This BAdI definition is found in enhancement spot ISU_SPOT_SE_DEVICE. This BAdI allows you to create customer-specific logic for inbound and outbound mapping of application data.
1.13.7.1.6 Query Utilities Device Out An interface to send a query for a Utilities device.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 119 of 130
Technical Data Entity Type
Service Interface
Category
SAP A2A
Direction
outbound
Business Context and Use The Query Utilities Device Out outbound service interface contains a query operation for the Utilities Device business object. The service operation Query Utilities Device Smart Meter Operational State by ID queries the current operational state of an advanced metering infrastructure (AMI) device.
1.13.7.1.6.1 Query Utilities Device Smart Meter Operational State by ID To read the operational state of a Utilities device smart meter by ID.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
UtilitiesDeviceERPSmartMeterOperationalStateByIDQuery_Out
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Category
SAP A2A
Direction
outbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use This outbound service operation is used to send a query regarding the status of a device to an external system, such as a Meter Data Unification and Synchronization (MDUS) system. Such a process is often triggered by a back office agent.
Related Operations The response to this query is handled in the Change Based on Utilities Device Smart Meter Operational State by ID Response service operation.
Features The Query Utilities Device Smart Meter Operational State by ID outbound service operation sends a query for the operational state of the device based on priority code and source system to the advanced metering system (AMS). The query can be triggered from the display or change modes of the device. The following values need to be provided for this outbound operation: UtilitiesDeviceID UtilitiesAdvancedMeteringSystemID UtilitiesAdvancedMeteringDataOriginTypeCode (source system from which data is requested) Optionally, you can extend the query by providing priority codes.
Error Handling General processing and/or mapping error: UtilitiesInvoiceRequestID is initial.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 120 of 130
UtilitiesDeviceERPSmartMeterOperationalStateByIDQuery
Notes on SAP Implementation To use this service operation, the Utilities application component (IS-U) should be implemented, and the Utilities business function set must be activated. Note that users should have authorization to request the operational state of devices (E_AMI_OPST).
Enhancements The ISU_SE_DEVSMOPLSTATEIDQRO_ASYN Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot ISU_SPOT_SE_DEVICE. This BAdI allows customer-specific logic for outbound mapping of application data. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
1.13.7.1.7 Utilities Device In An interface to receive confirmations for data handling with utilities device.
Technical Data Entity Type
Service Interface
Category
SAP A2A
Direction
inbound
Business Context and Use The service interface Utilities Device In contains the inbound operations for the business object Utilities Device. The services are used asynchronously to confirm the following: Device creation Device change and register creation Register change in the meter data unification and synchronization system (MDUS) The services are used as follow-up actions after SAP ERP communicates smart meter information to the MDUS.
1.13.7.1.7.1 Change Based on Device Smart Meter Register Creation Confirmation as Bulk To receive a confirmation about the creation of utilities device smart meter register as bulk.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
UtilitiesDeviceERPSmartMeterRegisterBulkCreateConfirmation_In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Category
SAP A2A
Direction
inbound
Mode
asynchronous
Idempotency
no
P2P Communication Enabled
no
Business Context and Use The Change Based on Device Smart Meter Register Creation Confirmation as Bulk service operation is used to receive a confirmation about the creation of bulk measurement task assignments in the AMI system.
Features PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 121 of 130
In the bulk confirmation message, each object should provide the following values: UtilitiesDeviceID The log describing the status of the creation of a device in the AMI system
Error Handling The UtilitiesDeviceERPSmartMeterRegisterBulkCreateConfirmation_In operation supports Forward Error Handling (FEH). The following error category is used: PRE.AUE Authorization error For more information about individual error categories, see the code list for the global data type LogItemCategoryCode.
Message Types Utilities Device ERP Smart Meter Register Bulk Create Confirmation
Prerequisites To use this service operation, the Utilities (IS-U) application component should be implemented.
Notes on SAP Implementation Switch Framework To use this service operation, activate the business function set Utilities (ISU_UTIL_1). Configuration This operation is suitable for the Utilities Industry Solutions sector. However, it is only available to customers who are running the IS-U application component. Enhancements The Business Add-In (BAdI) ISU_SE_DEVSMREGCRTBLKRCO_ASYNC is available for this service operation. This BAdI allows you to use a customerspecific logic for the inbound/outbound mapping of application data. This BAdI is available in the enhancement spot ISU_SPOT_SE_DEVICE. The BAdI can be implemented several times. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
More Information The outbound counterpart for this inbound operation is the Request Utilities Device Smart Meter Register Creation as Bulk (UtilitiesDeviceERPSmartMeterRegisterBulkCreateRequest_Out) operation.
1.13.7.1.7.2 Change Based on Utilities Device Smart Meter Cancellation Confirmation as Bulk To receive a confirmation about the cancellation of utilities device smart meter as bulk.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
UtilitiesDeviceERPSmartMeterCancellationBulkConfirmation_In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Web Service Definition (Back End)
ISU_DEVICESMCNCBLKCO
Category
SAP A2A
Direction
inbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use The Change Based on Utilities Device Smart Meter Cancellation Confirmation as Bulk service operation is used to return confirmations regarding the successful deletion of devices (smart meters) from an external system, such as a Master Data Unification and Synchronization (MDUS) system.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 122 of 130
Features This inbound service is used to confirm the cancellation of devices from an advanced metering system (AMS) as a mass process. The following values will be provided for each object (Utilities device) within this inbound operation: MessageHeader: UUID MessageHeader: ReferenceUUID UtilitiesDeviceID The log, which describes the cancellation status of the device. The following values have to be provided for the bulk message: MessageHeader: UUID MessageHeader: ReferenceUUID The log, which describes the status of the cancellation of all devices. The advanced metering system sends a cancellation confirmation of devices.
Error Handling Typical errors include: General processing and mapping errors such as missing log MessageHeader: UUID or MessageHeader: ReferenceUUID are not provided UtilitiesDeviceID is initial, missing authorization to receive the inbound confirmation Information for the Post Processing Office (PPO): This service belongs to the component CA-SOA-ESM-ERP-MD and process UDEV003.
Forward Error Handling The Change Based on Utilities Device Smart Meter Cancellation Confirmation as Bulk operation supports Forward Error Handling (FEH). The following error categories are used: PRE.AUE: Authorization Error For more information about the individual error categories, see the code list for the global data type LogItemCategoryCode.
Message Types Utilities Device ERP Smart Meter Cancellation Bulk Confirmation
Notes on SAP Implementation To use this service operation, the application component Utilities (IS-U) should be implemented and the Utilities business function set must be activated. Users should have an unrestricted 'inbound confirmation' authorization ( EAMI_CO_IN ) in IS-U.
Enhancements The ISU_SE_DEVICESMCNCBLKRCO_ASYN Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot: ISU_SPOT_SE_DEVICE. This BAdI allows customer-specific logic for inbound mapping of application data. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
1.13.7.1.7.4 Change Based on Utilities Device Smart Meter Change Confirmation To receive a confirmation about the change of a utilities device smart meter.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
UtilitiesDeviceERPSmartMeterChangeConfirmation_In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Web Service Definition (Back End)
ISU_DEVICESMCHGCO
Category
SAP A2A
Direction
inbound
Mode
asynchronous
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 123 of 130
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use This inbound service operation is used to confirm the changes of a single device at an AMI site.
Features The following values have to be provided: UtilitiesDeviceID The log describing the status of the creation of a device in the AMI system
Error Handling Typical errors are: General mapping error: UtilitiesDeviceID is initial; Message UUID or Reference_UUID not provided.
Message Types UtilitiesDeviceERPSmartMeterChangeConfirmation
Prerequisites To use this service operation, the Utilities (IS-U) application component should be implemented.
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated.
Configuration This operation is suitable for the Utilities Industry Solutions sector. It is necessary that the customer runs the IS-U application component in order to use it.
Enhancements The ISU_SE_DEVICESMCHGRCO_ASYNC Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot: ISU_SPOT_SE_DEVICE. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data. The BAdI can be implemented several times. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
1.13.7.1.7.4 Change Based on Utilities Device Smart Meter Change Confirmation as Bulk To receive a confirmation about the change of utilities device smart meter as bulk.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
UtilitiesDeviceERPSmartMeterBulkChangeConfirmation_In
Namespace
http://sap.com/xi/IS-U/Global2
Category
SAP A2A
Direction
inbound
Mode
asynchronous
Idempotency
no
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 124 of 130
P2P Communication Enabled
no
Business Context and Use The Change Based on Utilities Device Smart Meter Change Confirmation as Bulk inbound bulk service operation is used to receive a confirmation about the change of a bulk of devices in the AMI system.
Features In the bulk confirmation message, each object should provide the following values: UtilitiesDeviceID The log describing the status of the creation of a device in the AMI system
Error Handling The UtilitiesDeviceERPSmartMeterBulkChangeConfirmation_In operation supports Forward Error Handling (FEH). The following error category is used: PRE.AUE Authorization error For more information about individual error categories, see the code list for the global data type LogItemCategoryCode.
Message Types Utilities Device ERP Smart Meter Bulk Change Confirmation
Prerequisites To use this service operation, the Utilities (IS-U) application component should be implemented.
Notes on SAP Implementation Switch Framework To use this service operation, activate the Utilities business function set (ISU_UTIL_1). Configuration This operation is suitable for the Utilities Industry Solutions sector. However, it is only available to customers who are running the IS-U application component. Enhancements The Business Add-In (BAdI) ISU_SE_DEVICESMCHGBLKRCO_ASYNC is available for this service operation. This BAdI allows you to use a customerspecific logic for the inbound/outbound mapping of application data. This BAdI is available in the enhancement spot ISU_SPOT_SE_DEVICE. The BAdI can be implemented several times. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
More Information The outbound counterpart for this inbound operation is the Request Utilities Device Smart Meter Change as Bulk (UtilitiesDeviceERPSmartMeterBulkChangeRequest_Out) operation.
1.13.7.1.7.6 Change Based on Utilities Device Smart Meter Creation Confirmation To receive a confirmation about the creation of utilities device smart meter.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
UtilitiesDeviceERPSmartMeterCreateConfirmation_In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 125 of 130
Web Service Definition (Back End)
ISU_DEVICESMCRTCO
Category
SAP A2A
Direction
inbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use This inbound service operation is used to confirm the changes of a single device at an AMI site.
Features The following values have to be provided: UtilitiesDeviceID The log describing the status of the creation of a device in the AMI system
Error Handling Typical errors are: General mapping error: UtilitiesDeviceID is initial; Message UUID or Reference_UUID not provided.
Message Types Utilities Device ERP Smart Meter Create Confirmation
Prerequisites To use this service operation, the Utilities (IS-U) application component should be implemented.
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated.
Configuration This operation is suitable for the Utilities Industry Solutions sector. It is necessary that the customer runs the IS-U application component in order to use it.
Enhancements The ISU_SE_DEVICESMCHGRCO_ASYNC Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot: ISU_SPOT_SE_DEVICE. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data. The BAdI can be implemented several times. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
1.13.7.1.7.6 Change Based on Utilities Device Smart Meter Creation Confirmation as Bulk To receive a confirmation about the creation of utilities device smart meter as bulk.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
UtilitiesDeviceERPSmartMeterBulkCreateConfirmation_In
Namespace
http://sap.com/xi/IS-U/Global2
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 126 of 130
Application Component
IS-U
Web Service Definition (Back End)
ISU_DEVICESMCRTBLKCO
Category
SAP A2A
Direction
inbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use This inbound service interface is used to confirm the creation of a bulk of devices at the AMI site.
Features The following values have to be provided : UtilitiesDeviceID The log describing the status of the creation of a device in the AMI system
Error Handling Typical errors are: General mapping error: UtilitiesDeviceID is initial; Message UUID or Reference_UUID not provided.
Message Types Utilities Device ERP Smart Meter Bulk Create Confirmation
Prerequisites To use this service operation, the Utilities (IS-U) application component should be implemented.
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated.
Configuration This operation is suitable for the Utilities Industry Solutions sector. It is necessary that the customer runs the IS-U application component in order to use it.
Enhancements The ISU_SE_DEVICESMCRTBLKRCO_ASYNC Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot: ISU_SPOT_SE_DEVICE. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data. The BAdI can be implemented several times. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
1.13.7.1.7.8 Change Based on Utilities Device Smart Meter Register Change Confirmation To receive a confirmation about the change of a utilities device smart meter register.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
UtilitiesDeviceERPSmartMeterRegisterChangeConfirmation_In
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 127 of 130
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
Web Service Definition (Back End)
ISU_DEVICESMREGCHGCO
Category
SAP A2A
Direction
inbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use This inbound service interface is used to confirm the changes of the measurement task assignments at the AMI site.
Features The following values have to be provided : UtilitiesDeviceID The log describing the status of the creation of a device in the AMI system
Error Handling Typical errors are: General mapping error: UtilitiesDeviceID is initial; Message UUID or Reference_UUID not provided.
Message Types Utilities Device ERP Smart Meter Register Change Confirmation
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated.
Configuration This operation is suitable for the Utilities Industry Solutions sector. The customer must run the IS-U application component to use it.
Enhancements The ISU_SE_DEVICESMREGCHGRCO_ASYNC Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot: ISU_SPOT_SE_DEVICE. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data. The BAdI can be implemented several times. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
1.13.7.1.7.8 Change Based on Utilities Device Smart Meter Register Change Confirmation as Bulk To receive a confirmation about the change of utilities device smart meter register as bulk.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
UtilitiesDeviceERPSmartMeterRegisterBulkChangeConfirmation_In
Namespace
http://sap.com/xi/IS-U/Global2
Category
SAP A2A
Direction
inbound
Mode
asynchronous
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 128 of 130
Idempotency
no
P2P Communication Enabled
no
Business Context and Use The Change Based on Utilities Device Smart Meter Register Change Confirmation as Bulk inbound bulk service operation is used to confirm the changes of bulk measurement task assignments in the AMI system.
Features In the bulk confirmation message, each object should provide the following values: UtilitiesDeviceID The log describing the status of the creation of a device in the AMI system
Error Handling The UtilitiesDeviceERPSmartMeterRegisterBulkChangeConfirmation_In operation supports Forward Error Handling (FEH). The following error category is used: PRE.AUE Authorization error For more information about individual error categories, see the code list for the global data type LogItemCategoryCode.
Message Types Utilities Device ERP Smart Meter Register Bulk Change Confirmation
Prerequisites To use this service operation, the Utilities (IS-U) application component should be implemented.
Notes on SAP Implementation Switch Framework To use this service operation, activate the Utilities business function set (ISU_UTIL_1). Configuration This operation is suitable for the Utilities Industry Solutions sector. However, it is only available to customers who are running the IS-U application component. Enhancements The Business Add-In (BAdI) ISU_SE_DEVSMREGCHGBLKRCO_ASYNC is available for this service operation. This BAdI is available in the enhancement spot ISU_SPOT_SE_DEVICE. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data. The BAdI can be implemented several times. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
More Information The outbound counterpart for this inbound operation is the Request Utilities Device Smart Meter Register Change as Bulk ( UtilitiesDeviceERPSmartMeterRegisterBulkChangeRequest_Out ) operation.
1.13.7.1.7.9 Change Based on Utilities Device Smart Meter Register Creation Confirmation To receive a confirmation about the creation of utilities device smart meter register.
Technical Data Entity Type
Service Operation
Software Component Version
IS-UT 606
Release State
released
Technical Name
UtilitiesDeviceERPSmartMeterRegisterCreateConfirmation_In
Namespace
http://sap.com/xi/IS-U/Global2
Application Component
IS-U
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 129 of 130
Web Service Definition (Back End)
ISU_DEVICESMREGCRTCO
Category
SAP A2A
Direction
inbound
Mode
asynchronous
Idempotency
not applicable
Change/Update Behavior
not applicable
P2P Communication Enabled
yes
Business Context and Use This inbound service operation is used to confirm the creation of the measurement task assignments at the AMI site.
Features The following values have to be provided: UtilitiesDeviceID UtilitiesAdvancedMeteringSystemID The log describing the status of the creation of a device in the AMI system
Error Handling The following general mapping errors are typical: UtilitiesDeviceID is initial; Message UUID or Reference_UUID not provided.
Message Types Utilities Device ERP Smart Meter Register Create Confirmation
Notes on SAP Implementation Switch Framework The Utilities business function set must be activated.
Configuration This operation is suitable for the Utilities Industry Solutions sector. The customer must run the IS-U application component to use it.
Enhancements The ISU_SE_DEVICESMREGCRTRCO_ASYNC Business Add-In (BAdI) is available for this operation. This BAdI definition is found in the enhancement spot: ISU_SPOT_SE_DEVICE. You can use this BAdI to create a customer-specific logic for the inbound and outbound mapping of application data. The BAdI can be implemented several times. The implementations are sorted according to the field layer of a BAdI implementation, for example, SAP standard, partner, or customer.
PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 130 of 130