use the enhanced web service navigator to test sap enterprise services

Use the Enhanced Web Service Navigator to Test SAP Enterprise Services

Applies to: The Web Services Navigator tool provided in Enhancement Package 1 for SAP NetWeaver 7.1. For more information, visit the SOA Management homepage.

Summary SAP enterprise services are highly integrated Web services combined with business logic and semantics that can be accessed and used repeatedly to support a particular business process. Before you start using an enterprise service, you can test its functionality with the Web Services Navigator tool. The article provides details on how you can use the enhanced features of Web Services Navigator in EHP1 for SAP NetWeaver 7.1 to test multiple services.

Author: Rossen Karaivanov

Company: SAP Labs Bulgaria

Created on: September 15, 2009

Author Bio Rossen Karaivanov has eight years of experience as a technical writer. He works as Information Developer in SAP Labs since 2008. His areas of expertise include SOA management, Services Registry, and Process Integration monitoring.

SAP COMMUNITY NETWORK SDN - sdn.sap.com | BPX - bpx.sap.com | BOC - boc.sap.com © 2009 SAP AG 1

https://www.sdn.sap.com/irj/sdn/soa-management


Table of Contents Introduction .........................................................................................................................................................3

Testing Web services......................................................................................................................................3 Enterprise Services Workplace.......................................................................................................................3

Initial setup..........................................................................................................................................................3 Enable testing Web services on remote systems ...........................................................................................4 Enable connection through proxy ...................................................................................................................5 Obtain access to the tested Web service........................................................................................................5 Choose services for testing.............................................................................................................................6

Testing a Web service ........................................................................................................................................7 Start WS Navigator .........................................................................................................................................7 Select service..................................................................................................................................................8 Select operation ..............................................................................................................................................9 Provide input data ...........................................................................................................................................9 Check the results ..........................................................................................................................................12

Using test scenarios .........................................................................................................................................14 What is a test scenario..................................................................................................................................14 How to create a scenario ..............................................................................................................................14 Running a test scenario ................................................................................................................................15

Advanced setup and operation.........................................................................................................................19 Finding Web services....................................................................................................................................19 Invocation parameters for testing a Web service..........................................................................................21 Test data for Find Customer by Name and Address ....................................................................................22 Managing test scenarios ...............................................................................................................................22

Related Content................................................................................................................................................24 Copyright...........................................................................................................................................................25



Introduction

Testing Web services

Web Services Navigator (WS Navigator) is a Web service testing tool provided with SAP NetWeaver. It allows you to test the functionality of an existing Web service without having a service consuming application. WS Navigator is accessed via Web browser and does not require the installation of additional software.

You can use WS Navigator to test a Web service no matter if the service is deployed on your system, or on a remote Java EE, .NET, or other application server or system. With WS Navigator you can:

• Test an operation of a Web service with test data of your choice.

• Collect and manage the data from individual service tests.

• Test multiple services at once and manage the test results.

This article demonstrates how with WS Navigator you can test full-featured Web services from the Enterprise Services Workplace.

Enterprise Services Workplace

SAP enterprise services are highly integrated Web services combined with business logic and semantics. SAP hosts a public SOA system landscape with preconfigured and ready-to-run enterprise services, known as Enterprise Services Workplace (ES Workplace). It is the central place to view consolidated information about all available enterprise services delivered by SAP. You can use it to discover, evaluate, and implement enterprise services.

The ES Workplace provides an excellent opportunity to perform an in-depth evaluation of individual enterprise service operations. For each service operation you can find technical data, detailed field descriptions, and corresponding WSDL files. You can use this information in WS Navigator to test an operation with test data of your choice. The result shows how the service will respond to a request from a Web service client.

Initial setup When you want to use WS Navigator running on a system in your landscape, you need to make sure that it can connect the Web services you want to test. To ensure that such a connection can be established you need, as a minimum, to configure the WS Navigator white list and system's proxy settings in SAP NetWeaver Administrator as described below.

Regardless of the testing environment you use, you need also to make sure that you have the necessary authentication information to access Web services you want to test.

For more information about setting various WS Navigator options, see Advanced setup and operation on page 19.



Enable testing Web services on remote systems

