SAP Event Management 9.0
CUSTOMER
Document Version: 1.0 - November 2012
Copyright
© Copyright 2012 SAP AG. All rights reserved.
SAP Library document classification: PUBLIC
No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice.
No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice.
Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors.
Microsoft, Windows, Excel, Outlook, PowerPoint, Silverlight, and Visual Studio are registered trademarks of Microsoft Corporation.
IBM, DB2, DB2 Universal Database, System i, System i5, System p, System p5, System x, System z, System z10, z10, z/VM, z/OS, OS/390, zEnterprise, PowerVM, Power Architecture, Power Systems, POWER7, POWER6+, POWER6, POWER, PowerHA, pureScale, PowerPC, BladeCenter, System Storage, Storwize, XIV, GPFS, HACMP, RETAIN, DB2 Connect, RACF, Redbooks, OS/2, AIX, Intelligent Miner, WebSphere, Tivoli, Informix, and Smarter Planet are trademarks or registered trademarks of IBM Corporation.
Linux is the registered trademark of Linus Torvalds in the United States and other countries.
Adobe, the Adobe logo, Acrobat, PostScript, and Reader are trademarks or registered trademarks of Adobe Systems Incorporated in the United States and other countries.
Oracle and Java are registered trademarks of Oracle and its affiliates.
UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group.
Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems Inc.
HTML, XML, XHTML, and W3C are trademarks or registered trademarks of W3C®, World Wide Web Consortium, Massachusetts Institute of Technology.
Apple, App Store, iBooks, iPad, iPhone, iPhoto, iPod, iTunes, Multi-Touch, Objective-C, Retina, Safari, Siri, and Xcode are trademarks or registered trademarks of Apple Inc.
IOS is a registered trademark of Cisco Systems Inc.
RIM, BlackBerry, BBM, BlackBerry Curve, BlackBerry Bold, BlackBerry Pearl, BlackBerry Torch, BlackBerry Storm, BlackBerry Storm2, BlackBerry PlayBook, and BlackBerry App World are trademarks or registered trademarks of Research in Motion Limited.
Google App Engine, Google Apps, Google Checkout, Google Data API, Google Maps, Google Mobile Ads, Google Mobile Updater, Google Mobile, Google Store, Google Sync, Google Updater, Google Voice, Google Mail, Gmail, YouTube, Dalvik and Android are trademarks or registered trademarks of Google Inc.
INTERMEC is a registered trademark of Intermec Technologies Corporation.
Wi-Fi is a registered trademark of Wi-Fi Alliance.
Bluetooth is a registered trademark of Bluetooth SIG Inc.
Motorola is a registered trademark of Motorola Trademark Holdings LLC.
Computop is a registered trademark of Computop Wirtschaftsinformatik GmbH.
SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP BusinessObjects Explorer, StreamWork, SAP HANA, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and other countries.
Business Objects and the Business Objects logo, BusinessObjects, Crystal Reports, Crystal Decisions, Web Intelligence, Xcelsius, and other Business Objects products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Business Objects Software Ltd. Business Objects is an SAP company.
Sybase and Adaptive Server, iAnywhere, Sybase 365, SQL Anywhere, and other Sybase products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Sybase Inc. Sybase is an SAP company.
Crossgate, m@gic EDDY, B2B 360°, and B2B 360° Services are registered trademarks of Crossgate AG in Germany and other countries. Crossgate is an SAP company.
All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.
These materials are subject to change without notice. These materials are provided by SAP AG 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.
Icons in Body Text
Icon Meaning
Caution Example Note
Recommendation Syntax
Additional icons are used in SAP Library documentation to help you identify different types of information at a glance. For more information, see Help on Help General Information Classes and Information Classes for Business Information Warehouse on the first page of any version of SAP Library.
Typographic Conventions
Type Style Description
Example text Words or characters quoted from the screen. These include field names, screen titles, pushbuttons labels, menu names, menu paths, and menu options.
Cross-references to other documentation.
Example text Emphasized words or phrases in body text, graphic titles, and table titles.
EXAMPLE TEXT Technical names of system objects. These include report names, program names, transaction codes, table names, and key concepts of a programming language when they are surrounded by body text, for example, SELECT and INCLUDE.
Example text Output on the screen. This includes file and directory names and their paths, messages, names of variables and parameters, source text, and names of installation, upgrade and database tools.
Example text Exact user entry. These are words or characters that you enter in the system exactly as they appear in the documentation.
<Example text> Variable user entry. Angle brackets indicate that you replace these words and characters with appropriate entries to make entries in the system.
EXAMPLE TEXT Keys on the keyboard, for example, F2 or ENTER.
Table of Contents
SAP Event Management ... 9
SAP Event Management ... 10
Disclaimer ... 11
SAP Event Management Infrastructure ... 12
Scenario and Solution Settings... 15
Application Integration ... 16
Application Object ... 18
Business Process Type ... 21
Application Object Type... 23
Application Object Type Determination ... 24
Main Object Table and Master Table for Application Objects ... 26
Event in the Application System ... 28
Event Type ... 29
Event Type Determination ... 30
Main Object Table and Master Table for Events ... 32
Application Interface ... 33
Data Transfer from the Application System... 35
Input Help for Defining Parameters ... 39
Event Handler ... 43
Event Handler Type ... 45
Event Handler Set ... 46
Event Handler Set Profile ... 47
Event Consolidation Profile ... 50
Parameters ... 51
Event Handler Extension Table ... 55
Creation of Event Handlers ... 56
Creation of Event Handler Hierarchies ... 61
Event Handler Updating ... 63
Event Handler/Event Handler Set Deactivation/Activation ... 66
Query IDs ... 69
Status Attribute ... 70
Event ... 71
Tracking ID ... 74
Expected Event ... 77
Expected Event Update Via Event Message ... 79
Expected Event Monitor ... 81
Parameter Selection for Expected Event Monitor ... 82
Event Reporting ... 85
Event Message ... 88
Internal Event Code and External Event Code ... 90
Inbound Event Message Processing... 95
Extended Check to and Preprocessing of Event Messages ... 96
Event Message Processing ... 97
Adding Attachments to Event Messages ... 99
Using Event Message Parameters ... 102
Buffered Event Message Processing ... 103
Individual Event Reporting ... 104
Expected Event Reporting ... 105
Reactions to and Actions for Events ... 107
Rule Set ... 112
Rule Condition ... 115
Evaluation in the Rule Set... 116
Rule Set Display ... 120
Simulating Processes in the SAP Application System and SAP EM 122
Connection to the Alert Framework ... 124Direct Access to Detailed Information ... 126
Connection to SAP Business Workflow ... 128
Authorizations and Filters ... 130
Authorizations for Changing Data and Sending Event Messages ... 133
User Interface ... 135
Web Interface ... 136
Modes of Access of the Web Interface ... 138
Logging On to the Web Interface with SSO ... 139
Setting Up A Direct Link User ... 140
Parameter Display (Web Interface) ... 141
Visualization Using Geographical Maps ... 142
Printable Version for Tables on a Web Page ... 143
Use of the Event Handler Hierarchy ... 144
Drilldown in the Web Interface ... 145
Frequently Asked Questions (FAQ) ... 147
General Information ... 148
Navigation to the Web Interface ... 149
Administration Screen ... 150
Search Panel ... 151
Navigation and Sorting of Tables ... 153
Search Result Panel... 154
Sending of Event Messages (Fast Entry) ... 155
Sending of Event Messages for Multiple Tracked Objects or Processes ... 156
Sending of Event Messages ... 157
Settings ... 158
Details of Tracked Objects and Processes ... 159
Monitoring and Evaluating Processes ... 160
Use of the Event Handler List ... 161
Defining Search Criteria ... 162
Use of the Event Handler Overview ... 164
Use of Event Handler Details ... 165
Settings for EH Overview Screen and EH Details Screen ... 168
Application Log ... 169
Reports for Internal Monitoring and Evaluation of Processes ... 170
List of Event Handlers with a Specific Status Attribute ... 172
Last Reported Event List ... 173
Event Handler Set Browser ... 175
Event Message Processing Error List ... 176
Event Message Processing Status List ... 178
Expected Event Overdue List ... 180
Connection to the Computing Center Management System ... 181
Connection to SAP NetWeaver Business Intelligence ... 183
Connection to the SCM Alert Monitor ... 187
Connection to the Document Flow ... 191
Creation and Updating of a Network ... 193
Displaying a Network ... 195
Deletion of a Network ... 197
Logging with Change Documents ... 198
Simulating Processes in the SAP Application System and SAP EM ... 200
Overview of Activities Delivered ... 202
Activity List Structure ... 203
Activity List ... 204
Supply Chain Coordination ... 214
Uses of Supply Chain Event Management ... 217
Use in Procurement ... 218
Use in Manufacturing ... 220
Use in Order Fulfillment ... 222
Use in Asset Management ... 223
Processes in Supply Chain Event Management ... 225
SAP Event Management User ... 230
Administration ... 231
Consistency Checks for SAP EM Customizing ... 232
Processing Control ... 234
Locked Event Handler or Event Handler Set Processing ... 235
Roles for SAP Event Management ... 236
SAP EM Administrator for the Application System ... 237
SAP Event Management User ... 239
Data Archiving ... 241
Archiving with Archive Development Kit (ADK) ... 242
Archiving in SAP Event Management ... 244
Archiving Event Handlers (SCM-EM) ... 246
Archiving Event Messages (SCM-EM) ... 248
Archiving Event Handler Sets (SCM-EM) ... 250
Data Archiving for High Data Volumes ... 252
Archiving Sequence Event Handler and Event Message ... 254
Archiving Sequence Event Message and Event Handler ... 256
Overview of Possible Statuses of an Event Handler ... 258
Archiving Event Handlers (SCM-EM) ... 260
Archiving Event Messages (SCM-EM) ... 262
Variant Settings for Writing (SCM-EM) ... 264
System Installation and Integration ... 266
Connection of SAP Systems... 268
Connection Using SAP Basis Plug-In ... 269
SAP Basis Plug-In ... 270
Connection Using SAP R/3 Plug-In ... 271
Connection of Business Objects ... 272
Business Application Programming Interface in SAP EM ... 275
Connection of External Systems ... 276
Integration with SAP NetWeaver Process Integration ... 277
Enterprise Services for SAP Event Management ... 279
Interfaces in SAP Event Management ... 280
Visibility Processes ... 287
Business Functions in SAP Event Management ... 289
Business Functions in SAP Event Management ... 290
EM, Archiving and Web Interface Improvements ... 291
EM, Visibility Proc. for External Transportation Mgmt System ... 292
Business Functions in SAP Object Event Repository ... 293
OER, Performance-Optimized PTA and Cold Chain ... 294
SAP Event Management Product Information
Product SAP Event Management
Release 9.0
Based On
SAP enhancement package 5 (or higher) for SAP ERP 6.0
SAP enhancement package 1 SAP NetWeaver 7.3
BI Content Release
The BI Content release depends on the type of BI Content you want to use for SAP Event Management, as follows:
If you want to use the new or enhanced BI Content, you can use any of the following:
BI Content 7.06 SP04, 7.36 SP02, 7.46 SP02 BI Content 7.07, 7.37, 7.47
If you do not want to use the new or enhanced BI Content, you can use any of the following:
BI Content 7.04, 7.05, 7.35
The old BI Content is still available in the new or enhanced BI Content..
Documentation
Published November 2012
See SAP Note 1769112 for corrections that are made after the documentation has been delivered.
For information about SAP NetWeaver, cross-application business functions of the SAP Business Suite, and processes and tools for enterprise applications, see the following:
SAP NetWeaver Library [External]
Processes and Tools for Enterprise Applications [External]
SAP Library SAP Business Suite SAP Business Suite – Cross-Business Functions SAP Business Suite – Cross-Application Business Functions
SAP Event Management
SAP Event Management allows companies to manage processes, inventories, assets, and partners by exception rather than monitoring processes that are running smoothly. It is able to recognize and react to unplanned events in the supply chain, to provide a single point of access for collaborative processes, and to measure business partners' performance.
SAP Event Management 9.0 is an add on of SAP Enhancement Package 1 for SAP NetWeaver 7.3. This means that it can be deployed on any application system with the release level 7.31. The restriction to specific deployment options as described for former SAP Event Management releases no longer applies.
Typically SAP Event Management can be used stand alone, in connection with SAP ERP, SAP Transportation Management, or as part of SAP Supply Chain Management Server.
For more information about SAP Event Management, see:
SAP Event Management Infrastructure
Supply Chain Coordination
Disclaimer
If you use SAP Event Management (SAP EM), you must have licensed SAP EM appropriately. For more information, see SAP Note 1122317.
SAP Event Management Infrastructure
Purpose
SAP Event Management allows you to track goods movements and to query the process status of the movement flows, for example, at any time.
SAP Event Management enables you to coordinate your planning and activities with your partners by exchanging information across systems.
You can specify reactions to critical situations. For example, SAP Event Management can send a warning as an e-mail, or trigger processes in other systems.
Introductory Notes
To map your processes that are relevant to supply chain event management (SCEM-relevant) in SAP Event Management, set up the appropriate Customizing.
Integration
SAP Event Management can work in principle with all SAP components and non-SAP components, for example SAP ERP or SAP NetWeaver Business Intelligence.
The scope of integration varies depending on the SAP Event Management release and the individual SAP application component release that you use. For more information about installing and integrating SAP Event Management, see SAP Service Marketplace at
http://service.sap.com/SCM
SAP Supply Chain Management Technology Installation and Upgrade overview.
SAP Event Management is also integrated into the SAP object event repository landscape.
For more information, see SAP Library for SAP solutions for auto-ID and item serialization on SAP Help Portal at
http://help.sap.com
.Features
SAP Event Management can link, update, and evaluate the event messages with the application data from the supply chain network.
It enables you to:
Monitor, measure, and evaluate business processes:
SAP Event Management automatically monitors event that occur and those that have not been reported.
For example:
Goods issue
Purchase order transfer
Production end
Unreported proof of delivery SAP Event Management can automatically transfer data to a data warehouse system. This system uses key figures to create performance data for the quality of execution and notification.
Employ checking processes and notify persons responsible to control events:
SAP Event Management checks the SCEM-relevant objects as soon as the application system saves them.
SAP Event Management can automatically inform the decision maker when action is required in critical situations (for example, automatic re-scheduling of the subsequent process step when a delay has occurred).
Exchange and query information between partners, for example, via e-mail or Internet
Data Transfer to SAP Event Management
SAP Event Management receives data from various external data sources, for example:
Service providers
Global positioning systems
Scanners for wagon and container labels
On-board computers in vehicles
Service suppliers
You can send data in the following formats:
Electronic Data Interchange (EDI)
An EDI converter prepares the EDI data entry to be converted into IDoc format for the SAP Event Management BAPI interface.
IDoc
You can use a separate IDoc for creating event handlers and one for sending event messages.
eXtensible Markup Language (XML)
You make the setting in SAP Event Management to determine whether the SCEM-relevant data is sent directly from a data source to a recipient or whether it is first sent to a service provider. The service provider processes the raw data and sends it to the end recipient in a standard format.
SAP Event Management Interfaces
To receive SCEM-relevant data from those involved in the supply chain and to report the results of event processing, SAP Event Management uses the following interfaces:
An interface to exchange data with the application system
This interface allows SAP Event Management to receive SCEM-relevant data from the application system and to confirm information itself (for example, updating a status or sending overdue event messages).
For connections to an SAP system, SAP delivers an application interface in the application system. For connections to external systems, a standardized interface exists in SAP Event Management.
An interface to connect internal and external systems and devices to SAP Event Management, which send event messages and queries to SAP Event Management.
For example, you can work with a Web browser or with a Personal Digital Assistant (PDA).
An interface to transfer data to a data warehouse system
This interface allows SAP Event Management to send its information to a data warehouse system such as SAP NetWeaver Business Intelligence for evaluation purposes, for example, to check whether standards have been fulfilled and to check the quality of the execution.
The following figure provides an overview of the interfaces and participants with which SAP Event Management communicates:
External Systems Status Query
For example:
• Mobile Devices
• Internet Services
• Business Systems
SAP Component
BAPI, XML, EDI, IDoc
Event Reporter
For example:
• Mobile Devices
• Internet Services
• Technical Systems
SAP Event Management
Application Interface
BAPI EDI/IDoc
XML
SAP NetWeaver Business Intelligence
RFC
See also:
Connection of SAP Systems [Page 268]
Connection of External Systems [Page 276]
Interfaces in SAP Event Management [Page 280]
Scenario and Solution Settings
Use
This function allows you to use scenarios [External] and solutions [External] in the application system and in SAP Event Management (SAP EM). It simplifies and improves your
Customizing procedure in the application system and in SAP EM.
This function hides entries (for example, parameters, event handler type, or activities) that are not relevant to supply chain event management Customizing on the application system side and SAP EM Customizing. On the system interface of both the application system and SAP EM, you only see those entries for the scenario or solution that you work with.
You assign all scenarios that belong to an SAP business area to a solution. A scenario can be assigned to several solutions (one-to-N relationship). A solution can contain various groups of scenarios.
You assign the scenarios production pallet tracking and vehicle order planning to the automotive solution, to specify that these scenarios can be used with the SAP industry solution SAP for Automotive, for example.
Prerequisites
You must be assigned to one or more scenarios that you want to configure, or must assign yourself to them. This assignment restricts the number of entries for Customizing.
If you are not assigned to a scenario, the system displays all Customizing entries.
You assign a user to all existing scenarios by either entering an asterisk (*) or by not entering any value.
For more information about assigning users to scenarios, see the Implementation Guide (IMG) for Event Management Solutions and Scenarios Assign Users to Scenarios.
Example
You assign yourself to a fulfillment visibility process, for example, and only receive parameters for Customizing in the application system and SAP EM that are appropriate to tracking deliveries in an LTL shipment.
Solution
Scenario
Automotive Tracking vehicle orders
Tracking automotive production Supplier replenishment
Production Replenishment within production
Oil and Gas Tracking shipment containers
Application Integration
Purpose
To define the objects and processes that SAP Event Management (SAP EM) is to track, you define the supply chain event management relevance (SCEM relevance) of individual application objects [Page 18] (see also Application Object Type [Page 23]). You also define which data the application system is to transfer to SAP EM for these objects (see also Data Transfer from the Application System [Page 35]). This might be parameters, expected events, or tracking IDs, for example. You report events for an object or process to SAP EM or the system does this. To do this, you define the SCEM relevance of the individual events in the application system (see also Event Type [Page 29]). SAP EM processes the events reported for the relevant event handler(s).
Prerequisites
You have set up Customizing for SAP EM in the application system. You have made the following settings, for example:
To create a physical connection between the application system and SAP EM, you have defined the RFC connection from the application system to SAP EM.
You have set up the logical system between the application system and SAP EM.
You have specified one or more SAP EMs in the application system.
You have specified the business process types [Page 21] in the application system.
You have defined the application object types and event types in the application system.
You have specified the conditions for SCEM relevance in the application system and assigned them to the application object types and event types.
You have defined the function modules for extracting the following:
Parameters
Expected events
Tracking IDs
Query IDs
Event types
Actual events
For all the Customizing settings, see the Implementation Guide (IMG) for the application system under Integration with SAP Components Interface to Event Management.
Process
...
1. You create or change a document in the application system and save it.
Documents or parts of documents are assigned to a business process type in a fixed way. In this way, the business process type is known to the system.
2. The application system executes the following for application objects and events:
Application Objects Events
The system checks its list of application object types that belong to the business process type.
If the system finds application object types that fit, it checks the conditions that have been defined for the respective application object types. These conditions specify the SCEM relevance of an application object.
If it does not find an appropriate application object type, it writes a message to the application log and terminates the transaction.
The system checks its list of event types that belong to the business process type.
If the system finds event types that fit, it checks the conditions that have been defined for the respective event types. These
conditions specify the SCEM relevance of an event.
If it does not find an appropriate event type, it writes a message to the application log and terminates the transaction.
The system notifies SAP EM of each application object for which the condition is fulfilled.
The system notifies SAP EM of each event for which the condition is fulfilled.
3. SAP EM creates an event handler for each application object or updates it (see also Event Handler Creation [Page 56], Event Handler Updating [Page 63]). SAP EM also creates a change document [Page 198] belonging to the event handler, as required.
4. SAP EM sends the event to each event handler in accordance with the assignment of the tracking ID and processes this event (see also Event Message Processing [Page 97]).
5. The extractors specified in the application object type transfer the SCEM-relevant data from the application objects and events to SAP EM.
Result
The system has executed the following:
Checked the SCEM relevance of your document or parts of it
Created one or more event handlers in SAP EM, if possible
Sent the event message belonging to the event to SAP EM, if possible
Application Object
Definition
An object in the application system that maps a complex process or part of a process that is relevant to supply chain event management (SCEM-relevant). You or a system can report events to an application object.
Examples of application objects (AOs):
A procurement process
A container shipment
A leased pallet
Use
You use application objects to specify the objects and processes for which you want to determine supply chain event management relevance (SCEM relevance) (Application Object Type Determination [Page 24]).
The application system sends the SCEM-relevant data from these objects and processes to SAP Event Management [External] (SAP EM).
By determining the application objects, you specify the level of detail of the SCEM-relevant objects and processes. An application object can map not only an entire business object in the application system, but also parts of objects. You can also map cross-business-object processes in conjunction with event types.
You map an entire procurement process. On the other hand, you can also specify that the individual pallets belonging to the supplier are SCEM-relevant objects.
In procurement, you define the purchase order item as the application object type. You define the delivery, invoice, and Financial Accounting as event types.
You have an SCEM-relevant application object, Purchase Order Item. In this case, the corresponding event handler represents the entire follow-on process and not just the purchase order item. This means that you can also send events from other business objects to this event handler.
The following relationships can exist between an object from the application system (business object) and the application object:
A one-to-one relationship (for example, you track an entire truck)
A one-to-N relationship (for example, you track the individual packages in a truck as part of an SCEM-relevant process)
The following figure provides an overview of the relationships between business objects and application objects:
Choice of application object depends on the individual’s point of view
For example, service provider reliability AO = shipment
For example, customer service AO = delivery
Choice of application object depends on the individual’s point of view
For example, service provider reliability AO = shipment
For example, customer service AO = delivery
JPk-5-43
DB JPk-5-43
Wagon 1 = AO1 DB Wagon 2 = AO2
Railroad Shipment 1:1 11
LTL Shipment 1:N
Delivery 2 = AO2 Delivery 1 = AO1
AO Application Object LTL Partial Load
22
LTL Shipment
As a result of determining, changing, or saving an SCEM-relevant application object in the application system, SAP EM creates an event handler [Page 43] that represents this application object (one-to-one relationship).
When you delete an application object in the application system, SAP EM marks the corresponding event handler(s) as deleted, but does not physically delete them from the database.
To track an entire business process and its sub-processes, you can create an event handler for each sub-process. You join these event handlers together in an event handler set [Page 46]. You can track a fulfillment process with its sales order, delivery, and shipment, for example.
The following figure provides an overview of the relationship between the application object and the event handler:
Application System
Event Management
Application Object
BPT (Shipment)
AOT (LTL Delivery)
AO ID
Application System ID
Event Handler Header
GUID
AS
AOT
AO ID
...
BPT
Tracking IDs
Event Handler Type
(in accordance with rule set, profiles, ...) 1:1
Reference Back to Application Object
Unique ID
AS Application System AOT Application Object Type AO ID Application Object ID BPT Business Process Type LTL Partial Load
Business Process Type
Definition
The business process type is a classification of business objects or business processes in the application system for which you want to manage events in SAP Event Management.
Use
You need the business process type to determine the business objects, business processes, and relevant changes (events [Page 28]) that are relevant to supply chain event management (SCEM-relevant) (see also Application Object Type Determination [Page 24], Event Type Determination [Page 30]). You assign a business process type to each business object in the application system.
The system needs the business process type as the main criteria for assigning an application object type to an event handler type. In this way, it can create event handlers [Page 56] and update them. For example, the system needs the business process type to find the
corresponding event handler for incoming event messages. If the business process type, which the application system transfers to SAP Event Management for an SCEM-relevant object, matches any of those saved in the event handler, SAP Event Management processes the event message and updates the event handler.
SAP delivers a selection of business process types with SAP Event Management. You can also define your own business process types in Customizing in the application system and in SAP Event Management.
We recommend that you use a remote call to compare all business process types for processing in SAP Event Management with all those in the application system. The business process type is the only parameter that is found in both systems. SAP Event Management uses this parameter to find the event handler type [Page 45] and creates an event handler if the business process type is the same.
Example
Examples of business process types include:
A sales order
A purchasing transaction
A manufacturing order
A shipment
A delivery
The following figure gives you an example of the link between the business process type and the business object:
Business Object 1:
Purchase Order Business Object 1:
Purchase Order
Business Object:
Sales Order Business Object:
Sales Order
Business Object 2:
Inbound Delivery Business Object 2:
Inbound Delivery
Application System
Business Process Type:
Sales Order
Business Process Type:
Sales Order
Business Object 3:
Shipment
Container
Business Process Type:
Shipment
Business Process Type:
Shipment
In this example, there are four business objects, two of which you have defined as being SCEM-relevant:
You track the business process for processing a sales order. You consider the sales order as a whole. You have assigned the business process type
Sales Order
to it. You track the container that transports the goods. You have assigned the business process type
Shipment
to the shipment, since the handling unit container belongs to the shipment.Application Object Type
Definition
A classification of the application object by defining a condition. You can define multiple application object types for a business process type [Page 21].
Use
You use the application object type to determine the supply chain event management relevance (SCEM relevance) of objects or processes in the application system. You
determine the SCEM relevance by using a condition that you define in the application system and that you assign to an application object type. SAP Event Management (SAP EM) only processes the incoming event messages [Page 88] for objects or processes that fulfill this condition.
You use the application object type to determine the tracking IDs [Page 74] that identify objects. In this way, either you or a system can send internal or external messages to this object and SAP EM can execute the SCEM process.
You can use the application object type to determine the control, info, and system parameters. SAP EM needs these for information and query purposes and to check the SCEM process (see also, Monitoring and Evaluating Processes [External]).
The application system writes the application object type and the application object ID into a status table. Together with the name of the application system, they provide a unique reference between the application object and event handler. The system uses this reference to refer to the business object and its business process type. An n-to-one relationship exists with the business process types in the application system.
Example
Examples of application object types include:
A standard purchase order
A delivery
A handling unit of a particular type on a particular route as part of a shipment (for example, a railroad wagon)
A railroad shipment with dangerous goods
A handling unit as part of a delivery (for example, 20” container on Atlantic route)
A grouped goods shipment to the East coast of the US
Application Object Type Determination
Use
This function uses a classification of the application object based on a condition or function that you define in Customizing.
The system uses the application object type (AOT) together with the application object ID (AO ID) and the name of the application system to define the unique reference between
application object and event handler. The system uses this reference to refer to the business object in the application system. The application system writes the application object type and the application object ID into a status table.
Integration
This function is part of the process for creating event handlers [Page 56].
Prerequisites
You have defined application object types and their supply chain event management relevance (SCEM relevance) in Customizing.
You have assigned the application object type to a business process type [Page 21] in Customizing.
You have specified the condition or function in Customizing whose evaluation is used by the system to determine the application object type and thereby SCEM relevance.
You have specified the main object table, and, if required, the master table, in Customizing for determining the application object type.
Features
By determining the application object type, you can create the relationship between your business processes and the application object type. Multiple application object types can represent a single business process type.
The application interface provides the function with the following information about the application object type:
...
Whether the application object type is active or inactive
You can deactivate the application object type for test purposes. As a result however, the application object type is no longer available.
The condition or function to determine the SCEM relevance of this application object type
The extractors to set up the different parameters from the parameter containers that the system uses with this application object type
The definition of the parameters for the reference and help function in SAP Event Management (SAP EM) that the system uses with this application object type (see Input Help for Defining Parameters [Page 39]).
The SAP EM system that creates the corresponding event handler
How the application interface processes errors (that is, process terminated for the application object to be processed, or for all application objects with this AOT, or the entire operation terminated)
The function provides the application interface with the following information about the application object:
...
...
Whether this is a relevant application object belonging to a business object
The business object tables that represent the application object (main object table and master table [Page 26])
The application object ID
Example
In this example, you can use four application object types to represent your shipment process
SH
. These track not only the packaging (application object type 1UPS package
), but also the means of transportation (application object type 2container
, application object type 3wagon
), and the business process itself (application object type 4LTL shipment
).Application System
UPS Package = AOT1 Container = AOT2 Wagon = AOT3 LTL Shipment = AOT4 1:N
AOT Application Object Type BPT Business Process Type LTL Partial Load
BPT e.g. "SH" for Shipment
Main Object Table and Master Table for Application Objects
Definition
The main object table and, in some cases, the master table specify where the data used to evaluate whether an object is relevant to supply chain event management is located. The main object table represents the application object. The master table represents additional information about the application object.
Use
You need the information from the main object table and the master table to define the condition for determining the application object type [Page 23] in the application system.
You can define tracking IDs [Page 74] in the extractor from the main object table and the master table.
To define the main object table and the master table, you execute the following:
You define which application tables are available for a business process type in the application system (transaction /SAPTRX/ASC0TO).
In the application system you assign a main object table and, if required, a master table from these available application tables to the relevant application object type
(transaction /SAPTRX/ASC0AO). The system displays all the application tables that you have assigned to the relevant business process type in the input help.
Example
The following table provides example uses of main object tables and master tables:
Example Main Object Table Master Table Tracking IDs and Query Options for SAP Event
Management
Assigned Business Process Type
Delivered With
You are tracking one or more deliveries in a shipment.
SHIPMENT_ITEM_N EW
(provides one or more delivery numbers for the shipment)
SHIPMENT_HEA DER_NEW (provides the shipment number)
Several tracking IDs:
Delivery number
Shipment number
ESC_SHIPMT Fulfillment visibility process
You are only tracking a shipment.
SHIPMENT_HEADE R_NEW
(provides the shipment number)
---- A tracking ID:
Shipment number
ESC_SHIPMT Fulfillment visibility process
You are tracking one or more purchase order items in a
purchase order.
PURCHASE_ITEM_
NEW
(provides the purchase order number)
PURCHASE_OR DER_HEADER_
NEW
(provides one or more purchase order items)
Several tracking IDs:
Purchase order number
Purchase order item
ESC_PURORD Procureme nt visibility process
You are tracking an inspection lot.
INSPLOT_NEW (provides the inspection lot number)
---- A tracking ID:
Inspection lot number
EPL_INSPLOT Quality control visibility process
Event in the Application System
Definition
An event is an incident that has occurred.
For examples of events, see Event [Page 71].
Use
You use events in the application system to define whether changes to application objects or processes are relevant to supply chain event management (SCEM-relevant).
The application system sends the SCEM-relevant data for these events to SAP Event Management (SAP EM).
The application system can create multiple events at the same time for a change to an application object. SAP EM can also process multiple events in the event handlers.
You use two different events for a delivery process to report the following for an event handler:
The completeness of a delivery
A change to the delivery date of a delivery item
For information about using events in SAP EM, see Event [Page 71].
Event Type
Definition
A classification of the event [Page 28] by defining a condition. You can define multiple event types for a business process type [Page 21].
Use
You use the event type to determine the supply chain event management relevance (SCEM relevance) of events in the application system. You determine the SCEM relevance by using a condition that you define in the application system and that you assign to an event type.
SAP Event Management only processes these events using the relevant event handlers.
You use the event type to determine the tracking IDs [Page 74] that allow you to identify event handlers in SAP Event Management. In this way, either you or a system can send internal or external messages to the application object and SAP Event Management can execute the SCEM process.
You can use the event type to determine the information that the application system gives to the event handler in SAP Event Management with the message. In this way, SAP Event Management can process the event correctly (see also Event Reporting [Page 85]).
Example
Examples of event types include:
The completion of a delivery
A change to the delivery date of a delivery item
A change to the delivery date of a delivery item if this date differs by more than three days from the original delivery date
The change in the delivery status from Picked to Goods Issue Posted
A reported quantity for a delivery item in goods receipt that deviates from the tolerance limit for the requested quantity of the corresponding purchase order item
Event Type Determination
Use
This function uses a classification of the event based on a condition or function that you define in Customizing.
You enable the application system to use the event type [Page 29] together with the tracking ID to assign the event to the event handler or event handlers in SAP Event Management (SAP EM).
Integration
This function is part of the process for reporting events [Page 85].
Prerequisites
You have defined event types and their supply chain event management relevance (SCEM relevance) in Customizing.
You have assigned the event type to a business process type [Page 21] in Customizing.
You have specified the condition or function in Customizing whose evaluation is used by the application system to determine the event type and thereby SCEM relevance.
You have specified the main object table [Page 32], and, if required, the master table [Page 32], in Customizing for determining the event type.
If you want to define SCEM relevance conditions for document changes, you can also specify the main object table, and, if required, the master table, with the data record before the data is saved.
Features
By determining the event type, you can create the relationship between your business processes and the event type. Multiple event types can represent a business process type.
The application interface provides the function with the following information about the event type:
Whether the event type is active or inactive
You can deactivate the event type for test purposes. As a result however, the application object type is no longer available.
The condition to determine the SCEM relevance of this event type
The extractors for the event data that the application system is to send to the event handlers
The SAP EM system that creates the corresponding event handler
The application interface provides the function with the following information about the application object:
Whether this is a relevant event belonging to a business object
The business object tables that represent the event (main object and master table)
The tracking ID [Page 74]
The tracking ID is part of the event data and is determined by the extractor.
Example
The delivery generates five different events. The application system sends these to the corresponding event handler in SAP EM. The application system determines the event handler using the tracking ID specified in the extractor.
You save the following with the events:
The completion of a delivery
A change to the delivery date of a delivery item
A change to the delivery date of a delivery item if this date differs by more than three days from the original delivery date
The change in the delivery status from Picked to Goods Issue Posted
A reported quantity for a delivery item in goods receipt that deviates from the tolerance limit for the requested quantity of the corresponding purchase order item
Main Object Table and Master Table for Events
Definition
The main object table and the master table specify where the data used to evaluate whether an object is relevant to supply chain event management is located. The main object table represents the event. The master table represents additional information about the event.
Both tables with the data record before the current data save also specify the state that the business object had before its current state.
Use
You need the information from the main object table and the master table to define the condition for determining the event type in the application system.
You can define tracking IDs [Page 74] in the extractor from the main object table and the master table.
Example
For example, you want to track a handling unit only for overseas shipments. To do this you need, on the one hand, information from the main object table (handling unit) to determine the tracking ID. On the other hand, you also need additional information from the shipment (for example, the route) to process events in the event handler, for example, if the route was changed. You define a condition that queries the change in status from Loading Begin to Loaded. The condition uses the main object table with the data record before the current data save to determine the old status Loading Begin and it uses the main object table to
determine the new status Loaded.
Application Interface
Use
You need the application interface to SAP Event Management (SAP EM) to:
Establish the technical connection between the application system and SAP EM
Define the supply chain event management relevance (SCEM relevance) of objects or processes
Establish the data transfer from the application system [Page 35] to SAP EM The following data is transferred from the application system to SAP EM:
Expected events
Parameters
Indicators
The application system contains programs (extractors) that extract data (for example, expected events) from the application system. The system uses the application interface to send this data to SAP EM.
The application interface calls the Business Application Programming Interfaces [Page 275]
(BAPIs) in SAP EM.
Application Interface Customizing
You define the following in Customizing for the application interface to SAP EM:
To define the system configuration:
The RFC connection to SAP EM
Defined the logical system
To define the application interface:
The SAP EM system
The business process types
The used business process types, application object types, and event types that are relevant to supply chain event management
The SAP EM interface functions
The SAP EM relevance conditions
For more information about application interface Customizing, see the Implementation Guide (IMG) for the ERP system under Integration with Other SAP Components Interface to Event Management.
Example
The following figure provides an example of a system landscape for the application interface.
SAP R/3 SAP R/3
SAP Basis Plug-In SAP Basis Plug-In Application Interface Application Interface
BAPI
Customizing
SAP Event Management
SAP Event Management
SAP R/3 Plug-In SAP R/3 Plug-In
The SAP Basis Plug-In [Page 269] that contains the application interface as of SAP Basis Plug-In 2002.1, is an add-on that you can install on a Web Application Server or SAP product with SAP Basis 6.20 or higher.
To communicate with SAP EM, the application interface for SAP EM uses Business Application Programming Interfaces (BAPIs).
The application interface is also part of the SAP R/3 Plug-In for all SAP R/3 releases as of 4.0B.
Data Transfer from the Application System
Purpose
You use this process to:
Specify the parameter containers for SAP Event Management (SAP EM) in the application system (AS) that it fills with data from the table containers
Trigger the transfer of parameter containers to SAP EM
Obtain an input help for mapping parameters [External] in SAP EM
Save events [Page 28] that have occurred for business objects in the application system in the relevant event handlers in SAP EM
Prerequisites
You have completed the following on the application side:
Defined the logical system
Specified the application objects [Page 18] that are relevant to supply chain event management (SCEM-relevant)
Specified the Active mode for the business process type for your SCEM-relevant application objects and events
Assigned function modules to extractors in Customizing for the application system
Assigned the extractors to application object types and event types in Customizing for the application system
Specified the corresponding SAP EM(s) for the application system
The parameters in SAP EM
Process
...
...
1. The process begins when you create or change a document in the application system.
For example, you have completed the following in Customizing for the application system:
Specified extractors
A
andB
for creating the info parameter list.You assign function module
XYZ
to extractorA
and function moduleXY5
to extractorB
. Assigned extractor
A
to application object typeAOT1
and extractorB
to application object typeAOT2
You create an application object
AO1
for application object typeAOT1
You create an event
EV1
for event typeEVT1
.As of PI Basis 2006.1, you can define a Customizing for the extractors and work with table-based extraction.
2. The application system determines the application object types. It automatically creates the parameters (parameter list, milestones, query IDs, and tracking IDs) in the
individual extractors that are assigned to the application object types. The application system also generates the event data that belongs to this event type.
For example, the system creates an info parameter list with the AS info
parameters
P1
andP9
for application objectAO1
. The system also creates the event data for eventEV1
.If you have set the mode of the business process type for your SCEM-relevant application objects to Maintenance, the system continues to create an input help for defining parameters [Page 39].
You use business object keys as a back link from SAP EM to the application system.
A shipment consists of two deliveries and two handling units. It is not sufficient for you to know the main object table with its technical key as a back link to the object in the application system. The back link using the business object key allows you to assign a business object in a unique way.
3. The application system transfers the following data to SAP EM using the definition for parameter mapping and the parameter dictionary that you have defined:
The parameter list
The milestones
The query IDs
The tracking IDs
The event data
You have specified in Customizing for SAP EM that SAP EM is to perform the following mapping for application system
AS1
and application object typeAOT1
: AS info parameter
P1
onto SAP EM info parameterX5
AS info parameter P
9
onto SAP EM info parameter X34. SAP EM transfers the data to the event handler that belongs to the application object.
For example, the SAP EM info parameters
X5
andZ3
and the eventEV1
are transferred to event handlerEH1
.The following figure provides you with a simplified overview of the standard case for transferring application data from the application system to SAP EM:
Create Shipment Document Create Shipment Document
Application System SAP Event Management
Call Application Interface
Determining Application Object Type (AOT) (/SAPTRX/ASC0AO)
Result:
Application object type AOT1 is found.
Setting for “BPT Maintenance” = “Active” = Create/Update EH
Determining Application Object Type (AOT) (/SAPTRX/ASC0AO)
Result:
Application object type AOT1 is found.
Setting for “BPT Maintenance” = “Active”= Create/Update EH
Creating Parameter Containers Using the Individual Extractors
- Control Parameters KP5, KP9
- Info Parameters P1, P9
- Tracking ID 123
- Expected Events
Creating Parameter Containers Using the Individual Extractors
- Control Parameters KP5, KP9 - Info Parameters P1, P9
- Tracking ID 123
- Expected Events
Parameter Mapping
Control Parameters KP5 -> KX5 Control Parameters KP9 -> KX9 Info Parameters P1 -> X5 Info Parameters P9 -> Z3
Tracking ID 123 -> 123
Expected Events .. -> ...
Parameter Mapping
Control Parameters KP5 -> KX5 Control Parameters KP9 -> KX9 Info Parameters P1 -> X5 Info Parameters P9 -> Z3
Tracking ID 123 -> 123
Expected Events .. -> ...
Transfer Parameter Containers Determining Extractors
Extractor A with Function Module XYZ Extractor B with Function Module XY5 Assigning Extractors to AOT Extractor A to AOT1
Extractor B to AOT2 Determining Extractors
Extractor A with Function Module XYZ Extractor B with Function Module XY5 Assigning Extractors to AOT Extractor A to AOT1
Extractor B to AOT2
Create Event Handler EH1
- Control Parameters KX5, KX9
- Info Parameters X5, Z3
- Tracking ID 123
- Expected Events Create Event Handler EH1
- Control Parameters KX5, KX9 - Info Parameters X5, Z3
- Tracking ID 123
- Expected Events
Result
The application system has transferred the following data for an application object and event that you have defined as being SCEM-relevant to SAP EM:
The parameter list
The milestones
The query IDs
The tracking IDs
The business object keys
At the same time the application system has created an event for this application object and has also transferred this data to SAP EM.
SAP EM has written all the data into the relevant event handler (parameter data in accordance with the relevant definition for parameter mapping).
Input Help for Defining Parameters
Purpose
The system provides you with an input help for defining parameters in SAP Event
Management (SAP EM). This gives you a quicker overview of the application system (AS) parameters that you can use for defining parameters in SAP EM.
Prerequisites
You have completed the following on the application side:
Defined the logical system
Specified the application objects that are relevant to supply chain event management (SCEM-relevant)
Specified Maintenance mode for the business process type for your SCEM-relevant application objects
Assigned function modules to extractors in Customizing for the application system
Assigned the extractors to application object types in Customizing for the application system
Specified the corresponding SAP EM(s) for the application system
Specified the parameters [External] in SAP EM
Process Flow
...
...
1. The process begins when you create or change a document (application object of a specific application object type) in the application system.
For example, you have completed the following in Customizing for the application system:
Specified extractor A for creating the info parameter list. You assign extractor
A
to function moduleXYZ
. Assigned extractor
A
to the application object typeAOT1
. Created a shipment document
SHD
that belongs to application object typeAOT1
.The application system creates an application object
AO1
for application object typeAOT1
.2. The application system determines the application object types.
If you have set the mode of the business process type for your SCEM-relevant application objects to Active, the system continues to extract application data [Page 35] from the application system and transfer it to SAP EM.
The application system automatically creates a parameter list. The system stores the parameter list in a Customizing table. SAP EM displays the parameter list to you as an input help when you define parameter mapping. You can specify a description for the parameters.
For example, the system creates an info parameter list with the AS info
parameters
P1
andP9
for application objectAO1
. You specify a description for the info parameters.The following figure shows you the simplified automatic creation of the input help. You can also create the input help manually in the transaction for defining SAP EM interface functions (/SAPTRX/ASC0TF).