Service Operations

 SAP AG 2004, Service Operations, Michael Seubert / 2 Table of Content Business Content Governance Business Object Model Service Operations Definition & Understanding Service Operation Signature: Derivation by Hierarchization Service Operation Signature: Derivation by Hierarchization – Detailed Steps Service Operation Definition Framework Business Object Documentation Global Data Types (GDT)

Service Operation Definition & Understanding

 SAP AG 2004, Service Operations, Michael Seubert / 4 Service Operation: View Concept View A service operation represents a semantical view onto an object to perform a business functionality The view defines the operation signature Service Operation

 SAP AG 2004, Service Operations, Michael Seubert / 5 From Outbound to Inbound: One Single View e.g. PurchaseOrdere.g. SalesOrder Interface OUT Interface IN OP1 OP2 HugoRequest Object emulates view The same view is used in inbound operation, message type, and outbound operation Defining Object

 SAP AG 2004, Service Operations, Michael Seubert / 6 Compound Service Operation Operation defined at BO level Implemented via BO core service operations From PIL Taxonomy: compound service A service that is designed from a process point of view. It is not necessarily bound to a specific part of a business object and wraps multiple elementary services. In Business Process Platform, compound services for business objects are implemented by invoking several core services or reuse service components. In the application platform, compound services are implemented by process agents that invoke several core services or reuse service components.

 SAP AG 2004, Service Operations, Michael Seubert / 7 Core Service Operation Operation defined at BO node level Offers access to and manipulation of a single BO node Different kinds of operations (Create, Update, Delete, Query, RetrieveByAssociation, …) From PIL Taxonomy: core service A service of a business object node according to a standardized set of interface patterns. The set of all core services of a business object node completely encapsulates and controls the state and behavior of all node instances. Examples Create, update, delete, or query services for sales order item or sales order header

Service Operations Service Operation Signature: Derivation by Hierarchization

 SAP AG 2004, Service Operations, Michael Seubert / 9 Different Operations: How to Achieve Consistency ? Cross - operation consistency ?

 SAP AG 2004, Service Operations, Michael Seubert / 10 Consistent Business Documents derived from Object Model Environment „ Leading Business Object“ Object Model Business Document ~ Object Component Implementation Object

 SAP AG 2004, Service Operations, Michael Seubert / 11 One Single View Based on a Central Object Model Business Document ~ Object Component 2 3 Source ObjectTargetObject Outbound Operation Inbound Operation „ Defining Business Object of central Object Model Document based Integration

 SAP AG 2004, Service Operations, Michael Seubert / 12 Business Document Variants derived from Object Model Object Model Environment „Leading Object“ Business Document Object

 SAP AG 2004, Service Operations, Michael Seubert / 13 Business Object – Business Documents - Messages Business Object Model B3B3 BusinessDocument Objects Not overlapping Net structure overlapping hierarchical BusinessDocument Message: Message Header: Attachment: BusinessDocument-Object: BusDocMsg-Header: MessageID

 SAP AG 2004, Service Operations, Michael Seubert / 14 Hierarchization: Business Document Object 2 A C B C1C1 C2C2 B3B3 A1A1 A2A2 A3A3 B4B4 X1X1 X2X2 X3X3 X4X4 X 1 : 1 Directed relationships 1 : 1 Case 1: The whole object A is of relevance Case 2: In C the reverse path from C 2 to C 1 is of relevance Case 3: The composite B 3 of object B and the dependent composite B 4 is of relevance. The composite B 1 is not of relevance in this case. 1 : 1 Different cases for involving referenced business objects

 SAP AG 2004, Service Operations, Michael Seubert / 15 Business Document Object: dependency level Arrangement according to the degree of the dependency level 3 A C B C1C1 C2C2 B3B3 A1A1 A2A2 A3A3 B4B4 X1X1 X2X2 X3X3 X4X4 X 1 : 1 Directed relationships 1 : 1 Level

 SAP AG 2004, Service Operations, Michael Seubert / 16 Hierarchization: the resulting Business Document Object 4 C1C1 C2C2 B3B3 A1A1 A2A2 A3A3 B4B4 X1X1 X2X2 X3X3 X4X4 X Directed relationships Level C1C1 C2C2 B3B3 A1A1 A2A2 A3A3 B4B4 X1X1 X2X2 X3X3 X4X4 X Directed relationships Level XML Schema Business Document Object

