how to model and design enterprise services in esr710

7/22/2019 How to model and design enterprise services in ESR710

http://slidepdf.com/reader/full/how-to-model-and-design-enterprise-services-in-esr710 1/27

How to model and designenterprise services in ESR710

Appl ies to:

NetWeaver ESR710, Any business suite components running on WebAS 6.40 and above

Summary

This tutorial will show you how to model and design enterprise service interfaces in SAP Enterprise ServicesRepository (ESR) 710.

Author : Canyang (kevin) Liu

Company: National Competency Center, SAP Americas

Created on: 12 December 2007

Author Bio

Kevin Liu is a principal enterprise architect with the National Competency Center of SAPAmericas. Kevin’s current focus is on SAP Enterprise Architecture Framework andEnterprise SOA, covering the whole life cycle of enterprise service modeling, design,development, and composition. Before NCC, Kevin was a NetWeaver technology architectwith SAP Labs Palo Alto since 2001 with a strong focus on industry standards for Webservices technologies. He represented SAP in various standard organizations includingW3C, WS-I, Rosettanet and helped the adoption of these standards in SAP NetWeaver.

SAP DEVELOPER NETWORK | sdn.sap.com BUSINESS PROCESS EXPERT COMMUNITY | bpx.sap.com

©2008 SAP AG 1



How to model and design enterprise services in ESR710

Table of Contents

Keywords ............................................................................................................................................................3

Target Audience .................................................................................................................................................3

Prerequisites.......................................................................................................................................................3

System required for this exercise.......................................................................................................................3

Overview of business case and SAP service modeling methodology................................................................4

Create a software component in System Landscape Directory(SLD)................................................................6

Start the Integration Builder............................................................................................................................6

Create software component in SLD................................................................................................................6

Import software component to ESR....................................................................................................................8

Model the service interface in the ESR ..............................................................................................................9

Create Business Objects, Service Interface, and Operations.......................................................................10

Define the service interface in the ESR............................................................................................................12

Assign namespace to the service interface and operations .........................................................................12

Define attributes for the service operations ..................................................................................................13

Create Message types and data types .........................................................................................................16

Using SAP Global Data Type........................................................................................................................19

Activate all the changes................................................................................................................................23

Display the ESR definitions in the Enterprise Services Browser in SAP Backend...........................................25

Related Content................................................................................................................................................26

Copyright...........................................................................................................................................................27


©2008 SAP AG 2




Keywords

ESR, Enterprise Services Repository, PI, Integration Builder, Enterprise services modeling, consumer model,provider model, enterprise service interface model, enterprise service interface definition, Global Data Type(GDT), service operation, message type, data type.

Target Audience

Technical consultants, Architects, Developers, IT Managers, business process experts and businessanalysts who already have exposure to SOA concepts, and would like to learn how to do services modelingand design with SAP ESR

Prerequisites

- Basic understanding of SOA concepts, especially the top-down approach and related consumerand provider model methodology for identifying and developing enterprise services

- Working knowledge of SAP NetWeaver and Business Suite

System required for this exercise

To complete this tutorial, you need access to an Enterprise Service Repository version 710. Currently, theESR is available to SAP customers and partner as part of SAP NetWeaver Process Integration (PI) 710 or

Composition Environment (CE) 710 SR3.

NOTE: Throughout this tutorial, the X8A system is used which is only accessible to SAP employee. If you areusing a different system to do the exercise, you need to use the appropriate hostname, port number toaccess the Integration Builder come with that system. Depends on the service pack levels of your system,some of the screens and task steps in your system may be slightly different from what’s shown in thistutorial, but the overall process and key activities should be similar if not same.


©2008 SAP AG 3




Overview of business case and SAP service modeling methodology

In the example business case, a large retailer chain is experiencing slow sales of certain products. Themanagement team realizes that their price is not competitive, and would like to adjust their prices based onmarket condition. To achieve this goal, the following steps have to happen:

