Working with ABAP Proxies - SAP Help Document

1. Working with ABAP Proxies
PDF download from SAP Help Portal:
http://help.sap.com/saphelp_nw73ehp1/helpdata/en/e6/6d0f3fb35c48fa9fdf5f4e70d9f37d/content.htm
Created on January 07, 2015
The documentation may have changed since you downloaded the PDF. You can always find the latest information on SAP Help Portal.
Note
This PDF document contains the selected topic and its subtopics (max. 150) in the selected structure. Subtopics from other structures are not included.
© 2015 SAP SE or an SAP affiliate company. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose
without the express permission of SAP SE. The information contained herein may be changed without prior notice. Some software products marketed by SAP SE
and its distributors contain proprietary software components of other software vendors. National product specifications may vary. These materials are provided by
SAP SE and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be
liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express
warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty. SAP and other
SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP SE in Germany and other
countries. Please see www.sap.com/corporate-en/legal/copyright/index.epx#trademark for additional trademark information and notices.
Table of content
PUBLIC
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 1 of 10

2. Table of content
1 Working with ABAP Proxies
1.1 Enterprise Services Repository Browser
1.1.1 Object States
1.2 ABAP Proxies - Introduction
1.3 ABAP Proxy Generation - General Procedure
1.3.1 Generating a Provider Proxy
1.3.2 Generating a Consumer Proxy
1.3.3 Working with Service Variants
1.4 Displaying ABAP Proxy Objects
PUBLIC
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 2 of 10

3. 1 Working with ABAP Proxies
Use
Enterprise Services Repository Browser
An overview of how to work with objects in the Enterprise Services Repository.
Object States
ABAP Proxies
Technical background of proxies and how to generate proxies
ABAP Proxies - Introduction
ABAP Proxy Generation - General Procedure
Generating a Provider Proxy
Generating a Consumer Proxy
Displaying ABAP Proxy Objects
Note
You can use Note Assistant (transaction SNOTE ) to import ABAP proxy objects and service definitions.
More information: Note Assistant
More Information
Additional documentation is available from within the ABAP Proxy Generation tool. From transaction SPROXY , choose to open the documentation menu.
The following areas are covered:
Mapping XSD Types to ABAP Types
Proxy Programming Model
XI Messages and Object Links
Generation Tips
1.1 Enterprise Services Repository Browser
Use
The Enterprise Services Repository Browser (ES Repository Browser) is located in the ABAP back-end system, and provides a view on the data in the Enterprise
Services Repository. The ES Repository Browser lets you create, change, check, activate, and delete proxies for all object types that have been modeled in the
Enterprise Services Repository. For example, service interfaces.
Starting the Enterprise Services Repository Browser
1. Call the Object Navigator (transaction code SE80).
2. Choose Enterprise Services Browser .
The software component versions are displayed.
Note
If the Enterprise Services Repository Browser button is not displayed, choose Utilities Settings Workbench (General) and select
Enterprise Services Repository Browser .
Features
The ES Repository Browser displays the structure of the objects in the Enterprise Services Repository.
The top-level nodes of the tree represent the software component versions. When you expand a software component version, the namespaces available for that
software component version are displayed.
You can expand a namespace to display the objects available for that namespace.
Objects of each type are displayed in a separate node. For example, message types, or data types. Expand a node to display all the objects of that type.
Note
To display detailed attributes for an object, double-click that object. The information is displayed in a separate editor (outside of the ES Repository Browser).
When an object is displayed, you can perform the following proxy-specific operations:
Use the Proxy menu to perform the above operations.
The ESR Browser offers the following navigation functions:
Check Checks the consistency of a proxy
Regenerate Regenerates a proxy
This function will only be available if the proxy has already been generated.
Activate Activates a generated proxy
PUBLIC
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 3 of 10