Service Operations Service Operation Signature: Derivation by Hierarchization – Detailed Steps

 SAP AG 2004, Service Operations, Michael Seubert / 18 (i) Selection of leading object Selection of leading object Specify the leading BO The leading object can be  the source object,  the target object, or  a third one. Selection of relevant nodes Determine the parts of the BO required for the view. The parts must be connected to the root node via a valid path along the hierarchy Selection of more independent objects Determine more independent objects (object parts, respectively) referenced by the leading object which are the relevant for the service. A relationship must exist between the leading object and the more independent objects.

 SAP AG 2004, Service Operations, Michael Seubert / 19 (ii) Hierarchization – Adoption Adoption of object nodes Adopt the relevant nodes of the leading object structurally identical to the message type structure. Adoption of nodes from more independent objects Invert the relationships to the relevant more independent objects or object parts, respectively.

 SAP AG 2004, Service Operations, Michael Seubert / 20 (ii) Hierarchization – Adjustment Derived Business Document Object: Leading Object with Previously “Referenced” Objects Linearization A BO node containing certain TypeCodes is represented in the MT structure by explicit entities (an entity for each value of the TypeCode). These entities contain the name of the TypeCode as prefix.  Example: Party nodes, BTD Reference nodes, Product node Reduction of structure Check all 1:1 cardinalities existing in the MT structure. Combine entities if  They are semantically equivalent or  One of the entities carries no elements or  An entity solely results from an n:m assignment in the BO

 SAP AG 2004, Service Operations, Michael Seubert / 21 (ii) Hierarchization – Resulting BDO Business Document Object with Its Parts (Arranged According to Dependency Level) and Corresponding Representation in the XML Structure Object Model and Derived Business Document Object (Multiple Overlapping Views)

 SAP AG 2004, Service Operations, Michael Seubert / 22 (iii) Completion / Wrapping Add information regarding the transmission of the BDO CompleteTransmissionIndicator, ActionCodes, message category Message Header Add the standardized message header to the MT structure Typing Type the MT structure with data types. (1) Elements are typed by GDTs according to the business objects. (2) Aggregated levels are typed with message type specific data types (Intermediate Data Types). Their name is built according to the path in the message type structure. (3) The whole message type structure is typed by an MDT. Its name is built according to the root entity with suffix „Message“.

 SAP AG 2004, Service Operations, Michael Seubert / 23 (iii) Completion / Wrapping Message Category Specify the suited message category for the message type. according to the suited transaction communication pattern.

 SAP AG 2004, Service Operations, Michael Seubert / 24 Result: Business Document More details on the derivation rules can be found here: ServiceSignatureDerivation_by_Hierarchization_EN.doc ServiceSignatureDerivation_by_Hierarchization_DE.doc Corporate Portal > Application Platform > Engineering > Cont.Gov. > Guidelines & Documents

 SAP AG 2004, Service Operations, Michael Seubert / 25 MessageDataType: Data Model