- Select the product and competitors. A sales person who is familiar with the market conditionneeds to put together a list of products and the major competitors for each of the products.

- Collect and maintain competitor prices. Some body needs to go to competitor stores collect the

data and enter it into their system.- Analyze the competitor data. A manager needs to look at the competitor pricing, and determine

more competitive while profitable prices for the stores.

To come up with the best pricing, they need an application that can be rolled out to thousands of their stores

to support store managers do analysis of their competitors pricing, and adjust their price accordingly. Afterchecking with IT, they realized that there is no application in place for such requirements yet, so they startout to build it up.

Now they need to figure out what exactly need to happen to implement this process. In a SAP recommendedeSOA based top-down development approach, the development of a new application typically goes throughthe following phases:

• Business Requirement• Build Consumer Model• Build Provider Model

• Search Existing Services & funtions• Identify Missing Services

• Model and design missing services• Implement Missing Services• Implement Composite Application

NOTE: The focus of this tutorial is modeling and defining service interfaces, so we will not go too deep on theoverall methodology (if interested, please contact the author for more information about related trainings), orthe composition process (I will write a separate paper to cover service composition for this example businesscase).

Based on the requirement they have identified, the first step is to build a consumer model which is basically ahigh level break down of required functionalities to support each key steps of the process. The consumermodel only focuses on requirements, and is independent of any application that maybe used forimplementation. Once a consumer model is in place, the next step is to develop a so called “Provider model”where each of the functionality is mapped to a business application module. The module can be an ABAPfunctional module, an SAP pre-delivered enterprise services, a third party Web service, an in-houseapplication, or whatever system that can support such functional requirement. For SAP pre-deliveredenterprise services, SAP provides an online service catalog called Enterprise Services Workplace(https://www.sdn.sap.com/irj/sdn/explore-es ) where users can browser the enterprise services and finddetail information about what each of services can do, where they are deployed in SAP landscape, and howto use them.


©2008 SAP AG 4

https://www.sdn.sap.com/irj/sdn/explore-es

https://www.sdn.sap.com/irj/sdn/explore-es




In this tutorial we only focus on service interface modeling and design, so we assume the consumer modeland provider model is complete. As shown in the following diagram, the retailer has figured out that most of the required functions can be supported by services delivered from SAP. For example, the consumer model(left panel of the diagram) indicates that it needs to find relevant competitors for a product which needs priceadjustment. The provider model (the right panel) indicates that the enterprise service Find Business Partnerby Basic Data provides this function. This services is part of the process component “Business Partner DataManagement” which is implemented as part of mySAP ERP, so on the so forth. As a result of the consumerand provider model, they have identified that one piece of required function “Update Sales Price Information”is not supported by SAP or any other application yet (as shown by the fire icon in the diagram). It’s a gap that

needs to be implemented as a Service.

Now let’s move on to show you how this particular service can be modeled and designed in the SAPEnterprise Services Repository.


©2008 SAP AG 5




Create a software component in System Landscape Directory(SLD)

Start the Integration Builder

Either from x8A, using transaction SXMB_IFR, or directly from an IE browserhttp://pwdf2655.wdf.sap.corp:55000/rep/start/index.jsp

Prerequisite: you need J ava Web Start installed to use the Integration Builder, see the following page fordetail http://pwdf2655.wdf.sap.corp:55000/rep/start/webstart_installation.jsp

Create software component in SLD

Since this is a custom development, you would not want to mix it with SAP standard components, and needto define a software component and a namespace for your service.

In a typical development scenario, a software component should have already been defined for you by your

project lead before you start the service development. For our example, since we want to show the processfrom the scratch, we need to create the software component first.

Logon to SLD from the integration builder home page, click on the “Products” link in the software catalogarea.

You will be presented a few screens to enter the product and software component info. Follow the wizard tocreate the component and save the changes. Eventually, by search the component you just created, you

should see a screen like the below.


©2008 SAP AG 6

http://pwdf2655.wdf.sap.corp:55000/rep/start/index.jsp

http://pwdf2655.wdf.sap.corp:55000/rep/start/webstart_installation.jsp

http://pwdf2655.wdf.sap.corp:55000/rep/start/webstart_installation.jsp

http://pwdf2655.wdf.sap.corp:55000/rep/start/index.jsp




Import sof tware component to ESR

Now logon to the Integration Repository by clicking on the Link in the homepage

To import the software component from SLD to ESR, the procedure changed from PI70 to PI 710. In PI 70,the menu tools has an item for transfer SLD objects to the ESR. In PI710, use menu item Objects/New…,then follow the wizard as in the following screen.

Click on the refresh button in the ESR Tree list to see the newly imported software component

After the software component is imported, use the same wizard to create a new namespace as a container of your new objects. (Models will be stored under the separate Modeling section)


©2008 SAP AG 8




Model the service interface in the ESR

In the Design Objects tree, select the software component you would like to develop with. ChooseModeling/Models folder. Create a new folder if you would like, then right click on the folder and chooseNew… to get to the following screen. To see all the relevant ARIS symbols for process component definition,choose model type “SAP ProComp Model”


©2008 SAP AG 9




Create Business Objects, Service Interface, and Operations

Once the ARIS modeling area appears, create a business object and a service interface simply by drag anddrop the corresponding symbols into the modeling pane.


©2008 SAP AG 10




Creating the operations is a bit tricky. Select the BO symbol first, then right click on the operation symbol,and choose the second option in the pop-up (operation is realized by BO) as in the below screen

Enter a name for the new operation. Repeat the process until all intended operations are added.


©2008 SAP AG 11




Define the service interface in the ESR

Assign namespace to the service inter face and operat ions

Once the model is completed, now we need to assign a namespace to the new constructs.

Right click on the service interface or operation, choose create assignment.

After save, it returns to the modeling pane, and there should be a small circle appear to the lower-left cornerof the service interface symbol. Double click on it to create the Interface object under the selectednamespace.


©2008 SAP AG 12




Define attributes for the service operations

When prompted to create a new object for the selected interface, proceed with yes. It creates a defaultoperation with the same name as the interface as shown below. Save it so we can add more operationslater.

Now repeat the process for the new operations. Change the attributes for each operation as appropriate(stateless, synchronous, etc)

Since we will add our own interface, the default interface will not be needed and we will delete it. Save thechanges.


©2008 SAP AG 13




The final results of the interface model should be something like the following


©2008 SAP AG 14




The final results of the interface definition should be something like the following


©2008 SAP AG 15




Create Message types and data types

The operations created so far do not have any message types assigned to them yet. To start, enter thenames for the request, response and fault messages following the appropriate naming convention, andassign them to the right name space.

To actually define a message type, right click on a message, and select new. It brings up the message typedefinition page. Enter a name for the data type used by the message type as shown in the following screen. The typical naming convention is to add a prefix _sync or async to the end of the message name.


©2008 SAP AG 16




Now right click on the value of the “data type used” field, and choose “New” from the pop-up menu. It bringsup the Data type definition page.


©2008 SAP AG 17




Using SAP Global Data Type

We would like to use a few global data types in our data type definition for the request and responsemessages of our UpdateSalesPriceInformation operation.In particular, we need a business partner ID, aproduct ID, and a Price for the request, and a system status code for the response.

SAP GDTs are defined in the SAPGlobal software component under the namespacehttp://sap.com/xi/SAPGlobal/GDT as shown below.

Find the GDTs you need, right click on it and choose copy object… to get the following pop-up window.Specify the target component and namespace as shown below, then click on “Copy”. If asked to overwrite anexisting data type, say Overwrite. It may show a process log window, just close it and wait for the GDTs to be

copied. Trick: Specify the Software Component Version before the Namespace.


©2008 SAP AG 19

http://sap.com/xi/SAPGlobal/GDT

http://sap.com/xi/SAPGlobal/GDT




A new page will be opened for each copied data type. Save and close these windows. Now we have all theGDTs in our own namespace ready for our use. Go back to the data type definition screen, and use theGDTs to define our data types.

You may need to play with the tool a bit to get yourself familiar with the use of the different icons. Overall it’sstraight forward. After you are done, the data type for the request message should be something like


©2008 SAP AG 20




Go to the message definition page, and save the change now. It should pick up the data type definition andlooks as below

Repeat the same process for the Response message. The response message should be something like


©2008 SAP AG 21




Now for the Fault message. J ust use the default standard fault data type.

Now save everything, if not yet.


©2008 SAP AG 22




Activate all t he changes

Have a look at the list of our design objects now, you will notice that many of them has a red check besidethem. The red checks indicate that these objects are not activated yet.


©2008 SAP AG 23




Switch to the Change Lists tab, select your change list, right click and choose “activate…”

In the pop-up, select all the objects you would like to activate, and click the “Activate” button to complete the

activation process.

Now we have completed the modeling and definition of the ManageSalesPriceInformation enterprise serviceinterface.


©2008 SAP AG 24




Display the ESR definitions in the Enterprise Services Browser in SAP Backend

You can verify that all the service interface definition is activated in the Backend. Logon to X8A, usetransaction SE80 or SPROXY to go to the “Enterprise Services Broswer”. Choose your component andnamespace, the service we just defined in the ESR should be list as below.

Tip: If the Enterprise Service Browser is not displayed, check it using the Utilities/Settings menu, and checkthe browser item.

Now it’s ready to generate a proxy and implement the service definition in the backend.


©2008 SAP AG 25




Related Content

To cover the whole life cycle of an enterprise services, the author plans to write a series of papers to coverthe following areas (Link will be provided here as soon as the papers are complete)

• How to develop enterprise services in ABAP

• How to compose enterprise services in Composition Environment

• How to enable SSO with enterprise services


©2008 SAP AG 26




Copyright

©Copyright 2007 SAP AG. 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 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, Outlook, and P owerPoint are registered trademarks of Microsoft Corporation.

IBM, DB2, DB2 Universal Database, OS/2, Parallel Sysplex, MVS/ESA, AIX, S/390, AS/400, OS/390, OS/400, iSeries, pSeries, xSeries,

zSeries, System i, System i5, System p, System p5, System x, System z, System z9, z/OS, AFP, Intelligent Miner, WebSphere,Netfinity, Tivoli, Informix, i5/OS, POWER, POWER5, POWER5+, OpenPower and PowerPC are trademarks or registered trademarks of IBM Corporation.

Adobe, the Adobe logo, Acrobat, PostScript, and Reader are either trademarks or registered trademarks of Adobe SystemsIncorporated in the United States and/or other countries.

Oracle is a registered trademark of Oracle Corporation.

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, MassachusettsInstitute of Technology.

J ava is a registered trademark of Sun Microsystems, Inc.

J avaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented byNetscape.

MaxDB is a trademark of MySQL AB, Sweden.

SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as theirrespective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. Allother product and service names mentioned are the trademarks of their respective companies. Data contained in this document servesinformational 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 ("SAPGroup") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors oromissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in theexpress warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting anadditional warranty.

These materials are provided “as is” without a warranty of any kind, either express or implied, including but not limited to, the impliedwarranties of merchantability, fitness for a particular purpose, or non-infringement.

SAP shall not be liable for damages of any kind including without limitation direct, special, indirect, or consequential damages that mayresult from the use of these materials.

SAP does not warrant the accuracy or completeness of the information, text, graphics, links or other items contained within thesematerials. SAP has no control over the information that you may access through the use of hot links contained in these materials anddoes not endorse your use of third party web pages nor provide any warranty whatsoever relating to third party web pages.

Any software coding and/or code lines/strings (“Code”) included in this documentation are only examples and are not intended to beused in a productive system environment. The Code is only intended better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errorsor damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or grossly negligent.

how to model and design enterprise services in esr710

Documents