4. Use the Goto menu to perform the above functions.
The ES Repository Browser offers the following display functions:
Use the ES Repository Browser toolbar (above the object tree) to perform the above functions.
Constraints
The ES Repository Browser allows you to change some object attributes. Choose Display <-> Change .
To create objects, work with the Integration Builder.
1.1.1 Object States
Use
The functions available depends on the state of an object. For example, if an object does not have a proxy, only two functions will be possible: Create Proxy and
Display WSDL .
Features
Objects can have the following states:
Context Menu
You can perform operations on proxies by using the context menu. To display the context menu, right-click over an object in the ES Repository Browser.
Double-Click
You can double-click an object to perform an operation on it. The operation triggered depends on the object's state: If a proxy has already been generated for an
object, double-clicking the object displays the proxy. If no proxy exists for an object, when you double-click, you are prompted to create a proxy.
1.2 ABAP Proxies - Introduction
Concept
When Web services are built from platform-independent objects in the Enterprise Services Repository (ES Repository), the ES Repository objects are mapped
to platform-specific proxy objects.
Objects are modeled and stored in the ES Repository, which is the central repository and modeling environment for Web service objects, process and service
definitions.
The ES Repository stores data that is relevant for configuration, installation, and deployment, but the ES Repository does not provide runtime or platform-specific
data.
1.3 ABAP Proxy Generation - General Procedure
Use
This section outlines the general procedure for generating, regenerating, and deleting ABAP proxies. Additional information for generating specific proxy types is
provided in separate sections.
The procedure to generate ABAP proxies is essentially the same for each different type of proxy. There are two main steps:
Select the objects to be called or implemented.
Generate and activate the proxies.
Integration Builder Open the SAP NetWeaver Exchange Infrastructure
Connection Test Tests the connection to the Enterprise Services Repository
Display WSDL Document Displays the WSDL representation of the currently selected proxy
Refresh Refreshes the browser; the objects displayed in the tree are reloaded
Exchange Infrastructure Open the SAP NetWeaver Exchange Infrastructure
Filter Allows you to specify filter criteria to restrict the objects displayed in the tree
Note that the filter settings will be stored for each user.
Search Search the tree to locate specific objects
The proxy object is up-to-date. SAP objects in customer systems are always up-to-date.
The proxy object is orphaned: no corresponding object is available in the Enterprise
Service Repository
No proxy exists for this object
The proxy is obsolete
Proxy inactive After the name of the object, indicates that a proxy has not been activated
PUBLIC
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 4 of 10

5. Prerequisites
To work with ABAP proxies, you need the SAP_XI_DEVELOPER_ABAP role, which is included in the composite role SAP_XI_DEVELOPER. Use the profile
generator (transaction PFCG) to assign roles.
Depending on the proxy type, the following tasks must be done before you generate a proxy:
All objects must be modeled in the ES Repository - or be made available as external WSDL descriptions.
When a proxy that is modeled in the ES Repository is generated for an object that references another object in the same namespace, the proxy for the
referenced object will be generated automatically. For example, a proxy could be generated for a service interface that references a specific data type.
If a referenced object is in a different namespace, you need to generate the proxy for the referenced object separately.
The package structure in the ABAP back-end system must be defined.
The package structure defines where the proxies will be created, where the service provider will be, and how the packages will fit into the overall
application structure.
Prefixes for the ABAP objects can be defined.
It is recommended that you define prefixes as they allow you to ensure that ABAP objects in the back-end system are assigned unique and consistent
names.
Procedure
Generating a Proxy
You need to be working in the system in which you want to generate the proxy. Proxies are generated in the ABAP back-end system, in which the object will
subsequently be provided.
1. Start the Enterprise Services Repository Browser .
Use transaction code SPROXY.
The software component versions are displayed.
2. Expand the nodes of the software component version and the namespace in which you want to generate a proxy.
3. Select an object.
4. To generate the proxy, open the context menu and choose Create proxy .
5. Specify a package and a prefix, and choose Enter .
Based on the prefix that you specify, valid ABAP names are proposed. You can change the proposed names as required.
When the proxy is generated, all the underlying objects will also be generated.
Information about the generated proxy interface, such as the implementing proxy class, and the generated service definition is displayed in the Properties
tab.
The prefix you specified is displayed as part of the ABAP name in the Properties tab and also in the Structure tab.
The External view and Internal view tabs respectively show the operations and methods, and the corresponding ABAP message types and data types.
6. Activate the proxy.
When the proxy is activated, all the underlying objects are automatically activated as well.
Note
The ABAP objects, such as the class, interface, DDIC type, are not created in the system until you activate the proxy.
7. Release the transport request.
Use transaction SE09 to do this.
8. Create a runtime configuration for the proxy.
Note
A runtime configuration is only needed for service interfaces.
1. Start the SAP NetWeaver Administrator .
Use transaction code SOAMANAGER, choose Central Web Service Administration , and log on.
2. Select WS Configuration .
3. Select the service definition that was automatically created during proxy generation.
4. Choose Create Endpoint .
An endpoint contains a single runtime configuration. You can create different endpoints to define different runtime behaviors for the same service
definition.
5. Specify a name for the endpoint.
An endpoint must have a unique name within the Web service entity.
6. Check that the security profile meets your requirements.
To make changes, choose Edit .
7. Save .
The runtime configuration with a port type is now available on the back-end system, and can be integrated into an application.
Generating Proxies with Industry-Specific Enhancements
To activate industry classifications, you need to select an industry when you generate proxies for Web services delivered with an Enhancement Package. Perform
the following steps:
1. Log on to the back-end system in English.
2. Start transaction SM30.
3. Choose the SVW_INDUSTRY view.
4. Select your industries.
Regenerating a Proxy
If an object is changed in the Enterprise Services Repository (ES Repository) after it has been generated, the changes will not automatically be reflected in the
proxy in the ABAP back-end system. If an object in the ES Repository is changed, you will need to regenerate the corresponding proxy manually.
Note
PUBLIC
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 5 of 10