Service Operation Service Operation Definition Framework

 SAP AG 2004, Service Operations, Michael Seubert / 27 The Service Operation Definition Framework (SODF) All operations are built according to the SODF, which is based on the interface paradigm*. The Business Document Interface Type Categories Message Type Categories Operation Templates and Packages Data Types Naming Rules Documentation template Integrity based on Business Object Model *see Corporate Portal  Application Platform  Engineering  Cont.Gov.  Guidelines & Documents

 SAP AG 2004, Service Operations, Michael Seubert / 28 Interface Paradigm Interfaces & Operations (and Messages) Correspond to business-related documents Are built according to international standards and norms Are driven outside-in Have a uniform structure via templates Have uniform typing throughout SAP via normed data types

 SAP AG 2004, Service Operations, Michael Seubert / 29 Outside–In: eBusiness Standards RosettaNet, xCBL, HR-XML, PIDX (Petroleum Industry Data Exchange), CIDX (Chemical Industry Data Exchange), UCCnet (Retail), PapiNet (Paper Industry), Odette (Automotive Industry) Organisations and Initiatives UN/CEFACT ebXML und UBL SAP (“inside”) speaks the language of the Business World (“outside”).

 SAP AG 2004, Service Operations, Michael Seubert / 30 Interface Category: SAP B2B Interface Focus: compatibility with international standardized interfaces 1. represent business-related documents. 2. designed in accordance with the rules of international standards 3. contain exclusively business-related information 4. information has been adopted by international committees for this interface and is mappable to at least to one e-business standard RosettaNet, xCBL, HR-XML, CIDX, PIDX, UCCnet, PapiNet, Odette 5. support the core functionality of a component. 6. usage does not presuppose bilateral agreements between the business partners. Rules for usage are public and binding e.g. stored in ebXML Registry / Repository or SAP Collaboration Directory 7. are used mainly in business processes between enterprises

 SAP AG 2004, Service Operations, Michael Seubert / 31 Interface Category: SAP A2A Interface Focus: complete usage of the functionality of the application 1. represent business-related documents 2. designed in accordance with the rules of international standards 3. contain exclusively business-related information 4. Can contain additional information not (yet) covered by B2B standards. This information is motivated by SAP applications (Content is transparent, not SAP-specifically encoded) 5. allow complete usage of the SAP application functionality from a purely business-related point of view 6. Rules for optimal coupling and usage of the applications are agreed bilaterally according to need 7. are used mainly for communication  between SAP components, and  between SAP components and applications from 3 rd party suppliers. Enterprise boundaries do not play a role here

 SAP AG 2004, Service Operations, Michael Seubert / 32 Message Type Categories: Overview A message type category is a general business-related dividing up of messages according to the criteria obligation of the message, that is,  assurances of the sender connected with sending the message or  the sender’s expectations of the recipient Existence of predecessor messages Expectation of follow-up messages For the time being, these are the categories “Information”, “Notification”, “Query”, “Response”, “Request”, and “Confirmation” Communication is always driven by the sender The meaning of the message categories is specified from the sender’s point of view.

 SAP AG 2004, Service Operations, Michael Seubert / 33 Transaction Communication Pattern A transaction communication pattern describes an atomic dialog between a sender and a recipient. In the context of the pattern, the recipient’s reply is optional four transaction communication patterns are used for SAP messages, with associated message type categories Note: In a concrete scenario, the pattern can be characterized more precisely. Example: Dependent on the scenario, a confirmation for a request can be mandatory.

 SAP AG 2004, Service Operations, Michael Seubert / 34 Message Type Categories (1) Information Information is a message regarding a state or a subject matter. No reply is expected for information Notification A notification is a notice or message tailored with respect to a service No reply is expected for a notification Query A query is an inquiry to which a reply is expected. By a query the sender does not enter into a commitment. The inquiry is without obligation for the sender. Response A response is a reply to an inquiry By a response the sender, in general, does not enter into commitment. The reply, in general, is without obligation for the sender

 SAP AG 2004, Service Operations, Michael Seubert / 35 Message Type Categories (2) Request A request is a requisition or requirement with obligation. Confirmation A confirmation is a reply with obligation, which follows a request.

 SAP AG 2004, Service Operations, Michael Seubert / 36 Uniform Building Blocks: Packages... Order Seller Party BuyerParty... ManufacturerParty Party The packages group semantically associated information

 SAP AG 2004, Service Operations, Michael Seubert / 37 Uniform Structure via Operation Templates Top-Down: Identical build-up structure for all operation signatures The simple usage of the interfaces results from their uniform composition

 SAP AG 2004, Service Operations, Michael Seubert / 38 MessageDataType: Data Model

 SAP AG 2004, Service Operations, Michael Seubert / 39 SAP Business Objects and Service Operations based on GDTs and CCTS Core Data Types B2B / A2A – Interface / Service Operation Message Type B2B / A2A – Message Data Type Node Data Type Global Data Type CCTS Core Data Type W3C Data Type PurchaseOrdering_In PurchaseOrdering_Out PurchaseOrderRequest PurchaseOrderChangeRequest PurchaseOrderMessage InvoiceMessage PurchaseOrderPartyElements PurchaseOrderDeliveryTermsElements Deliery Terms Address ProductID float string Business Semantics n1n1 n1n1 n1n1 n1n1 Usage specific no Business Semantics global Business Object Node Business Object 1n1n 1111 PurchaseOrderParty PurchaseOrderDeliveryTerms PurchaseOrder n n Data Typing Semantic Structure Indicator Measure Numeric Quantity Text Amount Binary Object Code DateTime Identifier

 SAP AG 2004, Service Operations, Michael Seubert / 40 SAP-wide Uniform Typing via Normed Data Types Bottom-up: uniform typing A Message Interface is a hierarchical structure. The leaves of the tree are Generic Data Types The same subject matter is always described by the same data type

 SAP AG 2004, Service Operations, Michael Seubert / 41 Global Data Type: Example „Dangerous Goods“ (1) DangerousGoods are substances or objects that cause danger to public safety, to the life and health of people and animals or to the safety of things 1 3

 SAP AG 2004, Service Operations, Michael Seubert / 42 Global Data Type: Example „Dangerous Goods“ (2)

 SAP AG 2004, Service Operations, Michael Seubert / 43 Naming Rules According to ISO Datatype Value Domain Property Qualifier Representation Object Class Class Qualifier

 SAP AG 2004, Service Operations, Michael Seubert / 44 MessageDataType: Data Model and Element Structure