For security reasons, by default users can use WS Navigator to test only Web services that are deployed on the system where it is running itself. If you want to allow users to test Web services deployed on other systems, you should enter the addresses of these systems in the Web Services Navigator white list as described below:

1. Log in as administrator to SAP NetWeaver Administrator and choose SOA Management > Technical Configuration > SOA Middleware Global Settings.

Alternatively, you can use the quick link /nwa/middleware-settings as follows:

http://<host>:<port>/nwa/middleware-settings

2. Choose WS Navigator.

3. In the Allowed Hosts field, enter the addresses of the hosts that WS Navigator is allowed to access:

• Enter only the domain and the subdomains. You do not need to enter the protocol part of the address (for example, http://)

• You can use wildcards when adding IP addresses and domains, for example: *.example.org

• When entering several hosts, make sure the addresses are separated, for example with the vertical bar (|), or with comma (,).



To test Web services from ES Workplace, you have to enter erp.esworkplace.sap.com as shown above.

4. Choose Save.

Enable connection through proxy

When the system on which Web Services Navigator runs connects to external networks using an HTTP proxy, you should set the proxy configuration settings.

1. Log in as administrator to SAP NetWeaver Administrator and choose SOA Management > Technical Configuration > SOA Middleware Global Settings.

Alternatively, you can use the quick link /nwa/middleware-settings as follows:

http://<host>:<port>/nwa/middleware-settings

2. Choose HTTP Proxy and enter the proxy details.

3. Choose Save.

Obtain access to the tested Web service

A Web service can have several endpoints on several systems, with different security settings for each endpoint. When you test a Web service, you can choose at which of service's endpoints you want to run the test. In WS Navigator, you can test only service endpoints that require basic HTTP authentication (user name and password) or no authentication. In case the selected endpoint requires basic HTTP authentication, you need to know the login data in advance.

For testing enterprise services provided on ES Workplace you need to have user account for it. You can apply for free registration for ES Workplace at http://www.sdn.sap.com/irj/sdn/soareg. The user name and password you obtain will be necessary for the testing of enterprise services as shown in this article. For more information, see Access the Enterprise Services Workplace Systems (requires SDN registration).

Similarly, when you want to test a Web service provided on AS Java, AS ABAP, or other system, you need to have user account on the system to use the Web service.


http://www.sdn.sap.com/irj/sdn/soareg

https://www.sdn.sap.com/irj/sdn/explore-es?rid=/webcontent/uuid/49e5ebd6-0d01-0010-86bd-e86cfe03c9a2


Choose services for testing

This article shows how to test Web services available on ES Workplace. In the examples in the article, you can see one or more of the service operations of the Query Customer In inbound service interface, like Find Customer by Name and Address and Find Customer Simple By ID.

For each of these service operations, you can get the URL of the WSDL file using the WSDL (back-end) link on the corresponding page. You can use this URL to tell WS Navigator which service you want to test. Each of these URLs starts with:

http://erp.esworkplace.sap.com/

This is the reason for which you need to add the erp.esworkplace.sap.com host to the white list as described in




Enable testing Web services on remote systems above.

Note: You can also use WS Navigator available on ES Workplace. When you are on a page on ES Workplace describing a particular enterprise service, simply choose the Test with WS Navigator link. WS Navigator opens in a new browser window with the tested service is selected, so that you only need to provide the test data.

TesTesting a Web service with WS Navigator is straightforward, there are only four steps. During the first three steps you choose a service, select the operation you want to test, and provide input data as necessary. On the fourth step, WS Navigator uses this information to connect to the service as a client, receives the response, and displays it for you.

Start WS Navigator

You can test a service from ES Workplace using WS Navigator running on a system in your landscape, for example EHP1 for SAP NetWeaver Composition Environment 7.1. The examples throughout this article show how to set and use WS Navigator in such situation. To access WS Navigator this way, open a Web browser and enter an address in the http://[host]:[port]/wsnavigator form, for example:

http://myserver.example.com:50000/wsnavigator

Then enter your user name and password if required.

ting a Web service

Note: You should have a user account for the system where WS Navigator runs. This user account should be assigned to the Administrators group or the Administrator role, or should have the user management engine WSNavigator administrator action.

In case you don't have WS Navigator available in your landscape or you cannot use it to access services on the Internet, you can use the WS Navigator provided on ES Workplace. It is available at http://sr.esworkplace.sap.com/wsnavigator. You will need to use your user name and password for ES Workplace. As mentioned above, you can also invoke it for a particular enterprise service by choosing the Test with WS Navigator link on the documentation page for this service on ES Workplace.



Select service

irst step of the testing process is to choose a service you want to test. Make sure you have selected L as search type an

The fWSD d enter the URL of the WSDL for the Find Customer by Name and Address inbound service operation:

http://erp.esworkplace.sap.com/sap/bc/srt/xip/sap/ecc_customer002qr?sap-client=800&wsdl=1.1&mode=sap_wsdl

Choose Next to continue. In case this is your first attempt to test a service form ES Workplace during this session, you should provide your user name and password for ES Workplace.



Note: When you know the details of an enterprise service and want to see how it performs, entering the URL of the WSDL is the simplest way to start the testing. You can also choose a service to test from a list of available services on a selected provider system, or from Services Registry. For more information, see the Finding Web services section on page 19.

Select operation

The second step of the testing process is to choose the operation you want to test. Simply select an operation from the list and choose Next.

Pro

Th

vide input data

e third step of the testing process is to provide input data for the test.

Note: In case the selected operation does not need input data, or you want to perform a test without providing test data, simply proceed to the final step to see the result of the test.

Yo owing ways:

• To enter test data manually, deselect the Skip checkbox next to a parameter and enter a value.

u can provide test data in one of the foll



• To import a test data file saved from a previous test of the operation, choose Import > Test Data.

When you test the Find Customer by Name and Address enterprise service, you can import the test data using the file provided below. For more information, see the



Test data for Find Customer by Name and Address section on page 22.

enario section on page 14.

• To import test data from an existing test scenario file, choose Import > Test Scenario.

Scenario files can be obtained when testing many services at once. For more information, see the How tocreate a sc

You can use a scenario test data file that contains data both for the currently selected operation and for other services and operations. The importing tool selects only the test data for the currently tested service and operation.

When finished with the test data, choose Next to proceed to the actual testing and see the test results.

If you have not provided values for some of the mandatory input parameters, WS Navigator notifies you to fill in or correct the required fields.



Check the results

WS Navigator sends the test data to the Web service in the same way as a Web service client connects to a Web service. The Web service usually provides a response, which WS Navigator displays. Now you can do the following:

• Compare the test data and results, and analyze the inbound and outbound SOAP messages and HTTP logs.

• To save the SOAP message that was sent to

the Input Parameters screen area and choos the service for future tests, select the XML Content tab in e Download as File.



You can later use the saved file with the Import > Test Data option described above.

• To repeat the test with the current test data, choose Invoke.

You might want to do this when you want to test another endpoint of the same Web service operation with the same test data. For more information about selecting endpoints, see the



Invocation parameters for testing a Web service section on page 21.

• To add the information about the test you just finished to a scenario, choose Add to Test Scenario.

The next section of the article describes what a test scenario is and how you can use it.

Using test scenarios The previous section of the article described how to test one of the operations of a Web service. If you do this manually for each operation of all services you want to test, you will need a lot of time. And if you want to perform all these tests with different sets of input data, you will need even more time.

WS Navigator simplifies such tasks with the help of test scenarios.

What is a test scenario

In short, a test scenario is a set of data you use to test many Web service operations at once. A test scenario contains the following details for each of the tested Web service operations:

• The name and WSDL of the tested service.

• The name of the tested operation.

• Input test data for the operation.

• Expected results from the operation test.

• List of operation parameters for which WS Navigator does not check if the response s identical to the

perations described in a scenario, you just need to import this scenario in WS Navigator

Fo scenarios section on page 22.

iexpected result.

In addition, the scenario keeps information about the order in which the operations should be tested.

Once you create a test scenario you can save it for later usage. The next time you want to test one or more of the Web service oand run the test.

r more information about editing scenarios see the Managing test

How to create a scenario

You can create scenarios by simply choosing the Add to Test Scenario button at the end of a test of a Web service operation.

This way you can add each test you want, for example:



• Tests of the same Web service operation with different input data.

• Tests of all operations of a Web service.

• Test of operations of several Web services.

• Any combination of the above.

One thing you should consider when you create a scenario is that all Web services tested with it must be available on one system. You should specify the location of this system before you execute the scenario, as explained in the next section of the article. In case there are several systems that provide all the services described in the scenario, you can choose which system should be used for the test by simply entering the location of this system at the start of the test. This allows you to reuse the scenario.

After you add a few tests to your new scenario, you can see how it looks by choosing Test Scenario > Execution.

To save your scenario, go to Test Scenario > Editor and choose Export.

Running a test scenario

You can start testing Web services with a scenario in one of the following ways:

• Create a scenario as described in the previous section of the article.

• Load an existing scenario file. To do this, go to Test Scenario > Editor and choose Import test Data.



Now you have the scenario loaded in WS Navigator:

To run the scenario, go to Test Scenario > Execution and choose the Invoke button.

In case this is your first attempt run this scenario during this session, you should provide information about the location of the system where the tested Web services are provided. This information should be in one of the following forms:

• In case only operations of one Web service are tested, the URL of the WSIL service of the system

For systems running SAP NetWeaver, this URL is usually in the http://[host]:[port]/inspection.wsil/ form.

• In case only operations of one Web service are tested, the URL of the WSDL for this service

You should also provide a user name and password to access the services on this system.

Note: You can access this form before starting the test by choosing the Change Services Access button. This way you can enter the URL of the WSIL service of whichever system that provides the Web services described in the scenario.



Using this information, WS Navigator accesses the pthe order in which they are presented in the test scen

rovider system and starts to send service requests in ario. When the testing finishes, it analyzes the received

responses and displays a summary of the results:

For each of the tested operations, you can see the status of the test.

In most situations, you could expect that the test completes successfully and the status should be OK. Sometimes you may need to test Web service operations that return different result each time you invoke them. For example, each time you create a sales order the service can return a unique ID for the newly created order. If the scenario you loaded in WS Navigator includes such a service, the data it contains about the expected result will always differ from the returned result. As you can see in the example above, WS Navigator provides a proper status in such situations. You can select the operation to see all service response details:

There are two approaches in such a situation:

• You can choose Add to exclude list to prevent WS Navigator from checking the correctness of the

accepted as correct. As a result, running the scenario again completes successfully - the status is OK, and you see a notification about the response parameter value:

corresponding response parameter. The system modifies the test scenario so that the value of the response parameter should always be



• Y se as an expected test result in the

tou can choose Accept Results to save the current service respon

est scenario:

that by adding a response parametNote er to the exclude list or by accepting the new result as correct you

change the scenario. If you want to keep this change you should save the scenario to a file.

n test enterprise services. Below

which service you want to test. As described in the

Advanced setup and operation The previous chapters of the article provided basic examples on how you cayou can find details about advanced features of WS Navigator you might find useful when you need to test multiple Web services in a real-world environment.

Finding Web services

With WS Navigator you have several options to specify



Select service section on page 8, providing the URL of the WSDL for the Web service is the fastest way to start the testing. In case you do not have information about this URL, you can choose what to test from a listof Web services available on a selected provider system, or from the list of services registered in ServicRegistry.

es

• To find a service deployed on a provider system or logical destination, you can choose the corresponding search type, select a provider system, and then select a service from the list.

To test services running on a particular host, you should configure the connectivity details for this provider system in SAP NetWeaver Administrator > SOA Management > Technical Configuration > System Connections. These settings should be done on the system where WS Navigator runs.

• To find a service published in Services Registry, choose the corresponding search type and use the search options.

You should configure the system where WS Navigator runs which Services Registry should be used. For more information, see Configuring the Services Registry.



Invocation parameters for testing a Web service

To test a Web service operation, you need to specify the tested endpoint, authentication data, and timeout for the test. This information is referred to as invocation parameters. You can provide it before or afterrunning the test, by choosing the Invocation Parameters button.

When you select the Web service you want to test, WS Navigator loads the corresponding WSDL document.

provider This document contains information about the endpoints of this Web service configured on thesystem. You can choose one of these endpoints to run the test.

If you know that the Web same service is running and has endpoints on a different system, you can choose to test one of these endpoints. To do this, you need to provide the location of the endpoint you want to test. This way you can repeat the existing tests on a different system without needing to choose operation and provide input data again.

When the selected endpoint requires basic HTTP authentication, you can enter the login data in advance. You can also set the timeout for the test.



Test data for Find Customer by Name and Address

(like Notepad) and save it as a file with xml extension, for example

/envelope/"

irstLineName> SecondLineName>

Copy the following code to a text editortest.xml. You can then use this file to load test data for the Find Customer by Name and Address enterprise service on ES Workplace as described in the Provide input data section on page 9.

<?xml version="1.0" encoding="utf-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soapxmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Body> <yq1:CustomerSimpleByNameAndAddressQuery_sync xmlns:yq1="http://sap.com/xi/SAPGlobal20/Global"> <CustomerSimpleSelectionByNameAndAddress> <CustomerName> <FirstLineName>Becker</F <SecondLineName>Boris</ </CustomerName> </CustomerSimpleSelectionByNameAndAddress> </yq1:CustomerSimpleByNameAndAddressQuery_sync> </SOAP-ENV:Body> </SOAP-ENV:Envelope>

Note: The test data provided here is valid as of September 2009. Since SAP may modify, supplement or otherwise change the enterprise services information on ES Workplace without prior written notice, this data might become unusable in the future.

Managing test scenarios

When you want to remove a scenario step or to change the order in which WS Navigator executes thescenario steps, you can go to Test Scenario > Editor and edit the scenario.

You can also use the scenario editor when you want to change the way a particular scenario step is run. For each scenario step you select in the editor, you can do one or more of the following:

• Choose Input Parameters to modify the test data sent to the service. You can add or remove single parameters or arrays of parameters as necessary.

• Choose Expected Result Data to modify the data that WS Navigator uses to check if the service

response is correct. Similarly to the input parameters, you can add or remove response parameters and modify their values.



• Choose Exclude List to modify the set of response parameters for which WS Navigator does not check if the response is identical to the expected result. The list contains operation parameters added after test scenario execution using Add to exclude list. You can add or remove entries to the exclude list as necessary.



9BRelated Content HUTesting Web Services in the Web Services Navigator UH – official documentation of WS Navigator on help.sap.com. It provides extensive information about all advanced features for testing Web services.

HUHow to test service definition using SOAMANAGERUH – blog entry on SDN.

HUSAP MII - How to Browse, Configure, Test, and Consume an Enterprise ServiceUH – article with examples on SDN.

HULatest News From ES WorkplaceUH – blog on SDN that provides information about new features of ES Workplace implemented in the beginning of May 2009.

HUDevelop Composite Applications with SAP NetWeaver Composition Environment 7.1 UH - an article that shows how to develop a composite application from scratch.

HUGenerate and Test your SAP NetWeaver BRM Rules Web ServiceUH – blog entry on SDN.

HUService-Oriented Architecture forums UH – forums on SDN where you can find a lot of information about Web services and SOA.

HUWeb Services-based ConnectivityUH – home page on SDN for information about Web services.

For more information, visit the HUSOA Management homepageUH.



10BCopyright © Copyright 2009 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, Excel, Outlook, and PowerPoint 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, System z9, z10, z9, iSeries, pSeries, xSeries, zSeries, eServer, z/VM, z/OS, i5/OS, S/390, OS/390, OS/400, AS/400, S/390 Parallel Enterprise Server, PowerVM, Power Architecture, POWER6+, POWER6, POWER5+, POWER5, POWER, OpenPower, PowerPC, BatchPipes, BladeCenter, System Storage, GPFS, HACMP, RETAIN, DB2 Connect, RACF, Redbooks, OS/2, Parallel Sysplex, MVS/ESA, AIX, Intelligent Miner, WebSphere, Netfinity, Tivoli and Informix are trademarks or registered trademarks of IBM Corporation.

Linux is the registered trademark of Linus Torvalds in the U.S. and other countries.

Adobe, the Adobe logo, Acrobat, PostScript, and Reader are either trademarks or registered trademarks of Adobe Systems Incorporated 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, Massachusetts Institute of Technology.

Java is a registered trademark of Sun Microsystems, Inc.

JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape.

SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP Business ByDesign, 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 S.A. in the United States and in other countries. Business Objects 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.

use the enhanced web service navigator to test sap enterprise services

Documents