6. In the ES Repository Browser , an icon with a red triangle indicates a version of an ES Repository entity that is different from its proxy version in the ABAP
back-end system.
1. In the Enterprise Services Repository Browser , locate the object whose proxy you want to regenerate.
2. Open the context menu and choose Regenerate proxy
This function will only be available if a proxy has already been generated.
Only the proxy interfaces and classes will be overwritten. The implementing class will remain intact, meaning that the implementation will not be lost.
3. Reactivate the proxy.
From the context menu, choose Activate Proxy .
When the proxy is activated, all the underlying objects will be automatically activated as well.
Deleting a Proxy
1. In the ES Repository Browser , select an object.
2. From the menu, choose Proxy Delete .
Note
By default, the implementing class will not be deleted. Only the generated data will be deleted. To delete the provider class, you must choose to do so
explicitly when the system prompts you.
Result
When proxy objects are activated, one or more of the following ABAP objects are created:
ABAP Dictionary types
ABAP Dictionary types represent the global data types in the ES Repository. The system also generates the data types that will be used as method
parameters.
ABAP interface
An ABAP interface comprises interface types and constants.
ABAP class (proxy class or implementing class) for provider or consumer proxies
The ABAP class of a service provider contains the implementation of the service provider methods, and uses an ABAP interface. A service provider class
has one method for each operation modeled in the ES Repository. For a proxy to be used by an application, the methods will need to be filled with
application coding.
1.3.1 Generating a Provider Proxy
Use
To provide a Web service, a provider proxy needs to be created.
Prerequisites
Provider proxies are created and implemented in the ABAP back-end system, in which the service will be provided.
To generate a provider proxy, the following objects must already have been designed in the Enterprise Services Repository:
Data types
Message types
Service interface and its operations
A provider proxy is based on an inbound service interface.
Procedure
You work with the Enterprise Services Repository Browser in the ABAP back-end system and follow the general procedure for generating proxies.
More information: ABAP Proxy Generation - General Procedure
Perform the following steps:
1. Generate a provider proxy for an inbound service interface.
2. Activate the provider proxy.
When the provider proxy is activated, all the underlying data types and message types will also be activated.
3. Implement the provider proxy.
To implement a provider proxy, you need to add application coding.
4. To be able to call a Web service, you have to create a runtime configuration.
To do this, use the SAP NetWeaver Administrator . Start this tool from the SOA Manager (transaction code SOAMANAGER).
Result
An active provider proxy now exists in the ABAP back-end system, in which the service will be provided.
The provider proxy comprises the following:
An ABAP proxy interface
An implementing class that uses the proxy interface
The implementing class contains the operations that were modeled in the Enterprise Services Repository as methods.
A template for the implementing class is created during proxy generation. A developer must add the appropriate application code to the implementing class. The
ABAP proxy interface is not changed.
PUBLIC
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 6 of 10

7. Example
Below is an example of an implementation of a method that returns an echo of imported data:
1. METHOD ZMY_II_SYNCHRON_INBOUND_INTERF~EXECUTE_SYNCHRONOUS.
2. **** INSERT IMPLEMENTATION HERE ****
3. OUTPUT-RESPONSE_MESSAGE_TYPE-SIMPLE =
4. INPUT-REQUEST_MESSAGE_TYPE-SIMPLE.
5. ENDMETHOD.
1.3.2 Generating a Consumer Proxy
Use
You can generate consumer proxies from objects modeled in the Enterprise Services Repository or from other sources, such as a WSDL document for a
previously generated ABAP provider proxy, or a service definition that is published in a Services Registry or a UDDI-compliant registry.
ABAP consumer proxies are used in an application to call (consume) a Web service. Consumer proxies need only to be generated and can then be used by an
application. Provider proxies need to be generated and implemented in the ABAP back-end system, in which the service will be provided.
ABAP consumer proxies can be generated in any ABAP system, as only the WSDL description is needed. The objects do not first need to be modeled in the
Enterprise Services Repository (ES Repository) . If the objects for a consumer proxy are modeled in the ES Repository, the corresponding ES Repository object
is an outbound service interface.
Prerequisites
A consumer proxy can be generated if any of the following prerequisites are met:
The outbound service interface, which will be used to generate the consumer proxy, is available in the ES Repository.
A WSDL document for a previously generated ABAP provider proxy exists.
A WSDL document from an external service provider is available and its URL is known or is available as a file.
Procedure
Generating a Consumer Proxy Using the Web Service Creation Wizard
1. Start the Repository Browser (transaction code SE80).
2. Open the package for which you want to generate the consumer proxy.
3. From the context menu for the package, choose Create Enterprise Service .
The Web Service creation wizard is started.
4. When you are prompted, select Service Consumer as the object type.
5. Continue.
6. Select the source of the WSDL document.
You can select the following sources:
Enterprise Services Repository
URL/HTTP Destination
Local File
UDDI Registry
Services Registry
7. Continue.
8. Search for or specify a source.
9. Specify a package, a prefix, and a transport request.
10. Continue.
The consumer proxy is generated. During generation, proxies for all the related data types and message types are generated.
The Configuration tab displays the default properties, which are extracted from the WSDL document. These properties determine the settings of a runtime
configuration, which will be generated when the proxy is used.
11. Choose Activate .
The consumer proxy is saved and activated. In addition, the proxy class and the related structures and methods are automatically created and activated.
Generating a Consumer Proxy From the ES Repository
1. Start the Enterprise Services Repository Browser (transaction code SPROXY).
2. Locate the software component version and namespace.
3. Expand the Service Interfaces node.
4. Select the outbound service interface.
5. Open the context menu and choose Create .
The system prompts you to specify a prefix and a transport request.
6. Confirm.
The consumer proxy is generated. During generation, all the related data types and message types in the same namespace are also generated.
The Configuration tab displays the default properties, which are extracted from the WSDL document. These properties determine the settings of a runtime
configuration, which will be generated when the proxy is used.
7. Choose Activate .
The consumer proxy is saved and activated. In addition, the proxy class and the related structures and methods are automatically created and activated.
PUBLIC
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 7 of 10

8. 1.3.3 Working with Service Variants
Use
Service variants provide views on service interfaces. Instead of using all the parameters in a service interface, a service variant allows you to use only
parameters that are needed for a particular business context.
A service variant is based on a service interface and reuses the implementation of that service to create the new service. It is not necessary to create a new
service implementation.
A service variant has its own WSDL and service endpoint, and is published to the Service Registry in the same way as any other standard service.
Service interfaces can often contain many parameters to support several different use cases and to enable a high degree of reuse of services. For this reason, it
can sometimes be difficult to know which parameters in the service interface are relevant for their specific business purpose. By using service variants, you can
simplify the way a service is consumed, for example, by hiding fields or assigning fixed values.
Procedure
Creating a Service Variant
Service variants are created in the ABAP back-end system.
1. Start transaction SVAR.
2. Choose New .
The Wizard for service variants is started.
Note
Alternatively, you can start the Wizard from the context menu in the root node of the package. Choose Create Service Provider Service
Variant
3. Specify a name and a namespace suffix for the new service variant.
The namespace is built by concatenating the namespace prefix and the namespace suffix. The namespace prefix cannot be changed.
4. In the Base Service Interface box, specify the service interface on which to base the new service variant, and its namespace.
Note
The service interface you specify must be released. If the service interface is not released, the system prevents you from continuing.
5. Choose Continue .
6. Specify a package and a transport request.
7. Choose Finish .
The new service variant is now created.
When a service variant is first created, it has the following default field states:
Note
If the base service is changed, for example, if optional fields or operations are added, the default state for the new fields and the new operations is
Hidden without fixed value propagation .
Editing a Service Variant
You can change the following properties of a service variant:
Hide or unhide operations from the base service interface
Hide fields from the base service that are not required for the service variant
Set fixed values for fields
Define optional fields as mandatory
You cannot define mandatory fields as optional.
To change a service variant:
1. Start the proxy editor (transaction code SPROXY).
2. Locate the service variant that you want to change.
Use transaction code SE80, then choose Edit Object , and search for the service variant.
3. Go to the External View tab.
4. Choose Edit .
You can now change the field attributes.
Below is an overview of the field attributes:
Hidden with fixed value propagation for all optional fields
Hidden without fixed value propagation for all optional fields that reference complex types
Visible for all non-optional field and for all operations
Visible Visible applies when none of the hidden states is used.
The behavior of a Visible field is the same as in the base service interface.
Mandatory Only optional fields in the base service interface can be defined as mandatory in the
service variant.
To ensure that the response XML is valid, you should set to mandatory only fields
that are always filled by the base service implementation. If a field in the response
structure is not filled, this may result in an invalid XML response at runtime.
Note
PUBLIC
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 8 of 10

9. More Information
Configuring a Service Provider
1.4 Displaying ABAP Proxy Objects
Use
You can display and edit ABAP proxy objects using the Enterprise Services Repository Browser (transaction code SPROXY).
Process
Below is a summary of the information displayed for an ABAP proxy. Depending on the proxy object, some of the tabs may not always be displayed.
This attribute cannot be used for tables ( maxOccurs > 1).
Hidden Hidden fields are not included in the XSD document.
If mandatory fields are set to hidden, a value is required.
If a XSD default value is assigned to the base service interface, this becomes the
default field value.
If a field is hidden in a service variant, the field is not included in the WSDL
document when it is generated.
There are two different hidden states.
Hidden without fixed value propagation
This state is possible only for elements that reference a complex type in the
original XSD document. The element must be optional or all subelements
must also have the state Hidden without fixed value propagation .
Hidden with fixed value propagation
This state is possible only for leaf elements or if all subelements or attributes
are hidden or optional.
Note
This option cannot be used for tables ( maxOccurs > 1).
All fixed values assigned to the field or to subelements or attributes are
assigned to the ABAP variables at runtime, unless one of the following
conditions is met:
The subfield is part of a table
There is a field which is Hidden without fixed value propagation in the
chain between the Hidden with fixed value propagation super field and
the subfield with a fixed value,
Tab Information Displayed
Properties An overview of attributes that identify the proxy object. These attributes include: type,
name, namespace, the ABAP name, and the user who created the proxy.
Name conflicts Here, you can correct names that were truncated during generation, or names that are
causing a conflict.
This tab is only displayed if name conflicts occurred when the proxy was generated.
Used objects An overview of the objects generated for a proxy. These objects include data elements,
classes, structures, and interfaces.
Double-click a row to display the components of an object.
Internal view Shows the hierarchy of the objects generated. Similar to the Used Objects tab, except
that here the objects are sorted by their use.
Example
The ABAP names for the objects belonging to a service interface:
CO_SPAF_NOTIF_OF_FAILURE_OUT
PAFNOTIFICATION_OF_FAILURE_OUT
OUTPUT PAFNOTIFICATION_OF_FAILURE
NOF_TYPE
MESSAGE_ID ERRORS NOF_PARTY
NOF_SERVICE
External view Shows the object as it is seen by the outside world or as it is modeled in the ES
Repository.
Warnings Even if a proxy was generated successfully, there may be situations when an object type
created in the Integration Builder does not correspond exactly to a particular object type
in the SAP system. In such situations, the object types may be accepted implicitly.
If such situations occur during proxy generation, they are recorded with their appropriate
level of severity.
Configuration Configuration involves specifying the properties for the proxy's runtime environment,
where these properties are known in the development phase. Configuration forms the
basis for the logical port settings. The proposed values come from the WSDL document
used to generate the proxy.
WSDL Displays the WSDL code and the URL for the service provider, service consumer, and
the data types.
PUBLIC
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 9 of 10

10. Note
If the WSDL tab is not displayed, choose Utilities Settings Proxy
Generation , and select Show XML/WSDL Tab in Proxy Editor .
PUBLIC
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 10 of 10