Académique Documents
Professionnel Documents
Culture Documents
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.
The selected structure has more than 150 subtopics. This download contains only the first 150 subtopics. You can manually download the missing
subtopics.
2016 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 95
Table of content
1 SAP Gateway
1.1 What's New in SAP Gateway 2.0 SPS 11
1.1.1 What's New in the Framework
1.2 SAP Gateway Master Guide
1.2.1 General Overview
1.2.2 SAP Gateway and OData
1.2.3 Development Overview
1.2.4 SAP Gateway Service Builder
1.2.5 Deployment Options
1.2.6 Embedded Versus Hub Deployment
1.2.7 Glossary
1.3 SAP Gateway Installation Guide
1.3.1 Installation Prerequisites
1.3.2 Installing SAP Gateway Components
1.3.3 Unicode and Non-Unicode Support
1.4 SAP Gateway Configuration Guide
1.4.1 General Configuration Settings
1.4.1.1 Profile Parameters
1.4.1.2 ICF Services
1.4.1.3 Changing Password for Initial Logon
1.4.1.4 Language Settings
1.4.2 SAP Gateway Configuration
1.4.2.1 User, Developer, and Administrator Roles
1.4.2.1.1 Creating and Assigning Roles
1.4.2.2 Connection Settings for SAP Gateway Hub System
1.4.2.2.1 Connection Settings: SAP Gateway to Consumers
1.4.2.2.1.1 Creating an RFC Destination for Outbound Queues
1.4.2.2.1.2 Registering an RFC Destination for Outbound Queues
1.4.2.2.1.3 Creating a bgRFC Supervisor Destination
1.4.2.2.2 Connection Settings: SAP Gateway to SAP Systems
1.4.2.2.2.1 Creating an RFC Destination for SAP Gateway Hub to SAP System
1.4.2.2.2.2 Defining Trust for SAP Systems
1.4.2.2.2.3 Configuring SAP System to Accept Assertion Tickets from SAP Gate
1.4.2.2.2.4 Configuring SAP Gateway Host to Accept Assertion Tickets from SA
1.4.2.2.2.5 Creating an SAP System Alias
1.4.2.2.2.6 System ID in Origin Segment Parameter
1.4.2.3 Activating SAP Gateway
1.4.2.4 Service Development in the Backend System
1.4.2.4.1 Maintaining Models and Services
1.4.2.4.2 Displaying Models and Services
1.4.2.4.3 Defining Parallelization of Batch Queries
1.4.2.5 Service Development in the SAP Gateway Hub System
1.4.2.5.1 Assigning SAP System Alias to OData Service
1.4.2.5.2 Multiple Origin Composition
1.4.2.5.3 Dynamic System Alias Calculation Via /IWFND/ES_MGW_DEST_FINDER
1.4.2.6 Connection Settings to SAP Gateway
1.4.2.6.1 Defining Settings for Idempotent Services
1.4.2.6.2 Defining a Remote Function Call to SAP Gateway
1.4.2.6.3 Connection Settings to SAP Gateway
1.4.2.6.4 Configure the bgRFC Supervisor Destination
1.4.2.6.5 Monitoring bgRFC Queues
1.4.3 Configuration Settings for SAP Gateway Supported Scenarios
1.4.3.1 Configuration Settings for OData Channel Scenarios
1.4.3.1.1 Configuring Workflow for SAP Gateway
1.4.3.1.1.1 Creating an Administrator Role for Workflow
1.4.3.1.1.2 Customizing SAP Gateway Workflow
1.4.3.1.1.2.1 Configuring Workflow Notifications
1.4.3.1.1.2.1.1 Creating a Type G RFC Destination
1.4.3.1.1.2.1.2 Configuring User Authorizations for Push Notifications
1.4.3.1.1.2.1.3 Running Scheduled Reports
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 2 of 95
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 3 of 95
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 4 of 95
1 SAP Gateway
Product Information
Product
SAP Gateway
Release
2.0
Documentation Published
August 2015
Use
SAP Gateway is a development framework, which is available as an SAP NetWeaver Application Server ABAP (AS ABAP) add-on, which you can install on
top of your existing SAP Business Suite or application platform.
SAP Gateway offers development and generation tools to create OData services to a variety of client development tools. Put simply, it establishes a
connection between SAP Business Suite data and target clients, platforms, and programming framework.
SAP Gateway provides the following functionality:
Runtime environment for SAP solutions that integrates desktop programs with SAP systems
Runtime features, including user interface, secure data access, database connectivity, and network communications for managing applications running
on top of the framework
Infrastructure and tools for developing applications to run on the framework or to enhance SAP solutions that integrate desktop programs with SAP
systems
Connection to multiple SAP systems regardless of their versions
SAP Gateway
The software offers service generation tools that allow you to reuse existing data sources in creating the models and by that, speed up development time. The
tools enable you to generate models based on existing:
Business objects that can be selected from the Business Object Repository (BOR)
Remote function modules
Dynpro screens
The tools do not require coding and allow not only to reuse exiting business objects or screens but also allow no-code based data adaptation capabilities. Data
coming from multiple objects can be aggregated, filtered and adapted based on the client application requirements.
The software also offers a tool to develop models. This tool is based on the ABAP Workbench (SE80) and requires ABAP coding skills.
Documentation Structure
The SAP Gateway documentation consists of the following sections:
What's New in SAP Gateway 2.0 SPS 10
SAP Gateway Master Guide
SAP Gateway Installation Guide
SAP Gateway Configuration Guide
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 5 of 95
SAP
SAP
SAP
SAP
Disclaimer
Features of the standard mode, introduced with Support Package 03 for SAP Gateway 2.0, are intended to be in accordance with the standards outlined in the
Open Data Protocol Specification v2.0 (see http://odata.org ). Therefore, any deviation from this standard is not intentional and is subject to change.
Consequently, all client implementations shall be validated against the Open Data Protocol Specification.
Do not use objects in the /IWCOR namespace. Only use official APIs.
Recommendation
We strongly recommend using the OData Channel (ODC) programming paradigm for all SAP Gateway development.
As of SAP Gateway 2.0 Support Package 05, you are strongly recommended to use the Service Builder (transaction SEGW) for your OData design-time
development . For more information, see SAP Gateway Service Builder.
Depending on whether you want to develop SAP Gateway content in an SAP Business Suite backend system or in an SAP Gateway hub system, you can
choose between embedded deployment or central hub deployment. For more information, see Embedded Versus Hub Deployment and Deployment
Options.
SAP Gateway uses the open source jQuery JavaScript Library v1.6.2:
http://jquery.com/
Copyright 2011, John Resig
Dual licensed under the MIT or GPL Version 2 licenses.
http://jquery.org/license
Includes Sizzle.js
http://sizzlejs.com/
Copyright 2011, The Dojo Foundation
Released under the MIT, BSD, and GPL Licenses.
References
You can find additional information about SAP Gateway in SAP Note 1560585
Further release constraints are listed in SAP Note 1574568
Sizing information for SAP Gateway is available on the SAP Service Marketplace in the Quick Sizer Tool under http://service.sap.com/sizing
Sizer Tool . You can use the Quick Sizer Tool for your hardware calculations for your system landscape.
and Quick
The SAP Community Network (SCN) offers additional information, such as community discussions, blogs, forums, etc. under
http://scn.sap.com/community/gateway
Details
Area
Country Relevance
The SAP Gateway framework and runtime offer a variety of new and enhanced functions in the latest support package.
New Name
SAP NetWeaver Gateway is rebranded to a new name SAP Gateway. This new name, SAP Gateway, is reflected in UIs for all the software components and
also in the documentation.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 6 of 95
Vocabulary-Based Annotations
It is possible to define vocabulary-based annotations in a way that simple values of type STRING can be language-dependent, that is, have different values
depending on the language defined in the clients request.
For more information, see Vocabulary-Based Annotations.
$filter on Navigation
$filter is supported on navigation properties.
For more information, see System Query Option APIs.
$expand
An API extension is provided to support $expand with $select query.
For more information, see /IWBEP/IF_MGW_ODATA_EXPAND.
Application Log
Service IDs are exposed in the Application Log protocol.
For more information, see Application Log Viewer.
Metadata Texts
You can bind data elements for text reference usage in properties.
For more information, see method BIND_DATA_ELEMENT_FOR_TEXT of interface /IWBEP/IF_MGW_ODATA_PROPERTY.
Routing
A mapping of system ID to system alias via the HTTP response header is provided.
For more information, see Catalog Service.
Documentation Structure
For more information, the documentation for SAP Gateway also includes the following guides:
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 7 of 95
SAP
SAP
SAP
SAP
SAP
SAP
Gateway
Gateway
Gateway
Gateway
Gateway
Gateway
Installation Guide
Configuration Guide
Technical Operations Guide
Security Guide
Developer Guide
Content Guide (including Workflow)
Note
While SAP Gateway uses OData, the OData implementation in place is not a full implementation according to the official OData specification at
www.odata.org
For more information about OData, see SAP Gateway and OData.
More Information
For more information see OData Channel.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 8 of 95
Note
While SAP Gateway uses OData, the OData implementation in place is not a full implementation according to the official OData specification at
www.odata.org
More Information
For more information about the new Service Builder, see SAP Gateway Service Builder.
For more information, see SAP Gateway Developer Guide.
Prerequisites
To use SAP Gateway Service Builder, you must install the Add-On IW_BEP. Depending on your system landscape, you can install this Add-On either in an
SAP Gateway system or in an SAP Business Suite system. If your system is based on SAP NetWeaver 7.40 or higher, you do not need to install IW_BEP
since the core SAP Gateway component SAP_GWFND 740 is installed as standard and includes the functional scope of IW_BEP. For more information, see
Deployment Options.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 9 of 95
More Information
For more information about the Service Builder, see SAP Gateway Service Builder.
For detailed information about the end-to-end service development process, see the Service Builder cookbook, Getting Started with the Service Builder.
Embedded Deployment
Deployment embedded in the SAP Business Suite backend system has the following advantages:
Direct local access to metadata and business data.
Less runtime overhead as one remote call is reduced.
No content merge for different applications required.
No additional, separate SAP Gateway system required.
Lower total cost of ownership as there is one less system to maintain.
However, note the following considerations:
The innovation speed of SAP Gateway and the SAP Business Suite backend system need to be synchronized.
Devices need to be integrated with the SAP Business Suite backend system on a point-to-point basis.
Cross-system composition is not advisable.
Central SAP Gateway content is not available. Content specific to SAP Business Suite is used in SAP Business Suite system.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 10 of 95
The mandatory core components for SAP Gateway are listed in the following table, together with a short description of each component. You can install these
components in an SAP Business Suite backend system (embedded deployment) or in an SAP Gateway hub system (central hub deployment).
Name
Type
Version
Notes
IW_FND
ABAP
250
Note
For SAP NetWeaver 7.40 or higher,
see SAP_GWFND.
GW_CORE
ABAP
200
Note
For SAP NetWeaver 7.40 or higher,
see SAP_GWFND.
SAP_GWFND
ABAP
740
Note
If you have previously created
services for the Generic Channel that
are still in use, you must install the
component IW_FNDGC 100 in
systems based on SAP NetWeaver
7.40 or higher. You only need to
install this component if you have
existing Generic Channel services.
Note
For more information about release dependencies, see Installing SAP Gateway Components.
Type
Version
Notes
IW_BEP
ABAP
200
Note
If your system is based on SAP
NetWeaver 7.40 or higher, you do
not need to install IW_BEP since this
functional scope is included in the
core component SAP_GWFND, which
is available as standard in the SAP
NetWeaver 7.40 delivery.
IW_CNT
ABAP
200
IW_CBS
ABAP
200
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 11 of 95
ABAP
100
IW_SPI
ABAP
100
IW_PGW
ABAP
100
Type
Version
Notes
IW_BEP
ABAP
200
Note
For SAP NetWeaver 7.40 and higher,
the core component SAP_GWFND in
installed as standard and includes
the functional scope of IW_BEP.
IW_SCS
ABAP
200
IW_GIL
ABAP
100
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 12 of 95
ABAP
100
IW_PGW
ABAP
100
More Information
For more information about landscape recommendations, see the following presentation on SAP Community Network:
https://wiki.sdn.sap.com/wiki/display/SLGB/Landscape+Recommendations
Software Components
IW_FND
GW_CORE
7.31
IW_BEP
SAP NetWeaver 7.40 and higher
SAP_GWFND
Advantage:
Enables you to reuse data stored in the SAP Business Suite system easily since development takes place in the system in which your data is
stored.
Considerations for SAP NetWeaver Releases 7.0, 7.01, 7.02, 7.03, and 7.31
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 13 of 95
Minimum requirement for installing the Add-On IW_BEP in the SAP Business Suite backend system is SAP NetWeaver 7.00 Support Package 18.
The life cycle of SAP Gateway content is dictated by the frequency of updates in the SAP Business Suite backend system.
To enable communication between the SAP Gateway system and the SAP Business Suite backend system, you must install IW_BEP in the
backend system.
If you want to use the Screen Scraping generator, you must install the Add-On IW_SCS in the SAP Business Suite backend system. Minimum
requirement for installation in the backend system is SAP NetWeaver 7.00 Support Package 18.
Considerations for SAP NetWeaver Release 7.40
As of SAP NetWeaver 7.40, component SAP_GWFND is already installed as part of the standard SAP NetWeaver delivery.
The life cycle of SAP Gateway content is dictated by the frequency of updates in the SAP Business Suite backend system.
If you want to use the Screen Scraping generator, you must install the Add-On IW_SCS in the SAP Business Suite backend system.
Scenario B: Central Hub Deployment Development in SAP Gateway System
SAP NetWeaver Release
Software Components
IW_FND
GW_CORE
IW_BEP
SAP_GWFND
Advantages:
Noninvasive deployment scenario for SAP Business Suite backend system.
The life cycle of SAP Gateway content is loosely coupled to the lifecycle of the SAP Business Suite backend system.
To enable external access and fulfill security requirements, you can locate the SAP Gateway system in a demilitarized zone (DMZ).
You need only a single installation of the SAP Gateway Add-Ons within the system landscape.
Considerations
The SAP Gateway content implementation cannot use the majority of development objects in the SAP Business Suite backend system.
Consequently, you need to create copies of structures and data domains, for example.
If you want to use the Screen Scraping generator, you must install the Add-On IW_SCS in the SAP Business Suite backend system. Depending
on the setup of the backend system, this might not be permitted. Minimum requirement for installation in the backend system is SAP NetWeaver
7.00 Support Package 18.
You must choose this deployment scenario if you cannot install the SAP Gateway Add-Ons in the SAP Business Suite backend system. You
might not be able to install Add-Ons in the backend system for reasons of security, stability, or incompatibility (due to system release).
Scenario C: Embedded Deployment Development in SAP Business Suite Backend System
SAP NetWeaver Release
Software Components
IW_FND
GW_CORE
IW_BEP
SAP_GWFND
Advantages:
Easy reuse of content in SAP Business Suite backend system. You can reuse structures from the backend system and access local business
logic.
Reduced total cost of ownership (TCO) as you do not require a separate SAP Gateway system.
Considerations:
The life cycle of SAP Gateway content is dictated by the frequency of updates in the SAP Business Suite backend system.
You must integrate the consuming application or infrastructure with the SAP Business Suite system on a point-by-point basis.
Cross-system composition is not advisable.
Central SAP Gateway content is not available. Backend-specific content is used in the SAP Business Suite backend system.
For more information about embedded deployment and central hub deployment, see Deployment Options.
For more information about release dependencies, see Installing SAP Gateway Components.
1.2.7 Glossary
action
Prepackaged business logic attached to an entity type.
annotation
Metadata attached to a consumption model element.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 14 of 95
backend system
SAP Business Suite backend system.
collection
Resource that contains a set of entries, which are structured according to the entity type definition in the respective data model.
consumption model
Represents an OData service by bundling a set of SAP Gateway data models for a specific consumption use-case. Each data model will be reflected by one
or more corresponding entity types or collections in the resulting service. Exposed as service document plus service metadata document in the OData world.
content generator
SAP Gateway design-time tool that enables a developer to create content quickly without having to write source code. The content is then available for use
through SAP Gateway. There are three different content generators, Business Object Repository (BOR), Remote Function Call (RFC), and Screen Scraping
(SCS).
data model
Root entity representing a certain self-contained business object that defines a people-centric view on respective business information. The nodes of this
hierarchy are called entity types.
embedded deployment
Deployment of core software components IW_FND and GW_CORE on the SAP Business Suite backend system.
event provider
Application-specific component that provides business events. SAP Gateway converts these events in OData for SAP application notifications.
Generic Channel
Programming paradigm for SAP Gateway. Infrastructure components that enable SAP Gateway content to abstract data from the exposed protocol and the
business application implementation. The recommended programming paradigm for SAP Gateway is OData Channel.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 15 of 95
hub system
SAP Gateway system.
metadata document
Complete XML representation of an Entity Data Model (1:1 relation).
OData service
Develop OData services in the Service Builder to extract the data you want, when you want it, and where.
project
Used in SAP Gateway Service Builder to consolidate and store all artifacts needed to create a service and model in one place. Projects provide developers
with the freedom to interrupt the service development and modeling process at any time, without being bound to runtime artifacts and without risk of losing
data.
property
An <EntityType> can have one or more properties of the specified EDMSimpleType or ComplexType. A property can be a declared property or a dynamic
property. The declared properties of an <EntityType> of <ComplexType> are defined using the <Property> element.
SAP Gateway
SAP Gateway enables people-centric applications to consume SAP Business Suite data through popular devices and platforms in an easy and standardsbased fashion.
Screen Scraping
Generator for transforming ABAP dynpro screens into SAP Gateway services.
self link
In an OData entity or a feed a self link is a link to the entity or the feed itself, for example <atom:id>.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 16 of 95
service
Exposed as an OData service to be consumed by an external application (such as JavaScript-based client). Is a repository object used for routing (system
aliases are assigned to a service) and authorization checks. It has a dedicated ICF node and contains one or more data models.
Service Builder
Is a dedicated design-time transaction, which provides a toolset for creating OData services easily and efficiently and supports the entire service development
life cycle. It blends new and existing ABAP development tools in an OData-compliant modeling transaction and caters for the needs of all developers,
regardless of experience and time available for service development.
service call
Request sent to the OData service root URI or a resource path extending it.
service document
Top-level XML representation of a consumption model (1:1 relation). It contains a list of entity sets. A document that describes the location and capabilities of
one or more entity sets.
thing
Tangible work object from a user perspective.
thing type
Entity that defines tangible work objects. A prominent entity type fulfilling additional constraints.
To ensure that SAP Gateway functions smoothly in an ABAP environment, a number of installation and configuration steps need to be performed. This chapter
focuses on all aspects concerning the installation of SAP Gateway:
Installation Prerequisites
Installing SAP Gateway Components
Unicode and Non-Unicode Support
More Information
For information about the system landscape and the different installation or deployment options offered by SAP Gateway, see Deployment Options.
For information about the software maintenance tools and processes, see Software Maintenance.
For information about product availability, see the Product Availability Matrix (PAM) under http://service.sap.com/pam
Specification
Processor
8 GB or higher
80 GB primary, or higher
Software
The minimum software requirements for SAP Gateway are as follows:
Requirements
Specification
The latest kernel patch for the corresponding SAP NetWeaver version has to be applied.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 17 of 95
Core Components
Core Component
Note
Comprises functional scope of components
IW_FND, GW_CORE, IW_BEP, and IW_HDB.
Business Enablement Provisioning Component
IW_BEP
IW_SPI
IW_GIL
Content Components
IW_FND 250
IW_GIL
SAP Backend
More Information
For information about the product availability matrix for SAP Gateway, see http://service.sap.com/pam
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 18 of 95
Core Components
SAP NetWeaver 7.0 and 7.01
GW_CORE 190
IW_FND 240
SAP NetWeaver 7.02, 7.03, and 7.31
GW_CORE 200
IW_FND 250
SAP NetWeaver 7.40 and higher
SAP_GWFND 740: SAP Gateway Foundation 7.40
This core component is available as standard in systems based on SAP NetWeaver 7.40 higher and provides the core functional scope
comprising IW_FND 250, GW_CORE 200, IW_BEP 200, and IW_HDB 100. Consequently, if you have an SAP NetWeaver 7.40
installation, you can use SAP Gateway without having to install any additional software components.
Note
If you have an SAP NetWeaver 7.40 installation and you have previously created services for the Generic Channel that are still in use,
you must install the software component IW_FNDGC 100. You only need to install this optional component if you have existing Generic
Channel services.
For more information about the systems in which you can install these core components, see Deployment Options
For more information about the system prerequisites for these core components see, Installation Prerequisites
Business Enablement Provisioning Component
SAP NetWeaver 7.0, 7.01, 7.02, 7.03, and 7.31
IW_BEP 200
Enables OData Channel programming paradigm and is required for SAP Gateway Service Builder to build OData services. While this
component is, in theory, optional, you require an installation of it in either your SAP Business Suite backend system or your SAP Gateway
system if you want to install the content adapter components.
SAP NetWeaver 7.40 and higher
SAP_GWFND 740: SAP Gateway Foundation 7.40
This core component is included in SAP NetWeaver 7.40 as standard and it contains the full functional scope of IW_BEP 200.
Consequently, you do not need to install IW_BEP 200 in systems based on SAP NetWeaver 7.40 and higher.
Content Adapter Components
IW_HDB 100
Provides business content adapter for SAP Gateway with SAP HANA that enables OData exposure of SAP HANA views.
Note
For systems based on SAP NetWeaver 7.40 and higher, you do not need to install this component since the functional scope is included in
the core component SAP_GWFND 740, which is available as standard.
IW_SPI 100
Provides a generic OData adapter for content based on the Service Provider Infrastructure (SPI).
IW_PGW 100
Enables exposure for SAP NetWeaver Business Process Management (BPM) and Process Observer Task exposure for BPM and SAP
NetWeaver Business Workflow.
IW_GIL 100
Provides a generic OData adapter for content based on the Generic Interaction Layer (GenIL).
For more information about the system prerequisites for the content adapter components see, Installation Prerequisites.
For all SAP NetWeaver releases lower than SAP NetWeaver 7.40, the content adapter components IW_HDB 100, IW_SPI 100, IW_PGW 100, and
IW_GIL 100 are dependent on an installation of IW_BEP 200. For SAP NetWeaver 7.40 and higher, the content adapter components IW_SPI 100,
IW_PGW 100, and IW_GIL 100 are dependent on an installation of SAP_GWFND 740.
Content Components
Content is provided in predefined groups. Examples of such content are customer, account, and leave request grouped under CRM (Customer
Relationship Management).
System integrators, other vendors, and other SAP development teams can also provide similar content.
The sub components contained in this package are as follows:
IW_CNT 200
IW_CBS 200
For SAP NetWeaver 7.02, 7.03, and 7.31, the content components IW_CNT 200 and IW_CBS 200 are dependent on an installation of IW_FND 250.
For SAP NetWeaver 7.40 and higher, the content components IW_CNT 200 and IW_CBS 200 are dependent on an installation of IW_FNDGC 100.
Screen Scraping Component
IW_SCS 200
You must install this component in your SAP Business Suite backend system if you want to create content using the Screen Scraping generator.
These installation packages have a compressed format, so first unpack them into your local file system. Next, import them using the installation tool. For
detailed information on unpacking the installation packages, see Loading Installation Packages from the Application Server.
To install the SAP Gateway components:
1. Log on to the SAP system in which you want to install the SAP Gateway components and enter the transaction SAINT.
2. Import the installation packages. For detailed information on importing the installation packages, see Installing and Upgrading Add-ons.
More Information
For a detailed overview of the installation prerequisites that must be fulfilled for each of the components, see Installation Prerequisites.
For an overview of software components and where to deploy them, see Deployment Options.
For more information about SAINT, see Add-On Installation Tool.
For more information about installing SAP Gateway, see SAP Note 1569624
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 19 of 95
Implementation Guide
The SAP Gateway specific configuration tasks are included in the SAP Gateway Implementation Guide (IMG) which is available in the system: In your SAP
Gateway hub system (IW_FND) go to transaction SPRO, open the SAP Reference IMG and navigate to:
SAP NetWeaver SAP Gateway . In your
backend system (IW_BEP) go to transaction SPRO, open the SAP Reference IMG and navigate to:
SAP NetWeaver
.
For all steps in the IMG there is always consumer-independent documentation available. If you want to see more information, select the Display icon before
executing each step.
Note
If you have software components GW_CORE 190 and IW_FND 240 installed in your system, the IMG tree will only offer the activities for OData Channel.
The same applies if you use SAP Gateway in SAP NetWeaver 7.40 (software component SAP_GWFND).
For more information, see Deployment Options.
Recommendation
We strongly recommend using the OData Channel (ODC) programming paradigm for all SAP Gateway development.
As of SAP Gateway 2.0 Support Package 05, you are strongly recommended to use the Service Builder (transaction SEGW) for your OData design-time
development . For more information, see SAP Gateway Service Builder.
Depending on whether you want to develop SAP Gateway content in an SAP Business Suite backend system or in an SAP Gateway hub system, you can
choose between embedded deployment or central hub deployment. For more information, see Embedded Versus Hub Deployment and Deployment
Options.
As such, several sections in the Implementation Guide (IMG) are merely available for reference and maintenance purposes.
In the backend system this is the section in the SAP Reference IMG under
SAP NetWeaver SAP Gateway Service Enablement Generic
Channel .
In the SAP Gateway hub system these are the sections in the SAP Reference IMG under
SAP NetWeaver SAP Gateway
Former Development
.
For Screen Scraping you only need to configure roles based on certain
authorization templates. The templates specify the authorizations for content that
can be accessed by the users and activities for developers. For more information,
see Setting Up User and Administrator Authorizations.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 20 of 95
If you want to install the SAP Gateway with HANA component (IW_HDB), this
requires SAP NetWeaver 7.02 SPS09 comprising an ABAP Database Connectivity
(ADBC) installation. ADBC is an object-based ABAP API for programming relational
database accesses. It follows the Java Database Connectivity (JDBC) diction in its
class and model structure.
Workflow
You can find more information about the Workflow-related configuration activities in
Configuring Workflow for SAP Gateway. In addition, the relevant IMG activities are
available in the Implementation Guide in the backend system: In transaction SPRO
open the SAP Reference IMG and navigate to:
Service Enablement
Content
SAP NetWeaver
Workflow Settings
SAP Gateway
For the special services provided within Business Process Enablement, such as
Process Service and Process Context Service, the relevant IMG activities are
available in the Implementation Guide in the backend system. In transaction SPRO
open the SAP Reference IMG and navigate to:
Service Enablement
Content
SAP NetWeaver
SAP Gateway
.
Consumer Settings
For information on configuration settings which need to be carried out for the different consumer scenarios and applications, see Configuration Settings for
SAP Gateway Supported Scenarios.
Description
Example
SAP administrator
of the AS ABAP
SAP system
Value
login/accept_sso2_ticket
login/create_sso2_ticket
More Information
For information on profile parameters and profile parameter maintenance, see Profile Parameters for Logon and Password (Login Parameters) and Changing
and Switching Profile Parameters.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 21 of 95
Caution
Activated ICF services represent a security risk because they can be accessed directly by the HTTP protocol from the Internet. You therefore need to use
suitable methods for restricting access, for example, only permitting access to the ICF service for users with the appropriate authorizations.
Since multiple services can be executed when you call a URL, all service nodes must be activated in the SICF tree. The URL path is mapped in ICF
subnodes (services). For example, if you want to activate the services for URL /sap/public/icman, you have to activate the service tree default_host
in transaction SICF. Then you have to activate services sap, public and icman separately.
You activate an ICF service as follows:
1. Select the required ICF service in the ICF tree in transaction SICF.
2. Activate the ICF service in one of the following ways:
Using menu option
Service/Host Activate .
Using the context menu and choosing Activate Service .
You can either activate only a selected service node ( Yes ), or the selected service node including all the subservices maintained for it in SICF ( Yes with
tree icon).
For SAP Gateway you need to activate the following services:
/sap/public/opu
Note that /sap/public/opu/resources is needed for loading resources, such as images in the MIME repository. For example, the generic player
gets a service document which contains links to images which the player should display for a Sales Order. Then the generic player downloads the image
via URL from the MIME Repository; for example, http://.../sap/opu/resources/pic1.png.
/sap/opu/odata with its sub-nodes.
This is the standard mode for all new applications. When creating a service a new node is created automatically.
/sap/opu/sdata with the following sub-nodes:
/sap/opu/sdata/iwcnt
/sap/opu/sdata/iwfnd
/sap/opu/sdata/sap
This is the node used for existing applications, it is called Compatibility Mode for SP02 .
If you use Web service based scenarios, that is, if content is consumed which is provided via Web services, then you also need to activate the following
nodes on your target system:
/sap/bc/srt/xip/sap
/sap/bc/webdynpro/sap/saml2
/sap/public/bc
/sap/public/bc/ur
/sap/public/mysssocnt
Note
If the default_host node is inactive in transaction SICF, the HTTP requests could result in an ABAP runtime error RAISE_EXCEPTION with the
following short text:
Exception condition "HOST_INACTIVE" triggered.
If a service is inactive in transaction SICF, an error text appears when you try to access the service.
You can also activate services from the SAP Implementation Guide (IMG). In transaction SPRO, choose Display SAP Reference IMG . The path in the
Implementation Guide for SAP NetWeaver is:
in Installation .
Application Server
or Activate Services
Note that the system performs a check against the authorization object S_ICF_ADM when an ICF node is created.
Standard Mode
This standard mode refers to the ICF node /sap/opu/odata. This node is available for OData Channel based applications. When creating a service a new
node is created automatically.
Note
The standard mode is the default for all new applications. All new development will be done on this mode. New functions and features will be
available for this mode.
The request handler for this node is /IWFND/CL_SODATA_HTTP_HANDLER.
The following list consists of the differences of the standard mode as opposed to the compatibility mode for SP02:
XSRF protection
See also Cross-Site Request Forgery Protection
Content-Type required for Put/Post request
An unsupported media type error is thrown if Content-Type is not set for Put/Post requests. Set parameter:
Content-Type=application/xml
XSRF Security Token
Security Session Id
$format parameter
$format=xml leads to an error except for service document. Do not use it for all requests except for those to get service document .
Null values in Put/Post Request
Empty property elements (for example, <name/>) are not allowed anymore. Nullable needs to be set properly, and besides that, if an entry with a null
string is to be created set m:null="true", for example, <name m:null="true" />.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 22 of 95
Caution
This node is in maintenance mode.
The request handler for this node is /IWFND/CL_SDATA_ODATA_APP.
Note
Note that external aliases are not supported for namespaces in SICF.
If the handler /IWFND/CL_SODATA_HTTP_HANDLER is not yet registered for your service node, enter the handler name on tab Handler List and activate
your service. After the handler has been set, you can define the external alias.
More Information
Administration of ICF server functions (authorization assignment): Server Function Administration
Administration of ICF client functions (creation of RFC destinations, and so on): Client Function Administration
ICF services: Creating and Configuring an ICF Service
Authentication: Defining the Logon Procedure
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 23 of 95
You can find this special ICF node in the service tree under /default_host/sap/opu/utils under the name initial_logon.
You can access this node as soon as it has been activated via the URL <host>:<port>/sap/opu/utils/initial_logon.
The call of the service requires authentication and does allow to change an initial password via a browser application. If the URL is extended by ?
redirectURL=/X then the browser is redirected to the URL wherever X points to. A typical use case for such a redirect URL would be to display additional
information, so that the new password data could be used in the settings of a mobile application. If needed, a redirect URL can be configured and will take
precedence over all basic settings.
be the root node which is accessed by your mobile devices and where you want to deny the direct access via mobile device.
Double-click on the node and change to edit mode.
On tab Error Pages choose sub-tab Logon Errors .
Choose System Logon .
Choose Configuration .
Choose Define Service-Specific Settings .
Under Logon Layout and Procedure choose Custom Implementation and enter ABAP Class /IWFND/CL_COC_SYSTEM_LOGIN.
Caution
If you have administrator rights you have the additional option to save your settings as global settings. Do not use Save as Global Settings .
10. Activate your ICF node.
Logoff URL
The Internet Communication Framework also offers a default logoff URL on each system.
You can define your own logoff pages via
Error Pages
Logoff Page
More Information
For more information on the generic system logon functionality in ICF, see System Logon.
SAP NetWeaver
SAP Gateway
SAP NetWeaver
SAP Gateway
OData Channel
Apart from basic configuration settings the OData Channel configuration activities for the SAP Business Suite backend system are listed in the
Implementation Guide (IMG) in the backend system where software component IW_BEP is deployed. In the SAP Reference IMG navigate to
SAP
NetWeaver
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 24 of 95
SAP Gateway
and
SAP NetWeaver
Settings
User, Developer and Administrator Authorizations
Connection Settings: SAP Gateway to SAP Systems
Activating SAP Gateway
Service Development in the Backend System
Service Development in the SAP Gateway Hub System
Connection Settings to SAP Gateway
More Information
Basic Configuration Settings
OData Channel
Template Name
Template for
Framework
/IWFND/RT_BOR_DEV
Framework
/IWFND/RT_DEVELOPER
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 25 of 95
OData Channel
/IWBEP/RT_MGW_DEV
Screen Scraping
/IWSCS/RT_SCR_DEV
SAP NetWeaver
SAP Gateway
OData Channel
Configuration
and click on the Activity icon. The Role Maintenance page displays.
To check that the role was properly created and assigned, log onto the SAP Gateway system as the user you just assigned. You should be able to access
transaction SPRO and find the SAP Gateway Implementation Guide there. You can now log onto the SAP Gateway host as the administrator user you have
just created to configure SAP Gateway components and content, and to install consumer applications.
For more information about SAP user administrator types, see Setting Up User and Authorization Administrators.
The following templates are available for administrators:
Template Type
Template Name
Template for
Framework
/IWFND/RT_ADMIN
Content Scenario
/IWCNT/RT_ADMIN_REP
OData Channel
/IWBEP/RT_MGW_ADM
/IWBEP/RT_BEP_ADM
Workflow
/IWWRK/RT_WF_ADM
Task Gateway
/IWPGW/RT_WF_ADM
Note
You must be a SAP Gateway administrator or have a SAP user administrator to create user roles.
In the SAP Reference Implementation Guide (IMG) (transaction SPRO), navigate to
User Settings
SAP NetWeaver
SAP Gateway
OData Channel
Configuration
and click on the Activity icon. The Role Maintenance page displays. Proceed as described below.
Once you have assigned users to the relevant roles, you can log on as one of these users and work as them.
If you use Web service based scenarios, copy the SAP_BC_WEBSERVICE_CONSUMER role to a customer role for end users. Then assign this customer role to
your end users. To do this, proceed as follows:
1. Click on the Activity icon of the IMG activity Define Role for SAP Gateway User mentioned above.
The Role Maintenance page displays.
2. In the Role field, enter your customer role for Web services and choose Change .
3. On the User tab enter the names of the users to whom you want assign this role and save your settings.
4. Choose User Comparison .
5. Choose Complete Comparison .
6. Save your settings.
To check that you have successfully assigned roles to users, take some of the users assigned to the different roles and make sure that you can log on
successfully. If these steps have not been performed successfully, an HTTP request of an authenticated user returns an HTTP 500 error.
The following templates are available for end users:
Template Type
Template Name
Template for
Framework
/IWFND/RT_GW_USER
Framework
/IWFND/RT_TU_NOTIF
Content Scenario
/IWCNT/RT_USER_LEMA
Content Scenario
/IWCNT/RT_USER_REP
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 26 of 95
Content Scenario
/IWCNT/RT_USER_SS
Content Scenario
/IWCNT/RT_USER_TRVL
Content Scenario
/IWCNT/RT_USER_TIMA
Content Scenario
/IWCNT/RT_USER_WF
Content Scenario
/IWCNT/RT_USER_ACT
/IWCNT/RT_USER_ACCNT
Content Scenario
/IWCNT/RT_USER_CONT
OData Channel
/IWBEP/RT_MGW_USR
OData Channel
/IWHDB/RT_USER
OData Channel
/IWBEP/RT_SUB_USR
/IWBEP/RT_BEP_USR
Workflow
/IWWRK/RT_WF_GW_USR
Workflow
/IWWRK/RT_WF_SUB_USR
Task Gateway
/IWPGW/RT_WF_USR
Screen Scraping
/IWSCS/RT_SCR_USR
Services
Template Name
Template for
Support
/IWFND/GW_SUPPORT_RO
Support
/IWBEP/GW_SUPPORT_RO
More Information
Creating and Assigning Roles
Roles in the SAP Gateway Landscape
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 27 of 95
SAP NetWeaver
SAP Gateway
OData Channel
Configuration
Connection Settings
SAP
SAP NetWeaver
SAP Gateway
OData Channel
Configuration
SAP NetWeaver
SAP Gateway
Connection Settings
SAP Gateway to Consumer Register RFC Destination for Outbound Queues
2. Select the Define Inbound Dest. tab.
3. Choose Create .
4. In the Inb. Dest. Name field, enter IWFND_BGRFC_DEST .
OData Channel
Configuration
Note
The bgRFC supervisor user you specify must have authorizations from authorization object S_RFC. These are defined in role
SAP_BC_BGRFC_SUPERVISOR.
To create the bgRFC supervisor destination, proceed as follows:
1. In transaction SPRO open the SAP Reference IMG and navigate to:
Connection Settings
SAP NetWeaver
SAP Gateway
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
OData Channel
Configuration
Page 28 of 95
OData Channel
Configuration
Connection Settings
SAP NetWeaver
SAP Gateway
OData Channel
Configuration
Connection Settings
SAP Gateway to SAP System Manage RFC Destinations
and click on the Activity icon.
2. Choose Create .
3. In the RFC Destination field, enter the RFC destination name in the following format: <system id >CLNT<Client>.
4. In the Connection Type field, enter 3 .
5. In the Description 1 field, enter an explanatory text, for example, RFC Destination to SAP Server .
6.
7.
8.
9.
10. On tab Logon & Security enter the SAP systems client number.
11. Activate Current User .
12. For Trust Relationship activate Yes .
Note
Ensure that you have previously created the trusted relationship, as outlined in Defining Trust between the SAP Gateway Host and Your SAP
System.
13. Save your settings.
To check that you have successfully created the type 3 connection, choose Connection Test . The connect test should pass.
If the user ID with which you are logged on to SAP Gateway and your user ID for the SAP system is the same, and this user ID has the object S_RFCACL
assigned to it on the SAP system, select Remote Logon . You should not see any error messages in the status. If you have any problems, check SAP Note
128447
Note
This RFC destination is used to establish trust between the systems and is not used at runtime.
To configure trust, proceed as follows:
1. In the SAP business system, open transaction SM59 and choose Create .
2. In the RFC Destination field, enter the RFC destination name in the following format: <system id >CLNT<Client>..
3. In the Connection Type field, enter 3 .
4. In the Description 1 field, enter an explanatory text, for example, RFC Destination to SAP Gateway Server .
5. Save your settings.
6. On tab Technical Settings and Load Balancing select the relevant option according to your systems settings.
7. In the Target Host field, enter the (message) server name of the SAP Gateway system.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 29 of 95
8. In the System Number field, enter the SAP Gateway system number, for example, 00 .
9. Save your settings.
10. In transaction SMT1 choose Create .
The wizard for creating trusting relationships displays.
11. Proceed with the steps outlined in the wizard.
In the RFC Destination field, enter the RFC destination you created.
An RFC logon to the SAP Gateway host takes place and the necessary information is exchanged between the systems.
12. Log on to the SAP Gateway host using your administrator user and password.
The trusted entry for the SAP Gateway host displays.
13. Save your settings.
Note
End users must have authorization object S_RFCACL assigned to them before they can use a trusted connection. For more information, see RFC
Trusted/Trusting Systems.
Note
If transaction SSO2 does not work, use STRUSTSSO2 to import the certificates from the SAP Gateway server; you must import them manually. For
further information, see Using Transaction STRUSTSSO2 in SAP System >= 4.6C.
3. Enter the Type 3 RFC destination created above (for your SAP Gateway system) or the Host Name and Instance Number for the SAP Gateway
system in the appropriate fields.
4. Choose Execute .
On the Logon page enter your password.
The SSO2 administration report for the designated SAP system displays.
5. Choose Activate (Enter Certificate in ACL and, if Necessary, Certificate List) to configure the SAP system.
Note
If transaction SSO2 does not work, use STRUSTSSO2 to import the certificates from the SAP Gateway server; you must import them manually. For
further information, see Using Transaction STRUSTSSO2 in SAP System >= 4.6C.
3. Enter the Type 3 RFC destination created above (from your backend system) or the Host Name and Instance Number for the backend system in the
appropriate fields.
4. Choose Execute .
You may be asked to provide a user name and password.
The SSO administration report for the designated SAP system displays.
5. Choose Activate (Enter Certificate in ACL and, if Necessary, Certificate List) to configure the SAP Gateway system.
If everything has been configured correctly the traffic lights are green.
SAP NetWeaver
SAP Gateway
OData Channel
Configuration
Description
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 30 of 95
Description
Local SAP GW
The system that is responsible for processing (managing and storing) the data of
an inbound request is the local SAP Gateway instance itself.
This option is typically used for testing scenarios, for example when using the
BOR Generator locally.
If you activate Local SAP GW for a SAP System Alias called LOCAL the RFC
Destination is usually NONE .
The system alias is to be used by BEP. For more information, see the F1 help in
the system and Hub OData Channel with IW_BEP Installation.
RFC Destination
Software Version
This setting is specified by the content scenario you are using. Typically it is
DEFAULT .
In the context of Generic Channel development, check the following to
determine the value to set for your GSDOs:
In transaction SPRO open the SAP Reference IMG and navigate to:
NetWeaver
SAP Gateway
Former Development
SAP
Former Generic
Channel
Development Generic Service Data Object (GSDO)
GSDO
Types & GSDO Contexts & GSI Implementations
and click on the Activity
icon. Select your GSDO type and choose GSI Implementation .
System ID
Note
When specifying SAP system aliases we recommend always to enter the
system ID. The SAP target system, together with the target client, determines
the system alias for a remote call to a backend system.
Client
Target client.
WS Provider System
Name of the Web service provider business system. Here you only need to enter
a setting if you use content scenarios which are configured via Web services.
Example
Sample syntax for system alias: /sap/opu/odata/IWBEP/TEA_TEST_APPLICATION;o=XYZ_999/Teams
Sample syntax for system ID and client: /sap/opu/odata/IWBEP/TEA_TEST_APPLICATION;o=sid(XYZ.999)/Teams
The processing is as follows:
1. The SAP Gateway system searches for all existing system aliases for the user and the specified service.
2. The SAP Gateway system checks if one from above system aliases equals sid(XYZ.999). If this is the case, this system will be used.
3. If no such system exists underneath the specified service, then SAP Gateway checks whether one of the above system aliases has defined a system
ID XYZ and client 999.
4. If this is the case, this system ID will be used. Otherwise an error message is displayed.
Configuration Steps
For each system alias you need to enter also a system ID and a client, if this has not yet been configured already. For more information, see Creating the
SAP System Alias for Applications.
Note
Before activating SAP Gateway, ensure that you have first installed and configured the consumer server.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 31 of 95
Proceed as follows:
1. In transaction SPRO open the SAP Reference IMG and navigate to:
SAP NetWeaver
SAP Gateway
OData Channel
Configuration
Activate
More Information
Periodical Tasks
Maintain Models
Repository Objects
The registration process of OData Channel models and services is unique: In order to allow collecting authorizations per data provider class (DPC) a repository
object type is available. This is integrated into transaction SU22. Thus two additional repository object types exist in SAP Gateway. For more information see
Roles in the SAP Gateway Landscape.
These repository objects have the following impact:
Models and services shall only be transported via the transport objects.
The external name of a service is derived from the technical name and cannot be freely defined to ensure a GTADIR connection to guarantee unique
services. You create service /MYNAMESPACE/MYSERVICE with version 0001 which then results in
http://<host>:<port>/sap/opu/odata/mynamespace/MYSERVICE.
Prerequisites
The following entities must exist:
The data provider class for the service
The model provider class for all models
More Information
OData Channel
Maintain Model
Start the SAP Reference IMG (transaction SPRO) and choose
Service Development for Backend OData Channel
SAP NetWeaver
Maintain Models
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 32 of 95
Maintain Service
Start the SAP Reference IMG (transaction SPRo) and choose
Service Development for Backend OData Channel
SAP NetWeaver
Maintain Service
SAP NetWeaver
This is a read-only activity, which provides an overview of existing configuration settings. If you want to maintain models and services, see Maintaining
Models and Services.
In case of serialization the duration of the consecutive queries is the sum of all query processing times. Contrary to this, the total duration in parallel mode is
just the maximum duration of these query processing times and a minimal overhead for parallelization.
The following parameters are valid for the current SAP client:
Activate Parallelization for Batch Queries
Mark or unmark this option to enable or disable the parallelization.
Maximum Number of Parallel Queries
Specify the maximum number to limit the amount of parallel processing queries to save system resources. This number will be ignored if it is greater
than the maximum number of dialog work processes available at parallelization time which is based on system settings (transaction RZ11, profile
parameters rdisp/rfc*) . Zero (0) means it only depends on current system resources. Default value: 0.
Note
Parallelization of batch requests is not possible in soft state mode. If soft state mode remains activated for the current service, parallelization of batch
requests will be deactivated at runtime. Soft state and parallelization do not work together.
Page 33 of 95
Note
If your SAP Gateway hub system is based on an SAP NetWeaver release lower than 7.40, you will need to install the core component IW_FND in your hub
system. If your SAP Gateway hub system is based on SAP NetWever 7.40 or higher, the core component SAP_GWFND is installed as standard. For more
information, see Deployment Options.
Assigning SAP System Alias to OData Service
Activate and Maintain Services
Multiple Origin Composition
Dynamic System Alias Calculation Via /IWFND/ES_MGW_DEST_FINDER
Example
It is possible to separate the development, the quality and the production landscape via dedicated clients on the SAP Gateway hub system.
The user will be directed as follows if he or she does not have special roles: If there is a system alias maintained without any role assignment then it is
used for all users.
The user will be directed as follows if he or she has two or several roles relative to different system aliases: If a user is assigned to more than one system
alias the system alias which is marked as default wins. If more than one system alias is found and either none of the system aliases or more than one of
these aliases are flagged as default an error is raised.
Ideally you have a system alias without any role assignment for all users without a role assignment and disjunct roles for the system aliases for all other users
to the different backend systems (development, quality, productive). The system aliases with role assignment should be marked as default in this case.
For this an IMG activity is available in the SAP Gateway Implementation Guide (IMG): in transaction SPRO open the SAP Reference IMG and navigate to
SAP Gateway
Note
In previous support packages OData Channel based content was routed via GSDO groups which are no longer relevant in SAP Gateway 2.0 SP03.
Note
This feature is only supported in Standard Mode .
This feature is relevant only for entity sets with an annotation of addressable=true.
Implementing this feature creates a different version of the service (the SAP_Origin field is added).
Proceed as follows to use the MOC:
1. Customize your service to support MOC.
1. From the SAP Gateway system, activate the desired service. For information on how to activate your service, see Register your Service in the
SAP Gateway System.
2. Open transaction SPRO and choose SAP Reference IMG .
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 34 of 95
3. Navigate to
SAP NetWeaver SAP Gateway
OData Channel Administration General Settings
Activate and Maintain Services
to
add the system aliases for the relevant backend systems and define the desired default system.
1. In the Service Catalog list, select the desired service. The service appears in the ICF Nodes section on the lower left corner of the
screen.
2. In the ICF Nodes section, select the Standard Mode ICF Node.
3. In the System Aliases section, choose System Alias to add the system alias.
4. Choose New Entries or select an existing entry and choose Copy .
5. In the Service Doc. Identifier field, enter the ID of the service document followed by an underscore and the 4digit version number (for
example, _0001).
6. In the SAP System Alias field, enter the relevant system alias. Only one system is to be defined as the default.
7. Repeat as necessary to add the desired backend systems.
Note
The default system is used whenever the service is not called as MOC. If you have defined more than one default system alias, the first
system is used as the default.
2. Test the service.
1. On the SAP Gateway system, open the SAP Reference IMG in transaction SPRO and navigate to
Channel Administration General Settings
Activate and Maintain Services
2. Search for the desired service with the Filter icon.
3. Select the desired service and choose Call Browser under ICF Nodes .
An example URL for RMTSAMPLEFLIGHT looks as follows:
SAP NetWeaver
SAP Gateway
OData
http://<host name>:<port>/sap/opu/odata/iwfnd/RMTSAMPLEFLIGHT;mo/
4. Make sure that the SAP_Origin field appears in the service's metadata.
SAP Gateway
OData Channel
Composition
You can use this parallelization of READ_ENTITYSET to several backend systems to achieve optimized performance. In the IMG activity you can set the
following configuration parameters:
Minimum Number of Backend Systems can have the following values:
0 : No parallelization
n : Parallelization will only be done from n backend systems onwards
The maximum number of parallel backend calls is always based on current resources of the SAP Gateway hub system. Additionally, you can use
parameter Maximum Number of Parallel Backend Calls to limit the use of current system resources. The default value zero ( 0 ) means it only depends
on current system resources.
Performance Improvement
In case of serialization the duration of a READ_ENTITYSET within a hub system is the sum of all backend calls. Contrary to this, the duration in parallel mode
is just the maximum duration of all backend calls and means a minimal overhead for parallelization.
Changesets
In the context of multiple origin composition, changesets are also supported. All changeset operations for one backend are collected and sent to this backend
via one RFC. You can find an example in SAP Note 1890049
Error Tolerance
You can flag READ feed requests of a service in MOC mode error-tolerant.
If a feed of a service is called in MOC mode, the service composes the data from all backend systems assigned to it. More precisely, all system aliases
assigned for the current user and service are identified. Then the backend system of each of these system aliases is called reading the data from each
system. Finally the results of each backend system are composed into one feed that is returned to the client.
To call a service in MOC mode the segment parameter ;mo is added to the service name of the request URI.
Syntax
Example:
01. /sap/opu/odata/iwfnd/RMTSAMPLEFLIGHT;mo/TravelagencyCollection
Error Behavior
The default error behavior is not error-tolerant. If the data retrieval from any of the backend systems causes an error the READ feed request returns that error.
If a service is marked to be error-tolerant this behavior changes:
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 35 of 95
An error is returned only if the data retrieval from all backend systems causes an error. Otherwise if only some of the backend systems causes an error
a feed is returned to the client.
The data retrieved successfully from some of the backend systems is composed into that feed.
The data missing form those backend systems that caused an error can be requested again. For that an OData skiptoken is added to that feed.
Syntax
Example:
01. <link rel="next" href=" TravelagencyCollection?$skiptoken=MISSING_DATA_FROM__1_2"/>
For this an IMG activity is available: On the SAP Gateway system, open the SAP Reference IMG in transaction SPRO and navigate to
SAP Gateway
OData Channel
Composition
SAP NetWeaver
If a service is not listed in this configuration the service is not error-tolerant. You can create an entry for each service that shall be error-tolerant.
More Information
Error Log
Example
The service created in the backend system is as follows:
Technical Service Name:
/IWBEP/TEA_TEST_APPLICATION
TEA_TEST_APPLICATION
Version:
0001
/IWBEP/
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 36 of 95
TEA_TEST_APPLICATION
Version:
0001
=MRMEYER
IV_SERVICE_ID
= ZTEA_TEST_APPLICATION_0001
The BAdI output would then be a table of system aliases which were changed by the BADI (or not changed) as a result of the standard routing.
Syntax
Sample coding throwing an exception in case of too much load on the backend system:
01.
/iwfnd/cx_mgw_dest_finder
= /iwfnd/cx_mgw_dest_finder=>backend_load_too_high
= /iwfnd/cx_mgw_dest_finder=>gc_status_service_unavailable
= lv_system_alias.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 37 of 95
For this the SAP Gateway Implementation Guide (MG) has been enhanced. In transaction SPRO open the SAP Reference IMG and navigate to
NetWeaver SAP Gateway Service Enablement
Services .
SAP
Note
You can also use an existing bgRFC destination in your SAP system to the host of SAP Gateway.
You can define this remote function call by using the implementation guide (IMG). In transaction SPRO open the SAP Reference IMG and navigate to
NetWeaver
Queues .
SAP
Prerequisites
Make sure that you have:
Defined an RFC destination to SAP Gateway to broadcast the events.
The system name, client ID, and a system alias of the host of the SAP Gateway landscape to which you want to connect.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 38 of 95
Prerequisites
You have created a system user of type B called BGRFCSUPER . Use transaction SU01 to create the system user. This user is used for the bgRFC
communication using the destination you will create. For example, BGRFC_SUPERVISOR .
You have assigned role SAP_BC_BGRFC_SUPERVISOR to user BGRFCSUPER . Use transaction SU01 to assign role to the user BGRFCSUPER .
For SAP NetWeaver 7.0, you have created a bgRFC destination as an ABAP connection, using the RFC destination name BGRFC_SUPERVISOR , without
load balancing, target host, SAP Gateway host and service.
Specify the user, language and password. This ensures that the scheduler is activated on the same application server as the specified user.
Later, you configure the supervisor destination for the bgRFC to receive the configuration settings for the bgRFC scheduler.
Note
The bgRFC supervisor user you specify must have authorizations from authorization object S_RFC. These are defined in role
SAP_BC_BGRFC_SUPERVISOR. The procedure you employ depends on the version of SAP NetWeaver in your system.
Create bgRFC
Proceed as follows:
1. Click on the Activity icon.
2. Select tab Define Supervisor Dest .
3. Depending on the version of SAP NetWeaver, do the following:
For SAP NetWeaver 7.02, choose Create . The Create bgRFC Destination for Supervisor window is displayed.
1. Choose Create User . For example, BGRFCSUPER .
2. Save your settings.
For SAP NetWeaver 7.0, make sure you have already created a separate bgRFC destination for the supervisor using the name
BGRFC_SUPERVISOR.
1. Enter the bgRFC supervisor destination name BGRFC_SUPERVISOR , in Destination under New Supervisor Destination .
2. Choose Enter . The supervisor destination and the user details display.
4. In the bgRFC Configuration window choose Save .
More Information
bgRFC (Background Remote Function Call)
Note
Application fault exceptions are displayed in the application itself.
Prerequisites
Make sure that you have the authorization object S_BGRFC for monitoring or customizing activities assigned to your user role.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 39 of 95
authorization role), or delete all the units inside the inbound destination.
You can monitor the bgRFC queues by using the implementation guide (IMG). In transaction SPRO open the SAP Reference IMG and navigate to
NetWeaver
SAP
.
Prerequisites
Following are the different components (along with their releases) required for SAP Gateway. You can download the packages and patches from the SAP
Service Marketplace at: http://service.sap.com/swdc
Component
Release
SAP ERP
SAP BI (optional)
BI 3.5 SP 22 or BI 7.0 - SP 17
SAP CRM
Configuration Settings
Workflow Services
Note
If you want to obtain notifications, you first need to configure the Business Enablement Provisioning (IW_BEP) component before configuring
Workflow. This is because Workflow for SAP Gateway is reliant on the BEP functionality. .
If you do not configure the IW_BEP component, you can still use the Workflow functionality, but you will not be able to use Push notifications.
If your system is based on SAP NetWeaver 7.40 or higher, you do not need to install the component IW_BEP since the SAP Gateway Foundation
component SAP_GWFND is installed as standard.
Workflow Settings
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 40 of 95
You create a role for an administrator user with permissions and privileges for several tasks including the following:
Analyze logs and identify potential issues with the ERP landscape.
Configure and maintain Workflow-specific ERP components and applications.
For more information about SAP user administrator types, see Setting Up User and Authorization Administrators in the SAP Help Portal.
Note
For all steps in the IMG there is always consumer independent documentation available.
To create the administrator role and assign it to users:
1. On the ERP system, open transaction PFCG . The Role Maintenance page is displayed.
2. In the Role field, enter any of the basis roles, for example:
SAP_BC_BASIS_ADMIN
SAP_BC_CTS_ADMIN
SAP_BC_BASIS_MONITORING
SAP_BC_BATCH_ADMIN
SAP_BC_BDC_ADMIN
SAP_BC_WEBSERVICE
You can choose any of the listed standard administrator roles, or enter an existing one.
3. Choose the
( Copy Role ) icon to create a copy of the standard role.
4. In the Query dialog box, enter a name for the new role in the to role field, for example, Z_SAP_BC_BASIS_ADMIN .
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
Choose Copy all . The Change Roles dialog box is displayed and the role is created.
In the Role Maintenance page, choose the Edit icon.
Select the Authorizations tab.
Choose Change Authorization Data under the Maintain Authorization Data and Generate Profiles section.
Select Edit > Insert Authorization(s) > From template . The Choose Template page is displayed.
Select /IWWRK/RT_WF_ADM from the list.
Choose the checkmark.
Choose Generate . The Generate profile dialog box is displayed.
Select the Generate option.
In the Assign Profile name for Generated Authorization Profile dialog, maintain the profile name according to your requirements. For example
T-SCL550003 .
15.
16.
17.
18.
19.
20.
21.
22.
Choose the checkmark. The Change role: Authorizations page is displayed. The status of the profile is displayed as Generated.
Go back to the Change Roles page, and select the Users tab in the User Assignment section.
Enter the names of the users you want to assign to this role.
Choose Save .
Choose User comparison . The Complete Role Master Record page is displayed.
Choose Complete comparison .
Choose Save .
Check that the role was properly created and assigned.
Recommendation
Log on to the ERP system using the user you just assigned. You should be able to access transaction SIMGH and search for the entry Workflow Pattern
Customization .
You can logon to the ERP host with the administrator user you have created to configure the ERP components and content, and install consumer
applications.
Recommendation
Log on to the ERP system using the user you just assigned. You should be able to access transaction SIMGH and search for the entry Workflow Pattern
Customization .
You can logon to the ERP host with the administrator user you have created to configure the ERP components and content, and install consumer
applications.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 41 of 95
Prerequisites
The following prerequisite must be complied with before you can send notifications:
Workflows containing User Decisions or Activity Steps, are configured in the system and can be triggered in the SAP Business Suite system.
After the notifications have been configured, you must subscribe to the relevant Workflow service as described in the Subscribing to Notification Types topic.
Note
The delivery address is that of the SAP connectivity service.
The SAP connectivity service on-demand component resides in the customer's on premise environment. It is responsible for enabling the connectivity from
the SAP connectivity service servers, located in SAP's on-demand environment, to the customer's SAP Gateway instance, located in customer's onpremise environment.
To create a type G RFC destination:
1. In the SAP Gateway system, open transaction SPRO.
2. Choose SAP Reference IMG .
3. Select
SAP Customizing Implementation Guide SAP NetWeaver SAP Gateway
SAP Gateway to Consumer Create RFC Destination for Outbound Queues .
4. Choose Execute. The Configuration of RFC Connections page is displayed.
5. Choose Create.
6. In the RFC Destination field, enter the desired name, for example GW_RFC .
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
OData Channel
Configuration
Connection Settings
In the Connection Type field, press F4 and select G HTTP Connection to External Server .
Under the Technical Settings tab, in the Description field, enter the desired description.
Press Enter.
An Information dialog box is displayed. Choose the checkmark to continue.
In the Target Host field, enter the host IP.
In the Service No. field, enter the port number.
In the Path Prefix field, enter any additional directories, if relevant.
If relevant, select the Logon & Security tab.
Enter the security settings as required.
Choose Save.
To continue with the flow, go to Configuring User Authorizations for Push Notifications.
Note
When creating a role in the SAP Business Suite system, make sure you use the Role Template.
1. In the SAP Business Suite system, open transaction PFCG.
2. In the Role field, enter name of role you want to create.
3. Choose Single Role .
4. Choose
Save.
5. Select the Authorizations tab and choose the Edit icon.
6.
7.
8.
9.
Choose Change Authorization Data under the Maintain Authorization Data and Generate Profiles section.
Select Edit > Insert Authorization(s) > From template . The Choose Template page is displayed.
Select /IWWRK/TR_WF_GW_USR from the list.
Choose the Adopt reference .
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 42 of 95
11. Choose
12. Choose
On to the SAP system, open transaction SM36. The Define Background Job page is displayed.
Choose Job wizard to create a new job.
In the wizards opening page, choose Continue .
In the Job Name field enter a name and choose Continue .
Select the ABAP program step radio button and choose Continue .
In the ABAP Program Name field enter the report name (RSWNSEL).
In the Variant field, enter the variant name, for example GW_VAR1 and choose Continue .
Check the Add additional steps (optional) checkbox, and choose Continue .
Select the ABAP program step radio button and choose Continue .
In the ABAP Program Name field enter the report name (/IWWRK/R_WF_ITEM_SELECTION_GW)
In the Variant field, enter the variant name, for example GW_VAR1 and choose Continue twice.
Select the Immediately radio button and choose Continue .
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 43 of 95
13. In the Periodic jobs section, select the Period checkbox and choose Continue .
14. Select None of the above and choose Other periods .
15. In the Minute(s) field, enter 15 .
16. Choose Create .
17. Choose Continue .
18. Choose Complete .
Updating Background Jobs
To update background jobs:
For help on updating a job, refer to the topic Background Job Monitoring Monitor on the SAP Library at
http://help.sap.com/saphelp_nw70ehp1/helpdata/en/1d/ab3207b610e3408fff44d6b1de15e6/frameset.htm
This is the last step in the configuration flow, go to Subscribing to Notification Types to subscribe to the relevant Workflow service.
Note
If your system landscape is based on SAP NetWeaver 7.40 or higher, you do not need to install the IW_BEP component in your system since the BEP
functionality is included in the core SAP Gateway component SAP_GWFND, which is installed as standard.
Workflow Configurations
You can perform the following configurations on the Workflow process:
Task Provider Customizing
Maintain Workflow Filter Settings
Maintain Task Names and Decision Options
Enable Task Filter
To reach these activities:
1. From your SAP system, open transaction SPRO.
2. Choose SAP Reference IMG .
3. Navigate to
SAP NetWeaver SAP Gateway Service Enablement
Content
Workflow Settings
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 44 of 95
3.
4.
5.
6.
7.
In the Providers section, enter the provider ID and select the Active checkbox.
Choose Save.
In the Dialog Structure section, select Provider Details .
Choose New Entries .
In the Provider Details table, enter the provider ID, the default internal service name, the version number, and the provider's description.
Note
If no specific service can be found for an item, the default service and version number is used instead.
8. Choose Save.
Defining the Provider Adapter Classes
1.
2.
3.
4.
5.
6.
Note
For user decision steps, these customizing settings are required only when the filter is active. When the filter is not active, all user decision items are read
and all notifications are sent.
Adding a new Workflow Task with its Corresponding ID to the Workflow Task Filter
You can add Workflow tasks and their corresponding IDs to the Workflow task filter. If the filter is active, only the Workflow items maintained in this list are
included in the query results. Notifications are sent to the SAP Gateway only for these items.
You can define a name to be displayed when reading a specific task. Names can be maintained in several languages. You can add names only in the
language in which you logged on to the system. If a task is read in a specific language in which no name is maintained, the name is read according to the
system kernel language. If no name is maintained for the system kernel language, the name consists of the Workflow and step ID.
To add the new Workflow task:
1. In the Dialog Structure section, select Step Name .
2. Choose New Entries .
3. In the Step Name section, enter the Workflow ID and step ID, and step description in the relevant columns.
Defining Decision Keys
You can use decision keys to help include steps in the user decision service. A decision can be applied to the task using these keys. The functionality is
carried out using the following enhancement spot customer implementation: /IWWRK/ES_WF_WI_BEFORE_UPD_IB.
The descriptions for the decision keys can be maintained in several languages. You can only enter text in the language in which you logged on to the system.
If a task is read in a specific language and no text is maintained for the decision key in this language, the text is read according to the system kernel
language.
To define decision keys:
1.
2.
3.
4.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 45 of 95
Procedure
1. Create a connection from the Business Process Content Powered by SAP Gateway system to the SAP Business Suite provider system.
For more information, see Connecting Business Process Content and Business Suite Systems.
2. Create a system alias for the SAP Business Suite system.
For more information, see Creating a System Alias.
3. Activate the process service for the SAP Business Suite system.
For more information, see Activating the Process Service.
4. If you want to enable a user to consume process context information, perform the following substeps:
1. Register the process context service for the SAP Business Suite system.
For more information, see Registering Process Context Service for Deployment Scenario 1.
2. Activate the process context service for the SAP Business Suite system.
For more information, see Activating the Process Context Service.
Prerequisites
A software version for the provider system ( SAP Business Suite system) is created and a mapping to the technical model of the Business Process
Content system is defined.
For more information, see:
Creating a Software Version for Provider System
Mapping the Software Version and Technical Model
Trusted RFC connection is enabled in the SAP Business Suite system.
Procedure
1. Log on to the Business Process Content Powered by SAP Gateway system.
2. In transaction SPRO open the SAP Reference IMG and navigate to
SAP NetWeaver
3.
4.
5.
6.
7.
8.
Content
Business
Process Enablement .
Expand the Process Service node.
Expand the required node.
Click the Create RFC Destination activity icon.
Choose Create .
In the RFC Destination field, enter a name for the RFC destination that you want to create.
In the Connection Type field, enter 3 .
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 46 of 95
Choose Display .
Choose Display > Change .
Choose New Entries .
In the Type field, select Software Version for Instance Manager .
In the Identifier field, enter a name for the software version.
In the Description field, enter a long text for the software version.
Save your settings.
Procedure
1. Log on to the SAP Gateway system.
2. Call transaction SPRO.
3. Choose SAP Reference IMG .
4. Choose
SAP Customizing Implementation Guide SAP NetWeaver SAP Gateway
OData Channel Development with IW_BEP
.
5. Click the Assign Data Provider to Data Model activity icon.
6. Choose Display > Change .
7. Choose New Entries .
8. In the Model Identifier field, enter a name for your model.
9. In the Type field, select (Adaptation) Data Provider .
10. In the Software Version field, enter the software version you created for your provider system.
11. In the Class/Interface field, select /IWFND/CL_MGW_RUNT_RCLNT_PRXY .
12. In the Description field, enter a long text.
13. Save the changes.
Registration
Prerequisites
You have configured a connection to the SAP Business Suite system.
Procedure
1. Create System Alias in SAP Gateway
1. Log on to the SAP Gateway system where Business Process Content Powered by SAP Gateway is deployed.
2. In transaction SPRO open the SAP Reference IMG and navigate to
SAP NetWeaver SAP Gateway Service Enablement
3.
4.
5.
6.
7.
8.
9.
Content
Business
Process Enablement .
Expand the Process Service node.
Click the Maintain System Alias activity icon.
Choose New Entries .
In the SAP System Alias field, enter a name for the alias.
In the Process Platform field, select Business Suite Process Observer Provider .
In the RFC Destination field, enter the RFC destination of the business suite system.
Save your settings.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 47 of 95
SAP NetWeaver
SAP Gateway
OData Channel
Configuration
Connection Settings
SAP Gateway to SAP System .
Click the Manage SAP System Aliases activity icon.
Choose New Entries .
In the SAP System Alias field, enter the name of the alias that you created.
In the Description field, enter a long text.
Select the For Local App checkbox.
In the RFC Destination field, enter NONE .
Prerequisites
You have created a system alias for the SAP Business Suite system.
Procedure
1. Log on to the SAP Gateway system.
2. In transaction SPRO open the SAP Reference IMG and navigate to
SAP NetWeaver
SAP Gateway
OData Channel
Administration
General
Settings .
3. Click the Activate and Maintain Services activity icon.
4. In the Service Catalog section, check if the ZPGW technical service name exists.
5. If ZPGW exists, perform the following substeps:
1. Select the ZPGW service.
2. Choose System Alias .
3. Choose New Entries .
4. In the Service Doc. Identifier field, enter ZPGW_0001 .
5. In the SAP System Alias field, select the alias of the provider system.
6. If ZPGW does not exist, perform the following substeps:
1. Choose Add Service .
2. In the System Alias field, select the alias of your provider system.
3. Press Enter .
4. Select the entry with technical service name /IWPGW/PGW .
5. In the Package field, enter $TMP .
6. Choose Continue .
7. Save your settings.
Procedure
1. Log on to the SAP Gateway system where Business Process Content Powered by SAP NetWeaver is deployed.
2. In transaction SPRO open the SAP Reference IMG and navigate to
SAP NetWeaver SAP Gateway Service Enablement
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
Content
Business
Process Enablement .
Expand the Process Context Service node.
Click the Register Context Service for Process Definition activity icon.
Choose Add Service .
In the System Alias field, select the alias of the required provider system.
Press Enter .
Select the process definition entry for which you want the system to retrieve the context details.
Choose Select .
Make a note of the value in the Technical Model Name field.
Press Enter .
Choose Yes for the confirmation message.
Choose Continue .
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 48 of 95
Prerequisites
You have created the system alias for the SAP Business Suite system.
Procedure
1. Log on to the SAP Gateway system.
2. In transaction SPRO open the SAP Reference IMG and navigate to
3.
4.
5.
6.
7.
SAP NetWeaver
SAP Gateway
OData Channel
Administration
General
Settings .
Click the Activate and Maintain Services activity icon.
Choose Add Service .
In the System Alias field, select the alias of the provider system.
In the Technical Service Name field, enter the service name you made a note of when registering the context service.
Press Enter .
8. In the Add Service section, select the technical service name entry.
9. In the Package field, enter $TMP .
10. Choose Continue .
Procedure
1. Create a connection from Business Process Content Powered by SAP Gateway system to SAP Business Suite system.
For more information, see Connecting Business Process Content and Business Suite Systems.
2. Create a system alias for the SAP Business Suite system in Business Process Content Powered by SAP Gateway system.
For more information, see Creating a System Alias for SAP Business Suite System.
3. Create a connection from SAP Gateway system to Business Process Content Powered by SAP Gateway system.
For more information, see Connecting SAP Gateway and Business Process Content.
4. Create a system alias for the Business Process Content Powered by SAP Gateway system in the SAP Gateway system.
For more information, see Creating a System Alias for Business Process Content System.
5. Activate the process service for the SAP Business Suite system.
For more information, see Activating the Process Service.
6. If you want to enable a user to consume process context information, perform the following substeps:
1. Register the process context service for the SAP Business Suite system.
For more information, see Registering Process Context Service for Deployment Scenario 2.
2. Activate the process context service for the SAP Business Suite system.
For more information, see Activating the Process Context Service.
Prerequisites
A software version for the provider system ( SAP Business Suite system) is created and a mapping to the technical model of the Business Process
Content system is defined.
For more information, see:
Creating a Software Version for Provider System
Mapping the Software Version and Technical Model
Trusted RFC connection is enabled in the SAP Business Suite system.
Procedure
1. Log on to the Business Process Content Powered by SAP Gateway system.
2. In transaction SPRO open the SAP Reference IMG and navigate to
SAP NetWeaver
3.
4.
5.
6.
7.
Content
Business
Process Enablement .
Expand the Process Service node.
Expand the required node.
Click the Create RFC Destination activity icon.
Choose Create .
In the RFC Destination field, enter a name for the RFC destination that you want to create.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 49 of 95
In the Target Host field, enter the server name of the business suite system.
In the System Number field, enter the instance number of the business suite system.
Choose the Logon & Security tab page.
Select the Current User checkbox.
Check that the Trust Relationship or Trusted System option is set to Yes .
Choose Display .
Choose Display > Change .
Choose New Entries .
In the Type field, select Software Version for Instance Manager .
In the Identifier field, enter a name for the software version.
In the Description field, enter a long text for the software version.
Save your settings.
Procedure
1. Log on to the SAP Gateway system.
2. Call transaction SPRO.
3. Choose SAP Reference IMG .
4. Choose
SAP Customizing Implementation Guide SAP NetWeaver SAP Gateway
OData Channel Development with IW_BEP
.
5. Click the Assign Data Provider to Data Model activity icon.
6. Choose Display > Change .
7. Choose New Entries .
8. In the Model Identifier field, enter a name for your model.
9. In the Type field, select (Adaptation) Data Provider .
10. In the Software Version field, enter the software version you created for your provider system.
11. In the Class/Interface field, select /IWFND/CL_MGW_RUNT_RCLNT_PRXY .
12. In the Description field, enter a long text.
13. Save the changes.
Registration
Procedure
1. Log on to the Business Process Content Powered by SAP Gateway system.
2. In transaction SPRO open the SAP Reference IMG and navigate to
SAP NetWeaver
3.
4.
5.
6.
7.
8.
Content
Business
Process Enablement .
Expand the Process Service node.
Click the Maintain System Alias activity icon.
Choose New Entries .
In the SAP System Alias field, enter a name for the alias.
In the Process Platform field, select Business Suite Process Observer Provider .
In the RFC Destination field, enter the RFC destination of the business suite system.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 50 of 95
Prerequisites
You have enabled a trusted RFC connection in the Business Process Content Powered by SAP Gateway system.
Procedure
1. Log on to the SAP Gateway system.
2. In transaction SPRO open the SAP Reference IMG and navigate to
3.
4.
5.
6.
SAP NetWeaver
SAP Gateway
OData Channel
Configuration
Connection Settings
SAP Gateway to SAP System .
Choose the Manage RFC Destinations activity icon.
Choose Create .
In the RFC Destination field, enter a name for the RFC destination you want to create.
In the Connection Type field, enter 3 .
In the Target Host field, enter the server name of the Business Process Content system.
In the System Number field, enter the instance number of the Business Process Content system.
Choose the Logon & Security tab page.
Select the Current User checkbox.
Check that the Trust Relationship option is set to Yes .
Procedure
1. Log on to the SAP Gateway system.
2. In transaction SPRO open the SAP Reference IMG and navigate to
3.
4.
5.
6.
7.
8.
SAP NetWeaver
SAP Gateway
OData Channel
Configuration
Connection Settings
SAP Gateway to SAP System .
Click the Manage SAP System Aliases activity icon.
Choose New Entries .
In the SAP System Alias field, enter the name of the alias that you created in the Business Process Content system.
In the Description field, enter a long text.
In the RFC Destination field, enter the RFC destination of Business Process Content system.
In the Software Version field, enter /IWPGW/PO .
Prerequisites
You have created a system alias for the SAP Business Suite system.
Procedure
1. Log on to the SAP Gateway system.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 51 of 95
SAP NetWeaver
SAP Gateway
OData Channel
Administration
General
Settings .
3. Click the Activate and Maintain Services activity icon.
4. In the Service Catalog section, check if the ZPGW technical service name exists.
5. If ZPGW exists, perform the following substeps:
1. Select the ZPGW service.
2. Choose System Alias .
3. Choose New Entries .
4. In the Service Doc. Identifier field, enter ZPGW_0001 .
5. In the SAP System Alias field, select the alias of the provider system.
6. If ZPGW does not exist, perform the following substeps:
1. Choose Add Service .
2. In the System Alias field, select the alias of your provider system.
3. Press Enter .
4. Select the entry with technical service name /IWPGW/PGW .
5. In the Package field, enter $TMP .
6. Choose Continue .
7. Save your settings.
Prerequisites
You have created the system alias for the SAP Business Suite system.
Procedure
1. Log on to the Business Process Content Powered by SAP Gateway system.
2. In transaction SPRO open the SAP Reference IMG and navigate to
SAP NetWeaver
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
Content
Business
Process Enablement .
Expand the Process Context Service node.
Click the Register Context Service for Process Definition activity icon.
Choose Add Service .
In the System Alias field, select the alias of the required business suite provider system.
Press Enter .
In the Add Context Service section, select the process definition for which you want to register the context service.
Press Enter .
Make a note of the value in the Technical Model Name field.
Press Enter .
Choose Yes for the confirmation message.
Prerequisites
You have created the system alias for the SAP Business Suite system.
Procedure
1. Log on to the SAP Gateway system.
2. In transaction SPRO open the SAP Reference IMG and navigate to
3.
4.
5.
6.
7.
SAP NetWeaver
SAP Gateway
OData Channel
Administration
General
Settings .
Click the Activate and Maintain Services activity icon.
Choose Add Service .
In the System Alias field, select the alias of the provider system.
In the Technical Service Name field, enter the service name you made a note of when registering the context service.
Press Enter .
8. In the Add Service section, select the technical service name entry.
9. In the Package field, enter $TMP .
10. Choose Continue .
Page 52 of 95
Value
PPFCODE
DISP
PLVAR
dummy
OTYPE
WS
INFOTYP
1000
SUBTYP
dummy
ISTAT
Prerequisites
If you have an SAP NetWeaver Business Process Management (BPM) system, you must create a logical port to it before installing the Task Gateway
service.
To integrate BPM, you require SAP NetWeaver 7.31 SP05 or higher.
To create a logical port:
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
In the Computer Name of Access URL field, enter the computer's name.
In the Port Number of Access URL field, enter the relevant port number.
Select the Consumer Security tab.
Under the Authentication Settings section, select the SAP Authentication Assertion Ticket radio button.
Note
For more information about SSO (Single Sign On), see the Administration for User Authentication and Single Sign-On (SSO) section.
22. Save the changes.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 53 of 95
Note
If you have an SAP NetWeaver BPM system, set WS Provider System as the RFC Destination.
Under Software Version , press F4 and select the relevant data provider (software version), for example, /IWPGW/BWF or/IWPGW/BPM (for a
BPM system).
7. Choose Save.
8. To create additional system aliases for other providers like BPM repeat steps 5 to 7.
To activate the service:
1. In the SAP Gateway system, open transaction SPRO.
2. Choose SAP Reference IMG .
3. Select
SAP Customizing Implementation Guide
4. Open the Activate and Maintain Services activity.
SAP NetWeaver
SAP Gateway
Registration
Copy the name that appears in the Technical Model Name field, you will need it to assign the software version to the service.
In the Package field, enter the package to which you want to assign the service.
Choose the checkmark. The Activate and Maintain Services page is displayed.
Under the ICF Nodes section, make sure the ODATA node status is set to Active .
Under the System Aliases section, make sure the system alias we activated is displayed.
Under Type , select (Adaptation) Data Provider from the drop-down list.
Under Software Version , press F4 and select the relevant software version for example /IWPGW/BPM or /IWPGW/BWF.
Under Class/Interface , enter /IWFND/CL_MGW_RUNT_RCLNT_PRXY.
Under Description , enter a description of the data model.
Under Model Name , enter enter the technical name you obtained in the previous step (To activate the service).
7. Choose Save.
8. To create additional software versions, repeat steps 5 to 7.
To add additional system aliases:
1. Create a new system alias as described in the procedure above.
2. In the SAP Gateway system, open transaction SPRO.
3. Choose SAP Reference IMG .
4. Select
SAP Customizing Implementation Guide SAP NetWeaver SAP Gateway
OData Channel OData Channel Development with
IW_BEP Registration .
5. Open the Activate and Maintain Services activity. The Activate and Maintain Services page is displayed.
6. In the Service Catalog table, search for TASKPROCESSING in the External Service Name column and select the entire line.
7. In the System Aliases section, choose
( Add System Alias ). The Change View Assign SAP System Aliases to OData Service:
Overview page is displayed.
8. Select an existing SAP system alias and choose Copy.
9. In the SAP System Alias field, press F4 and select the System Alias you have created.
10. In the Default System field, the checkbox does not need to be selected. If the checkbox is selected, the corresponding SAP system will be called by
default.
11. Choose
( Copy ).
12. Choose Save.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 54 of 95
Note
For the role template /IWPGW/RT_WF_USR, you must maintain the authorization object S_SERVICE with the object types IWSG and IWSV. For more
information, seeRoles in the SAP Gateway Landscape, section Assignment of Authorization Objects.
Once your service is activated you can navigate to the Task collection to get all your inbox tasks from the implemented providers, such as Business Workflow
and BPM. For example: http://<Server>:<Port>/sap/opu/odata/IWPGW/TASKPROCESSING;mo/TaskCollection
SAP
Note
If you want to create a system alias for an SAP Business Process Management (BPM) system, set WS Provider Systems (enter the
logical port you maintained in SOAMANAGER) and leave the RFC destination empty.
Under Software Version , use input help ( F4 ) and select the relevant data provider (software version), for example, /IWPGW/BWF for an SAP
Business Worfklow (BWF) system or /IWPGW/BPM for an SAP Business Process Management system.
7. Choose Save .
Note
To create additional system aliases for other providers such as SAP Business Workflow Management (BWF) or SAP Business Process Management
(BPM), repeat steps 5-7.
SAP NetWeaver
Gateway
OData Channel
Administration
General Settings
Note
If your system is based on SAP NetWeaver 7.40 or higher, choose
OData Channel Administration General Settings .
SAP NetWeaver
SAP Gateway
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 55 of 95
Result
After you have activated the service, you can navigate to the Task collection to get all your inbox tasks from the implemented providers such as SAP
Business Workflow and SAP Business Process Management (BPM).
Example
http://<Server>:<Port>/sap/opu/odata/IWPGW/TASKPROCESSING;mo;v=<version>/TaskCollection
SAP NetWeaver
Gateway
OData Channel
Administration
General Settings
Note
If your system is based on SAP NetWeaver 7.40 or higher, choose
OData Channel Administration General Settings .
SAP NetWeaver
SAP Gateway
4. Select the Assign Data Provider to Data Model activity. The Change View "Assign Data Provider to Data Model: Overview" screen is displayed.
5. Choose New Entries .
6. In the Assign Data Provider to Data Model table, enter the following:
Under Model Identifier , enter the technical model name defined when you activated the service followed by _0001_BE . For example,
<model identifier name>_0001_BE .
Under Type , select (Adaption) Data Provider from the drop-down list.
Under Software Version , use input help ( F4 ) and select the relevant software version, for example, /IWPGW/BWF or /IWPGW/BPM.
Under Class/Interface , enter /IWFND/CL_MGW_RUNT_RCLNT_PRXY.
Under Description , enter a description for the data model.
Under Model Name , enter the technical name specified when you activated the service.
7. Choose Save .
Note
To create additional software versions, repeat steps 5 to 7. For each system in your system landscape that is to be used with Task Gateway, you will
need to repeat these steps to ensure that the relevant software version is assigned. The software version dictates the provider that is to be called.
More Information
For information about how to activate a service, see Activating a Service.
SAP NetWeaver
Gateway
OData Channel
Administration
General Settings
Note
If your system is based on SAP NetWeaver 7.40 or higher, choose
OData Channel Administration General Settings .
SAP NetWeaver
SAP Gateway
5. Select the Activate and Maintain Services activity. The Activate and Maintain Service screen is displayed.
6. In the Service Catalog table, search for TASKPROCESSING in the External Service Name column and select the entire row.
7. In the System Aliases section, choose Add System Alias . The Change View "Assign SAP System Aliases to OData Service" Overview screen is
displayed.
8. Select an existing SAP system alias and choose Copy .
9. In the SAP System Alias field, use input help ( F4 ) and select the System Alias you have created.
10. In the Default System field, the checkbox does not need to be selected. If the checkbox is selected, the corresponding SAP system is called by
default.
11. Choose Enter .
12. Choose Save .
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 56 of 95
More Information
For information about how to create a new system alias, see Creating a System Alias.
SAP NetWeaver
Content
Task Gateway
Task
Result
If the Is User List Enabled column is selected, the user list is enabled and consequently a list of all users in the SAP Gateway system is available for
selection in the input help for Task Gateway.
If the Is User List Enabled column is not selected, the user list is disabled and consequently no input help containing user names is available for Task
Gateway. Consequently, it is necessary to enter the specific name for substitutes, for example.
Recommendation
We strongly recommend using the OData Channel (ODC) programming paradigm for all SAP Gateway development.
As of SAP Gateway 2.0 Support Package 05, you are strongly recommended to use the Service Builder (transaction SEGW) for your OData design-time
development . For more information, see SAP Gateway Service Builder.
Depending on whether you want to develop SAP Gateway content in an SAP Business Suite backend system or in an SAP Gateway hub system, you can
choose between embedded deployment or central hub deployment. For more information, see Embedded Versus Hub Deployment and Deployment
Options.
This section comprises the following information:
Generic Channel
Generic Channel Configuration
Code List
Configuration Settings for Generic Channel Scenarios
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 57 of 95
Configuration Settings
Employee
BAPI_HELPVALUES_GET
BAPI_ADDRESSEMPGETDETAILED
LIST
Material
Supported Releases
SAP ERP 2004 and higher
Note
The software requirements for few of
the Employee functions supported
differ. See Employee for more
information.
SAP ERP 2004 and higher
BAPI_MATERIAL_GET_ALL
BAPI_HELPVALUES_GET
Bill Of Material (BOM)
BAPI_MATERIAL_GETLIST
C1L3_READ_T416
BAPI_HELPVALUES_GET
CSEP_MAT_BOM_READ
ERP Document
BAPI_HELPVALUES_GET
BAPI_DOCUMENT_GETDETAIL2
CVAPI_DOC_CHECKIN
Sales Documents (Inquiry and
Configurations on SAP Gateway for SAP The following BAPIs are used:
Quotation)
ERP
BAPI_SALESORDER_GETLIST
BAPISDORDER_GETDETAILEDLIS
T
ERP Customer
Configurations on SAP Gateway for SAP The following BAPIs are used
ERP
BAPI_CUSTOMER_FIND
BAPI_CUSTOMER_GETLIST
BAPI_ADDRESSORG_GETDETAIL
BAPI_ADDRESSORG_CHANGE
Note
See ERP Sales Document for
supported operations and the
versions
SAP ERP 2004 and higher
Note
See ERP Customer for supported
operations and the versions
BAPI_CUSTOMER_GETDETAIL2
BAPI_BUSPARTNEREMPLOYE_GET
LIST
The following ESA Services are used:
CustomerERPBasicDataByIDQu
eryResponse_In_V2
CustomerBasicDataChangeReq
uestConfirmation_In
CustomerERPBankDetailsByID
QueryResponse_In
CustomerERPBankDetailsUpda
teRequestConfirmation_In
CustomerERPRelationshipCon
tactPersonByIDAndContactPe
rsonInternalIDQueryRespons
e_In)
CustomerERPRelationshipCon
tactPersonCreateRequestCon
firmation_In
CustomerERPRelationshipCon
tactPersonUpdateRequestCon
firmation_In_V1
CustomerERPRelationshipCon
tactPersonCancelRequestCon
firmation_In
Time Management
EmployeeTimeForEmployeeTim
eSheetByElementsQueryRespo
nse_In
EmployeeTimeSheetChangeReq
uestConfirmation_In
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 58 of 95
EmployeeTimeSheetAllowedWo
rkBreakDownStructureElemen
tByEmployeeQueryResponse_I
n
EmployeeTimeSheetAllowedRe
ceivingCostCentreByEmploye
eQueryResponse_In
EmployeeTimeSheetAllowedOr
derByEmployeeQueryResponse
_In
EmployeeTimeSheetAllowedRe
sourceClassByEmployeeQuery
Response_In
WorkAgreementSimpleByEleme
ntsQueryResponse_In
Note
1. You must be an SAP Gateway administrator or have an SAP user administrator to create the roles.
2. The roles must be defined/created on the SAP Gateway server.
3. If there is only one SAP ERP system and all the users on SAP Gateway should be able to access ERP functionality on this SAP ERP system
then role creation and assigning of roles to GSDO groups is optional but this is not recommended.
To create roles, proceed as follows:
1. Open transaction pfcg in the SAP Gateway system.
2.
3.
4.
5.
6.
7.
8.
Role Templates
Use the predefined role templates mentioned in the table below to create user roles for SAP ERP scenarios:
Template Name
Template For
/IWCNT/RT_USER_EMP
Employee
/IWCNT/RT_USER_MTL
Material
/IWCNT/RT_USER_BOM
Bill of Material
/IWCNT/RT_USER_DOC
ERP Document
/IWCNT/RT_USER_QUOT
/IWCNT/RT_USER_CUST
ERP Customer
/IWCNT/RT_USER_TIMA
Time Management
Authorizations
The user must have the following authorizations to access SAP Gateway system for SAP ERP scenarios:
SAP ERP Scenario
Service
Employee
/IWCNT/SG_EMPLOYEE_0001
Authorization Object
S_SERVICE
Authorization Values
SRV_NAME
754650500996EDE0D42ED48806D730
SRV_TYPE HT
Material
/IWCNT/SG_MATERIAL_0001
S_CODE
TCD SICF
S_SERVICE
SRV_NAMEDB44022B5B569F5B9219500599D4E7
SRV_TYPE-HT
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 59 of 95
/IWCNT/SG_BOM_0001
S_CODE
TCD-SICF
S_SERVICE
SRV_NAMEF235FE5EF7ED50DAE3B3F23CC1CA0E
SRV_TYPE-HT
ERP Document
/IWCNT/SG_DOCUMENT_0001
S_CODE
TCD-SICF
S_SERVICE
SRV_NAMEC2A96D9A6E6802A945D6E8904E190A
SRV_TYPE-HT
S_CODE
TCD-SICF
S_SERVICE
SRV NAME
E216D44A584CA3D8B8A6313AD0A6B0
SRV_TYPE-HT
ERP Customer
/IWCNT/SG_CUSTOMER_0001
S_CODE
TCD-SICF
S_SERVICE
SRV NAME-0C3ED4D55DD9C87D1290E95581DA8D
SRV_TYPE-HT
Time Management
/IWCNT/EMPLOYEETIMESHEET_0001
S_CODE
TCD-SICF
S_SERVICE
SRV_NAME
15DA80503D25C5D856CB6072DC9598,
56B1795EE40F0F7302DE059E7586FA
SRV_TYPE-HT
S_CODE
TCD-SICF
While creating role template in the SAP ERP system, include the authorizations provided in the table below. The user must have these authorizations to
access SAP ERP system for SAP ERP scenarios:
SAP ERP Scenario
Employee
Service
Authorization Object
S_RFC
Authorization Values
RFC_TYPE=FUGR/RFC_NAME=RH6
5/ ACTVT=16
RFC_TYPE=FUGR/RFC_NAME=BFH
V/ ACTVT=16
RFC_TYPE=FUGR/RFC_NAME=PAD
_ESA_SERVICES/ ACTVT=16
RFC_TYPE=FUGR/RFC_NAME=HRW
PC_EMPLOYEEPROFILE_45FF/
ACTVT=16
Material
S_RFC
RFC_TYPE=FUGR/RFC_NAME=BFH
V, BUS1001 and
BUS1001006/ACTVT=16
S_RFC
RFC_TYPE=FUGR/RFC_NAME=SU_
USER,CSEP,BUS1001 and
C1L6/ACTVT=16
ERP Document
S_RFC
RFC_TYPE=FUGR/RFC_NAME=CVB
API and CVAPI01/ACTVT=16
RFC_TYPE=FUGR/RFC_NAME=CVB
API and BAPT/ACTVT=16
RFC_TYPE=FUGR/RFC_NAME=CVB
API,CVAPI01 and
BAPT/ACTVT=16
S_TCODE
S_RFC
ERP Customer
S_RFC
RFC_TYPE=FUGR/RFC_NAME=203
2/ACTVT=16
RFC_TYPE=FUGR/RFC_NAME=LC0
1/ACTVT=16
RFC_TYPE=FUGR/RFC_NAME=SZA
K/ACTVT=16
RFC_TYPE=FUGR/RFC_NAME=BAP
T/ACTVT=16
RFC_TYPE=FUGR/RFC_NAME=101
1/ACTVT=16
RFC_TYPE=FUGR/RFC_NAME=SZA
M/ACTVT=16
RFC_TYPE=FUGR/RFC_NAME=SZA
L/ACTVT=16
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 60 of 95
RFC_TYPE=FUGR/RFC_NAME=203
2/ACTVT=16
ECC_CUSTBASICDATABYIDQR_V2
SRV Name
S_SERVICE
228A5E185E0CFF7B36C96C854BD1C7
SRV Type HS
Time Management
ECC_WORKAGSIMPLERELEMENTSQR
S_TCODE
TCD=XD03
S_SERVICE
SRV Name
583824D652C5AF040CDB5E6A3938C8
SRV Type HS
ECC_EMPTIMFEMPTIMSHEETELEQR
SRV Name
S_SERVICE
C0972E83D4383710F9FD8B8FB78280
SRV Type HS
ECC_EMPTIMSHEETCHGRC
SRV Name
S_SERVICE
E564B11456D8E712E179A6EF4CBFC4
SRV Type HS
SAP NetWeaver
Field
SAP Gateway
OData Channel
Configuration
Description
RFC Destination
Connection type
Description
SAP NetWeaver
Field
SAP Gateway
OData Channel
Configuration
Description
Description
Local SAP GW
Leave unchecked if the SAP ERP system is not on the same system as the SAP
Gateway system.
RFC Destination
Specify the RFC destination defined for your SAP system, for example,
BKDCNT200 .
WS Provider
Leave it blank.
Software Version
Enter Default .
SAP NetWeaver
SAP Gateway
Employee
/IWCNT/SG_EMPLOYEE_0001
Material
/IWCNT/SG_MATERIAL_0001
/IWCNT/SG_BOM_0001
ERP Document
/IWCNT/SG_DOCUMENT_0001
Sales Documents
/IWCNT/SG_ERPSALES_0001
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Former Development
OData Channel
Page 61 of 95
Customer
/IWCNT/SG_CUSTOMER_0001
Service Name
Employee
Employee
Material
Material
Billofmaterial
ERP Document
Document
Sales Documents
ERPSALES
Customer
CUSTOMER
3. Choose Execute .
4. In the Maintain service window, under Virtual Host/Services section, select the last node and right click.
5. Choose the option Activate Service .
Prerequisites
Configurations for Time Management
Configurations on SAP Gateway - OData Channel
Configurations on the SAP ERP System (Provider System) for Time Management - OData Channel
Configurations on the SAP Gateway System (Consumer System) for Time Management - OData Channel
Reference
For more information, see SAP Library for SAP ERP on SAP Help Portal at http://help.sap.com/erp.
In SAP Portal,
SAP ERP SAP ERP Central Component (Open the documentation)
Resources
Choose Personnel Time Management .
Expand Human
SAP NetWeaver
SAP Gateway
OData Channel
Configuration
Description
RFC Destination
Connection type
Description
Configuration
Description
Description
Local SAP GW
Leave unchecked if the SAP ERP system is not on the same system as the SAP
Gateway system.
RFC Destination
Specify the RFC destination defined for your SAP system, for example,
BKDCNT200.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 62 of 95
WS Provider
Leave it blank.
Software Version
Enter Default .
SAP NetWeaver
SAP Gateway
Former Development
OData Channel
Note
The WSIL (Web Service Inspection Language) service lists the configuration of all web services exposed by the system.
5. Choose WSIL folder and right click and select Test Service .
6. A browser window opens, copy the URL from this browser. This is the WSIL URL.
6. Obtaining the external key of the provider system.
Continue with, Configurations on the SAP Gateway System (Consumer System) for Time Management - OData Channel
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 63 of 95
Note
You must import the same profile created in the provider system, else mass configuration of web service proxies in the service groups is not
possible.
2. Creating a system connection to the Provider system
3. User account management
4. Importing a business scenario Configuration XML or Configuring service groups using business scenarios/ You can either manually configure service
groups using a business scenario or import a business scenario configuration XML.
5. Verifying logical ports
6. Assigning system aliases:
1. In transaction SPRO open the SAP Reference IMG and navigate to:
SAP NetWeaver SAP Gateway
Former Development Generic
Channel
Administration General Settings
Manage GSDO Groups
and click the Activity icon.
2. Choose Assign GSDOs , the added GSDO will be present in the list.
3. Select the GSDO Type and click Assign SAP System Alias :
User Role: A specific User Role can be maintained which is checked to link to the designated system.
SAP System Alias: Add the Provider System's name.
4. Select the System Alias and click Assign User Roles: User Roles can be defined here.
Blank: Refers to All Roles .
7. Configuring Destination Finder:
The Provider systems configured from SOA Manager have to be entered in the configuration of the Destination Finder so that during runtime, SAP
Gateway can select the right provider system for a given system alias. This activity allows you to define RFC destinations that point to relevant SAP
business systems. If an RFC destination points to an SAP system alias that system alias points to the corresponding SAP business system.
Note
Only RFC destinations of connection type 3 (Connection to ABAP System) can be used.
1. In transaction SPRO open the SAP Reference IMG and navigate to:
2.
3.
4.
5.
6.
7.
8.
9.
SAP NetWeaver
SAP Gateway
Former Development
Channel
Configuration Connection Settings
SAP Gateway to SAP System Manage RFC Destinations
Create a New RFC connection by specifying the RFC Destination and Connection Type .
Save the new RFC connection.
Go back to the SAP Gateway to SAP System activity.
Execute the Manage System Aliases IMG Activity.
Create a new System Alias by selecting the New Entries button.
Provide the created RFC connection.
Enter the Provider system's name for the system alias.
Save the settings.
Generic
Prerequisites
Before using the Customer service, the following configurations should be completed:
Configurations for ERP Customer on the SAP Gateway Sys
Configurations for ERP Customer on the SAP ERP System (Provider)
SAP NetWeaver
SAP Gateway
OData Channel
Configuration
Field
Description
RFC Destination
Connection type
Description
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 64 of 95
1. In transaction SPRO, open the SAP Reference IMG and navigate to:
Connection Settings
SAP Gateway to SAP System
2. Choose New Entries .
3. Enter the following details for the System Alias:
SAP NetWeaver
Fields
SAP Gateway
OData Channel
Configuration
Description
Description
Local SAP GW
Leave unchecked if the SAP ERP system is not on the same system as the SAP
Gateway system.
RFC Destination
Specify the RFC destination defined for your SAP system, for example,
BKDCNT200.
WS Provider
Give the Provider system name that is created in the SAP Gateway SOA
Manager configurations. Refer the SOA Manager Configurations documentation
at http://help.sap.com .
Navigate to:
SAP NetWeaver
SAP Gateway
SAP Gateway 2.0 Library
SAP Gateway Configuration Guide
Configuration Settings for SAP Gateway
Supported Applications
SOA Management Configurations on the SAP
Gateway System
Creating a System Connection to Provider System .
Software Version
Verify the Software Version to set for your Data Model in the following path: In
transaction SPRO, open the SAP Reference IMG and navigate to SAP
NetWeaver
SAP Gateway
OData Channel
OData Channel
Development without IW_BEP
Registration
Assign Data Provider to Data
Model : and click the Activity icon. Select your Data Model and verify the
Software Version:
DEFAULT is for ERP version between ECC 5.0 to ECC6.0 EhP2
ECC_604 for ERP versions from ECC6.0 EhP3
SAP NetWeaver
SAP Gateway
Former Development
OData Channel
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 65 of 95
4. Choose Execute .
Note
The WSIL (Web Service Inspection Language) service lists the configuration of all web services exposed by the system.
5. Choose WSIL folder and right click and select Test Service .
6. A browser window opens, copy the URL from this browser. This is the WSIL URL.
6. Obtaining the external key of the provider system.
Continue with, Configurations for ERP Customer on the SAP Gateway Sys
Note
You must import the same profile created in the provider system, else mass configuration of web service proxies in the service groups is not
possible.
2. Creating a system connection to the Provider system
3. User account management
4. Importing a business scenario Configuration XML or Configuring service groups using business scenarios/ You can either manually configure service
groups using a business scenario or import a business scenario configuration XML.
5. Verifying logical ports
6. Configuring Destination Finder:
The Provider systems configured from SOA Manager have to be entered in the configuration of the Destination Finder so that during runtime, SAP
Gateway can select the right provider system for a given system alias. This activity allows you to define RFC destinations that point to relevant SAP
business systems. If an RFC destination points to an SAP system alias, that system alias will point to the corresponding SAP business system.
Note
Only RFC destinations of connection type 3 (Connection to ABAP System) can be used.
1. In transaction SPRO open the SAP Reference IMG and navigate to:
2.
3.
4.
5.
6.
7.
8.
9.
SAP NetWeaver
SAP Gateway
OData Channel
Configuration
Connection Settings
SAP Gateway to SAP System Manage RFC Destinations
and click the Activity icon.
Create a New RFC connection by specifying the RFC Destination and Connection Type .
Save the new RFC connection.
Go back to the SAP Gateway to SAP System activity.
Execute the Manage System Aliases IMG Activity.
Create a new System Alias by selecting the New Entries button.
Provide the created RFC connection.
Enter the Provider system's name for the system alias.
Save the settings.
Configuration
Field
Description
RFC Destination
Connection type
Description
SAP Gateway
OData Channel
and click on the Activity icon.
Configuration
Description
Description
Descriptive text for the system alias. For example, System alias for ERP Sales
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 66 of 95
Document
Local SAP GW
Leave unchecked if the SAP ERP system is not on the same system as the SAP
Gateway system.
RFC Destination
Specify the RFC destination defined for your SAP system, for example,
BKDCNT200.
WS Provider
Give the Provider system name that is created in the SAP Gateway SOA
Manager configurations. Refer the SOA Manager Configurations documentation
at http://help.sap.com .
Navigate to:
SAP NetWeaver
SAP Gateway
SAP Gateway 2.0 Library
SAP Gateway Configuration Guide
Configuration Settings for SAP Gateway
Supported Applications
SOA Management Configurations on the SAP
Gateway System
Creating a System Connection to Provider System .
Software Version
Verify the Software Version to set for your Data Model in the following path: In
transaction SPRO open the SAP Reference IMG and navigate to SAP
NetWeaver
SAP Gateway
OData Channel
OData Channel
Development without IW_BEP
Registration
Assign Data Provider to Data
Model : and click on the Activity icon. Select your Data Model and verify the
Software Version:
DEFAULT is for ERP version between ECC 5.0 to ECC6.0 EhP2
ECC_604 for ERP versions from ECC6.0 EhP3
More Information
Working with the SOA Manager
Time Management
1584236
File Details
Folder Name Time.zip
File Name profile_IWCNT_1 .xml
Leave Management
1588250
Code List
1588117
ERP Customer
0001670653
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 67 of 95
ERP Contact
0001670653
1. On the Provider system, navigate to the SAP Note Assistant to download the template file using the SAP note number provided above.
2. Download the XML file and save it.
3. Open transaction SOAMANAGER.
4.
5.
6.
7.
8.
9.
Navigate to
Technical Administration tab Profile Management .
Choose Import .
In the SOA Management window, Browse and select the downloaded template file.
Choose Import to complete the import process.
Browse for the file in the SOA Management window and Import .
Activate the Profile.
More Information
Configurations on the SAP Gateway system (Provider system) for:
OData Channel Scenarios:
Time Management
ERP Customer
Generic Channel Scenarios:
Time Management
Leave Management
Code List
Configurations for ERP Customer- OData Channel
Creating and Distributing a Profile in SAP NetWeaver 701 (SAP NetWeaver 700 EHP1), SAP NetWeaver 711 (SAP
NetWeaver 710 EHP1) and Higher Releases
To create and distribute a new profile proceed as follows:
1. On the Provider system, open transaction SOAMANAGER.
2.
3.
4.
5.
6.
Navigate to
Technical Configuration tab Profile Management .
Choose Create to create a new profile.
Enter a Name and Version for the Profile.
Specify settings for Messaging , Transport Settings as needed for your company and the landscape.
Configure the Security details as follows:
Select the SAP Logon Ticket check box
Select the Secure Communication Only check box to enable SSL.
Note
The selected authentication method must support single sign-on. This may also require trust to be configured between the SAP Gateway and the
SAP systems.
7. Click Save to save the profile.
The Profile Activate confirmation window displays.
8. Click Yes to activate the profile.
Note
After creation of profile you need to logout and logon again into the SOA Management for the new profile to be visible for assignment.
9.
10.
11.
12.
Navigate to
Technical Administration tab Profile Management .
Choose New Profile to create a new profile.
Enter a Name and Description for the Profile.
Ensure that the Transport binding properties has the following values:
Property
Value
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 68 of 95
ProxyHost
proxy
ProxyPort
8080
Note
If you want to change a profile, you must create a new version of it. By activating a new version, the provider systems and all other pieces of configuration
that use the profile still use an old version. You must go to the configuration of each provider system and configure it to use the new version of the profile.
You must also activate all dependent objects if required. This has to be done in all systems in the landscape after the distribution of the new profile version
More Information
Configurations on the SAP Gateway system (Provider system) for:
OData Channel Scenarios:
Time Management
ERP Customer
Generic Channel Scenarios:
Time Management
Leave Management
Code List
Configurations for ERP Customer- OData Channel
Time Management
1584236
Leave Management
1588250
File Name
Folder Name Time.zip
File Name scenario_IWCNT_TIMA_BSC.xml
Folder Name Leave.zip
File Name scenario_IWCNT_LEMA_BSC.xml
Code List
1588117
ERP Customer
0001670653
ERP Contact
0001670653
Navigate to
Service Administration tab Business Scenario Configuration .
Choose Import .
In the SOA Management window, Browse and select the downloaded template file.
Choose Import to complete the import process.
The Configuration Scenario Details screen displays at the bottom of the screen.
Choose the Provider tab and select all the services.
Choose Assign .
The list of Profiles in your system is displayed below.
Select the profile that you have created already, and click Assign to Service .
Choose Save .
The Profile Activate confirmation window displays.
Click Yes to activate the profile.
You are redirected to SOA Configuration Request Queue Management screen.
Choose Start request Queue processing to start endpoint creation.
More Information
Configurations on the SAP Gateway system (Provider system) for:
OData Channel Scenarios:
Time Management
ERP Customer
Generic Channel Scenarios:
Time Management
Leave Management
Code List
Configurations for ERP Customer- OData Channel
Page 69 of 95
Navigate to
Service Administration tab Business Scenario Configuration
Choose New .
Enter a Name and Description for the Business Scenario.
Click Next to configure the Provider side .
Click Add to search for each service that is consumed by SAP Gateway.
The following services should be added:
Time Management
Leave Management
Codelist
ERP Customer
ERP Contact
IWCNT/CO_BPC_CUSTOM_CHG_
IWCNT/CO_BPC_CONT_BYID_Q
imeSheetByElementsQueryR elRequestConfirmation_In
RC_OB
R_OB
esponse_In
WorkAgreementSimpleByEle EmployeeLeaveRequestByID -
IWCNT/CO_BPC_CUSTD_BYID_ IWCNT/CO_BPC_CONT_CNC_RC
mentsQueryResponse_In
QR_OB
QueryResponse_In
_OB
EmployeeTimeSheetChangeR WorkAgreementSimpleByEle -
/IWCNT/CO_KNA1_BANK_CHG_ IWCNT/CO_BPC_CONT_CRT_RC
equestConfirmation_In
RC_OB
mentsQueryResponse_In
_OB
EmployeeTimeSheetAllowed EmployeeLeaveRequestUpda -
/IWCNT/CO_KNA1_BANK_READ IWCNT/CO_BPC_CONT_CHG_RC
OrderByEmployeeQueryResp teRequestConfirmation_In
_QR_OB
_OB
onse_In
EmployeeTimeSheetAllowed EmployeeLeaveRequestByPa WorkBreakDownStructureEl rticipantQueryResponse_I
ementByEmployeeQueryResp n
onse_In
EmployeeTimeSheetAllowed EmployeeLeaveRequestCrea ResourceClassByEmployeeQ teRequestConfirmation_In
ueryResponse_In
EmployeeTimeSheetAllowed EmployeeLeaveRequestConf ReceivingCostCentreByEmp igurationByEmployeeQuery
loyeeQueryResponse_In
7.
8.
9.
10.
11.
12.
13.
Response_In
More Information
Configurations on the SAP Gateway system (Provider system) for:
OData Channel Scenarios:
Time Management
ERP Customer
Generic Channel Scenarios:
Time Management
Leave Management
Code List
Configurations for ERP Customer- OData Channel
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 70 of 95
More Information
Configurations on the SAP Gateway system (Provider system) for:
OData Channel Scenarios:
Time Management
ERP Customer
Generic Channel Scenarios:
Time Management
Leave Management
Code List
Configurations for ERP Customer- OData Channel
More Information
Configurations on the SAP Gateway system (Provider system) for:
OData Channel Scenarios:
Time Management
ERP Customer
Generic Channel Scenarios:
Time Management
Leave Management
Code List
Configurations for ERP Customer- OData Channel
More Information
Working with the SOA Manager
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 71 of 95
Application
Time Management
1584236
File Details
Folder Name Time.zip
File Name profile_IWCNT_1 .xml
Leave Management
1588250
Code List
1588117
ERP Customer
0001670653
ERP Contact
0001670653
1. On the Consumer system, navigate to the SAP Note Assistant to download the template file using the provided SAP Note number.
2. Download the XML file and save it.
3. Open transaction SOAMANAGER.
4. Navigate to
Technical Administration tab
5. Choose Import .
Profile Management
Note
After importing the profile you need to logout and logon again into the SOA Management for the new profile to be visible for assignment.
6. In the SOA Management window, Browse and select the downloaded template file for assignment.
More Information
Configurations on the SAP Gateway system (Consumer system) for:
OData Channel Scenarios:
Time Management
ERP Consumer
Generic Channel Scenarios:
Time Management
Leave Management
Code List
Configurations for ERP Customer- OData Channel
10.
Navigate to
Technical Administration tab System Connections .
Choose New to create a new Provider system.
Enter a name and description for the Provider system, and choose the right profile name.
Choose Next .
Select your Provider system listed in the SLD Identifier field.
If your Provider system is not in the list, enter a name for your Provider system that uniquely identifies it.
Enter the name of the WSIL URL of your SAP ERP system. See section
Obtaining WSIL URL of the Provider System
in Configurations on the
SAP ERP System (Provider System) to obtain WSIL URL of the Provider System
Enter all required credentials. Choose Next .
Create a business application named Default .
An external key is required that identifies the Provider system.
To get the external key of the Provider system, perform the steps described in the section Obtaining the external key of the Provider system.
In the next steps, choose a configuration that suits your company's requirements and landscape setup.
More Information
Configurations on the SAP Gateway system (Consumer system) for:
OData Channel Scenarios:
Time Management
ERP Consumer
Generic Channel Scenarios:
Time Management
Leave Management
Code List
Configurations for ERP Customer- OData Channel
Page 72 of 95
User accounts have to be configured with the type of user authentication that takes place when the Consumer system calls the web services on the Provider
system. The following three options are offered.
Business User: The user logged on to the SAP Gateway also logs on the SAP system using their own user and credentials.
Anonymous user: The SAP system is called with an anonymous user.
Service User: The SAP system is called with a predefined service user.
For setting up the communication from the Consumer systems to the Provider systems, only the Business User option is required.
Navigate to
Service Administration User Account Management
To create a new user account, choose New .
Enter a name for the user account.
In the next step, select Business User .
Activate the account.
Go to the Account Assignment tab.
Click New to create a new interface assignment.
In the Business Application field, press F4 and select the Provider system you created in the Creating a System Connection to Provider System.
Select Assign to all services within this business application.
Choose Next .
From the Account drop-down list, select the account you have just created.
Click Finish .
More Information
Configurations on the SAP Gateway system (Consumer system) for:
OData Channel Scenarios:
Time Management
ERP Consumer
Generic Channel Scenarios:
Time Management
Leave Management
Code List
Configurations for ERP Customer- OData Channel
Time Management
1584236
File Name
Folder Name Time.zip
File Name scenario_IWCNT_TIMA_BS.xml
Leave Management
1588250
Code List
1588117
ERP Customer
0001670653
ERP Contact
0001670653
Navigate to
Service Administration tab Business Scenario Configuration .
Choose Import .
In the SOA Management window, Browse and select the downloaded template file.
Choose Import to complete the import process.
Click Save .
Note
A dialogue box appears prompting you to activate the business scenario. You are then redirected to SOA Configuration Request Queue
Management screen where you need to click Start request Queue processing to start logical port creation.
More Information
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 73 of 95
Navigate to
Service Administration tab Business Scenario Configuration .
Choose New .
Enter a Name and Description for the Business Scenario.
Choose Next and skip the Provider side configuration.
Choose Add to add the service groups for the following applications:
/IWCNT/SG_TIME_MGMT service group to the work list for Time Management
/IWCNT/SG_LEAVE_MANAGEMENT for Leave Management
/IWCNT/CODELIST_SERVICE_GROUP for Code List
8. One service group (that is, one set of Web service consumer proxies) may point to many Provider systems. Perform the following steps for each
provider system.
1. Add the service group.
2. Choose Assign Business Application . Select the Business scenario that was created when creating the provider system.
9. Activate the Business Scenario.
10. Choose Check Processing State to monitor pending activities.
11. Choose Start request Queue processing to trigger the creation of Logical Ports for each Web service consumer proxy and provider system
More Information
Configurations on the SAP Gateway system (Consumer system) for:
OData Channel Scenarios:
Time Management
ERP Consumer
Generic Channel Scenarios:
Time Management
Leave Management
Code List
Configurations for ERP Customer- OData Channel
More Information
Configurations on the SAP Gateway system (Consumer system) for:
OData Channel Scenarios:
Time Management
ERP Consumer
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 74 of 95
User Settings
Connection Settings
Administration
Subscription Settings
General Settings
Logging Settings
Cache Settings
Support Utilities
Error Log
Traces
Application Log
Apart from basic configuration settings the Generic Channel configuration activities for the SAP Business Suite backend system are listed in the
Implementation Guide (IMG) in the backend system where software component IW_BEP is deployed. In the SAP Reference IMG navigate to
SAP
NetWeaver
Generic Channel
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 75 of 95
Event Definition
Event Type Linkages
Logging Settings
Support Utilities
Application Log
Clear Cache
More Information
Basic Configuration Settings
OData Channel Configuration
SAP NetWeaver
SAP Gateway
Former Development
Generic Channel
To check that you have successfully defined the idempotent services settings, carry out the following steps:
1. In transaction SM37 enter SAP_BC_IDP_WS_SWITCH* as the Job name and * as the User name .
2. Choose Execute .
A list with all scheduled jobs SAP_BC_IDP_WS_SWITCH_BD and SAP_BC_IDP_WS_SWITCH_BDID is displayed.
SAP NetWeaver
SAP Gateway
Former Development
Generic Channel
Choose Enter .
On tab Technical Settings enter the SAP Gateway host in the Target Host field.
In the Service No. field, enter the HTTP port.
In the Path Prefix field, enter the path of the local WSIL service, for example, /sap/bc/srt/wsil .
Note
The WSIL service lists the configuration of all Web Services exposed by the system.
The /SAP/BC/SRT/WSIL service must have been activated in transaction SICF.
To obtain the WSIL URL, carry out the following steps:
1. Log on to the SAP system you specified as a provider, and enter transaction SICF.
2. Enter WSIL for the Service Name and choose Execute .
The WSIL service is now displayed in the HTTP service tree.
3. Double-click on the WSIL entry to obtain its URL.
The path for the WSIL service is displayed: /default_host/sap/bc/srt/
The default value for the URL is: http://<host name:port>/sap/bc/srt/wsil
10. Save your settings.
To check that you have successfully created an RFC destination for the WSIL, select Connection Test . The test result displayed on the Test Result tab
should contain Status HTTP Response 200.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 76 of 95
You have to specify which content is being enabled by assigning a SAP system alias. You can also activate framework services such as metadata.
1. In transaction SPRO open the SAP Reference IMG and navigate to:
2.
3.
4.
5.
6.
7.
8.
SAP NetWeaver
SAP Gateway
Former Development
Generic Channel
Check
Assigned RFC
Checks if a system alias has a Web Service provider system assigned to it.
RFC test
To check the configuration for aliases for a SAP system, proceed as follows:
In transaction SPRO open the SAP Reference IMG and navigate to:
Configuration
Connection Settings
SAP NetWeaver
SAP Gateway
Former Development
Generic Channel
More Information
Creating the System Alias for Applications
SAP NetWeaver
SAP Gateway
Former Development
Generic Channel
Configuration
Subscription Settings
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 77 of 95
Example
For Partner Roles, the Entity Provider Class can be named as:
IWCNT/CL_CLST_EPRRQ_PROLES
The mv_domain_name variable of this class can be set to:
/SAPTRX/EV_PARROL
And the mv_value_help_source_category variable can be set to:
02
This indicates that the domain with fixed values will be used to fetch the code list in the:
SET_VALUE_HELP_SOURCE method of the class
This domain name would be used in order to fetch the value help for Partner Roles.
Example
Value Help Source is Domain
In order to fetch the list of valid values for Partner Roles, the following values need to be set in the SET_VALUE_HELP_SOURCE method of the class.
MV_VALUE_HELP_SOURCE_CATEGORY = '02'
MV_DOMAIN_NAME = /SAPTRX/EV_PARROL
Example
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 78 of 95
Example
Value Help Source is from QueryCodeList- ESA service
MV_VALUE_HELP_SOURCE_CATEGORY = '03'
MV_ESA_NAME = 'CountryCode'
MV_ESA_TYPE = 'CountryCode'
MV_ESA_NAMESPACE = 'http://sap.com/xi/APPL'
Example
1. Registering Backend Connectivity API for fetching Code List for Gender from a Domain with fixed values
Implement the following code in the Entity Provider Class:
Syntax
01. DATA: ls_mapping_specialist_attr TYPE LINE OF gtyt_map_specialist_attributes.
DATA: lo_clst_bec_dom TYPE REF TO /iwcnt/cl_clst_bec_dom.
ls_mapping_specialist_attr-execution_mode = /iwcnt/if_common_c=>gc_execution_mode_q.
ls_mapping_specialist_attr-bop_type = /iwfnd/if_mgw_bec_bop=>gc_bop_type_custom.
CREATE OBJECT lo_clst_bec_dom
EXPORTING
iv_code_name
= 'Gender'
iv_domain_name = 'AD_SEX'.
ls_mapping_specialist_attr-be_api_ref ?= lo_clst_bec_dom.
APPEND ls_mapping_specialist_attr TO et_mapping_specialist_attr.
Once the backend API has been registered, the Code List can be accessed via the IT_PROCESSED_BE_DATA parameter in the respective mapping
specialists.
Syntax
01. DATA: ls_processed_be_data LIKE LINE OF it_processed_be_data,
lt_gender_codes TYPE /iwcnt/t_clst_attr.
FIELD-SYMBOLS:<ls_processed_be_value> Type any.
READ TABLE it_processed_be_data INTO ls_processed_be_data
WITH KEY name = 'Gender'.
IF sy-subrc = 0.
ASSIGN ls_processed_be_data-value->* TO <ls_processed_be_value>.
lt_gender_codes[] = <ls_processed_be_value>
ENDIF.
The internal tablelt_gender_codes [][] will now contain the gender codes fetched from the fixed values associated with the domain AD_SEX.
2. Registering Backend Connectivity API for fetching Code List from a BAPI Parameter.
Implement the following code to register the Backend Connectivity API for fetching Code List from a BAPI parameter in the
REGISTER_MAPPING_SPECIALISTS method of the entity provider class.
Syntax
01. DATA: ls_mapping_specialist_attr TYPE LINE OF gtyt_map_specialist_attributes.
DATA: lo_clst_bec_bapi TYPE REF TO /iwcnt/cl_clst_bec_bapi.
ls_mapping_specialist_attr-execution_mode = /iwcnt/if_common_c=>gc_execution_mode_q
ls_mapping_specialist_attr-bop_type = /iwfnd/if_mgw_bec_bop=>gc_bop_type_custom.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 79 of 95
Syntax
01. DATA: ls_processed_be_data LIKE LINE OF it_processed_be_data,
lt_gender_codes TYPE /iwcnt/t_clst_attr.
FIELD-SYMBOLS:<ls_processed_be_value> Type any.
READ TABLE it_processed_be_data INTO ls_processed_be_data
WITH KEY name = 'TitleCode'.
IF sy-subrc = 0.
ASSIGN ls_processed_be_data-value->* TO <ls_processed_be_value>.
lt_title_codes[] = <ls_processed_be_value>
ENDIF.
The internal table lt_title_codes[] will now contain the Title codes fetched from the value help associated with the BAPI parameter.
Example
A UC model for Partner roles can be named /IWCNT/PARTNER_ROLES_0001_UC and this model would be created with reference to
/IWCNT/MGW_CODE LIST _0001_PS.
Registration
The Entity Provider Class /IWCNT/CL_CLST_EPRRQ_PROLES and the SAP Gateway Consumption model /IWCNT/PARTNER_ROLES_0001_UC is then
registered in the transaction:
SPRO SAP Customizing Implementation Guide
Assign Data Provider to the Data Model .
SAP NetWeaver
SAP Gateway
Registration
Additional customizing in order to assign the system alias and the GSDO group would also need to be done. See Customizing the SAP Gateway System for
more information.
Creating SAP Gateway Data Model based on the Code List PS Model
To create a Data Model based on the Code List PS Model proceed as follows:
1.
2.
3.
4.
Example
/IWCNT/PARTNER_ROLES_0001_UC
5. Click Display and choose Yes in the Create Data Model window.
6. Choose Existing Data Model in the Create From pane.
7. Enter the following information for the model:
Name as/IWCNT/MGW_CODE LIST
Type as PS
Version as 0001
8. Set labels, external names, descriptions for the fields in the SAP Gateway Data Model.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 80 of 95
Adding the Code List SAP Gateway Data Model to an existing SAP Gateway Consumption Model
To create SAP Gateway Consumption Model based on the SAP Gateway Data Model:
1.
2.
3.
4.
5.
6.
Note
The above steps should be performed for each code.
Note
All the screenshots shown below are samples only. The actual customizing entries will depend on the SAP Gateway Data Model, the SAP Gateway
Consumption Model and the GSDO group that will be created by the content developer for a Code List implementation. The screenshots below are based
on the examples mentioned in the Usage of Code List section.
To configure the SAP Gateway systems for Code List:
1. In the SPRO transaction
SAP Customizing Implementation Guide SAP NetWeaver
Development without IW_BEP Registration Assign Data Provider to the Data Model
SAP Gateway
.
Former Development
OData Channel
Example
For Partner Roles Code List, the Model Identifier should be set to/IWCNT/PARTNER_ROLES_0001_UC and the Class/Interface should be set to
/IWCNT/CL_CLST_EPRRQ_PROLES.
Former Development
OData Channel
Note
The above image is just a sample. Configure the existing SAP Gateway Consumption model (as explained under Adding the Code List SAP
Gateway Data Model to an existing SAP Gateway Consumption Modelin the Code List Usagechapter.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 81 of 95
The cache cleanup functionality cleans the code list cache tables for the OData channel which are maintained in the SAP Gateway system. This functionality
can be used by the administrator to clear the cache data either periodically or whenever required by refreshing the cache data. The cached data can be deleted
based on the created by user(s) and time restrictions.
To delete the code list cache for the OData Channel proceed as follows:
1. In the SPRO transaction, expand
SAP Customizing Implementation Guide SAP NetWeaver
Cache Settings
Cleanup Cache and Persistency
2. Specify User(s) if you want to delete the entries cached by a specific user or users.
3. Specify the cleanup scenario as /IWCNT/CL_CODELIST_CLEANUP_MGW.
4. Specify the time restriction if needed.
5. Execute.
SAP Gateway
OData Channel
Administration
Note
Uncheck the Execute in Test Mode checkbox in order to delete the cached value helps from the Codelist Cache tables.
Configuration Settings
Reporting Management
Code List
Creating Roles
You must create roles for SAP CRM and assign these roles to the CRM GSDO group. The CRM SAP Gateway users should be assigned to these roles so
that they can use SAP Gateway services. For this:
1. Identify the list of SAP CRM systems on which the functionality should be accessible by SAP Gateway.
2. Create system alias for each of these systems.
3. For each of these systems, define a role for which the administrator should assign the list of users (who has access to execute the functionality)
Note
1. You must be an SAP Gateway administrator or have an SAP user administrator to create the roles.
2. The roles must be defined/created on the SAP Gateway server.
3. If there is only one SAP CRM system and all the users on SAP Gateway should be able to access CRM functionality on this SAP CRM
system, then role creation and assigning of roles to GSDO groups is optional but this is not recommended.
To create roles, proceed as follows:
1. Open transaction pfcg in the SAP Gateway system.
2.
3.
4.
5.
6.
7.
8.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 82 of 95
Template Name
Template For
/IWCNT/RT_USER_ACT
/IWCNT/RT_USER_ACCNT
/IWCNT/RT_USER_CONT
Authorization
The user must have the following authorizations to access SAP Gateway system to use the CRM Scenarios:
Service
Authorization Object
/IWCNT/SG_ACTIVITY_0001
Authorization Values
SRV Name A3CB8ED503F16F11D97BEA06BB41E0
S_SERVICE
SRV Type HT
TCD SICF
S_TCODE
/IWCNT/BP_ACCOUNT_0001
SRV NameA8172704E2C058CDF94DD331FDB141
S_SERVICE
SRV Type-HT
TCD SICF
S_TCODE
/IWCNT/BP_CONTACT_0001
S_SERVICE
TCD SICF
S_TCODE
While creating role templates in the SAP CRM system, include the following authorization objects:
CRM Service
CRM Activity
Authorization Object
S_RFC
Field
Field Value
RFC_TYPE
FUGR
RFC_NAME
BAPT
CRM_ACTIVITYCRM_BAPI
CRM_BUSPROCESSND_BAPI
CRM_OSP_HELPER_TOOLS
COM_BUPA_USER_REGISTRATION
S_RFC
ACTVT
16(Execute)
RFC_TYPE
FUGR
RFC_NAME
CRM_BSP_BP_PRINT
COM_BUPA_USER_REGISTRATION
BUPA_TAX_BAPI
BUPA_INTERFACE_LONGTEXTS
BUPA_HOURS_BAPI
BUBA_3
BFHV
BAPT
S_SERVICE
CRM Attachments
S_RFC
ACTVT
16
SRV_NAME
CF56155FF3F9AEB85ED804FEEFE180
SRV_TYPE
HS
RFC_TYPE
FUGR
RFC_NAME
SKWF_UTIL
CRM_KW_DOCUMENTS
SKWF_IO
ACTVT
16
The user must have the following authorizations in the SAP Gateway system to access SAP Gateway services for CRM:
CRM Service
CRM Activity
Authorization Object
S_SERVICE
CRM Accounts
S_SERVICE
CRM Contacts
S_SERVICE
Field
Field Value
SRV_NAME
A3CB8ED503F16F11D97BEA06BB41E0
SRV_TYPE
HT
SRV_NAME
A8172704E2C058CDF94DD331FDB141
SRV_TYPE
HT
SRV_NAME
F3B52FB30DB35EC0A377ADD15084C9
SRV_TYPE
HT
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 83 of 95
You need to perform the following customizing settings in the SAP Gateway system:
Creating SAP system aliases
Assigning roles to a GSDO group
Assigning SAP system aliases to a GSDO group
Note
The configurations mentioned below must be carried out for CRM activity, accounts and contacts.
SAP NetWeaver
Configuration
Connection Settings
SAP Gateway to SAP System
2. Choose New Entries .
3. Enter the following details for the system alias:
Field
SAP Gateway
Former Development
Generic Channel
Description
Description
Local SAP GW
Leave unchecked if the CRM system is not on the same system as the SAP
Gateway system.
Check it if the CRM system is on the same system as the SAP Gateway system.
RFC Destination
Specify the RFC destination defined for your SAP system, for example,
BKDCNT200 .
WS Provider System
If you are using SAP CRM 7.0, leave the field blank.
If you are using SAP CRM 6.0, you can:
1. Leave the field blank if you are using BAPI based connection (We
recommend you to use BAPI based connection).
2. Choose a provider system if you are using ESA services. For
information on configuring a provider system, see Configuring a
GSDO to Connect to the SAP CRM system.
Software Version
Enter CRM_6.0 or CRM_7.0 according to the CRM version you are using.
SAP NetWeaver
SAP Gateway
Former Development
Generic Channel
Administration
General Settings
Manage GSDO Groups
and click the Activity icon.
2. Select the GSDO Group ( IWACT for CRM Activity and IWBPC for CRM Accounts and Contacts), from the Manage GSDO Groups list.
3. Choose Assign User Roles on the dialog structure.
4. Choose New Entries .
5. Enter the role name in the Assign User Roles column. For example, ZRole .
6. Save your settings.
Assigning SAP System Aliases to a GSDO Group
Proceed as follows:
1. In transaction SPRO open the SAP Reference IMG and navigate to:
SAP NetWeaver
SAP Gateway
Former Development
Generic Channel
Administration
General Settings
Manage GSDO Groups
and click the Activity icon.
2. Select the GSDO Group ( IWACT for CRM Activity and IWBPC for CRM Accounts and Contacts), from the Manage GSDO Groups list.
3. Choose Assign SAP System Aliases on the dialog structure.
4. Choose New Entries .
5. Enter the role name created above ZRole in the User Role column.
6. Press F4 to select a system alias in the SAP System Alias column.
7. Save your settings.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 84 of 95
Note
SAP CRM system is also referred to as provider system here.
SOA Management configurations on the provider system include:
Creating a New Profile in the Provider System A profile that contains general configuration on security and transport systems for the entire landscape.
Configuring Provider Systems Provider systems, to indicate which SAP systems are called. This can be compared with RFC destinations.
Note
If you are using SAP Basis release 700, it is not possible to use Mass Configuration for the services of that system. In such case, you need to manually
create logical ports.
Technical Configuration
Profile Management
2. Choose Create .
3. Enter a profile name in the Profile Name field under the Profile Properties section.
4. Check for the settings for reliable messaging, transport binding and authentication that fulfill the needs of your company and landscape. The selected
authentication method must support single sign-on. This may also require trust to be configured between the GSDO and the SAP systems.
5. Save and activate the profile.
6. Select the new profile you have created, and choose Export to export it to a file.
Note
If you do not have the option to export the files, you need to create logical ports manually on the consumer system.
7. Log on to all relevant systems in the landscape, go to transaction SOAMANAGER, and import the profile.
Note
If you want to change a profile, you must create a new version of it. By activating a new version, the provider system and all other pieces of configuration
that use the profile still use an old version. You must go to the configuration of each provider system and configure it to use the new version of the profile.
You must also reactivate all dependent objects as required. This has to be done in all systems in the landscape after the distribution of the new profile
version.
Business Administration
Mass Configuration
Note
If you have the option to import the Mass Configuration/Business Scenario XML file, see SAP Note 1585723
files.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 85 of 95
Business Administration
2. Search for the service that has been previously added to the business scenario.
3. Select the service from the list and choose Apply Selection.
4. Choose the Configurations tab. All endpoints and services are listed here. Endpoints are displayed here with a GUID as ID, and the Creation Type
field is set to Created based on the profile.
5. Choose Display to see its configuration.
Note
SAP Gateway system is also referred to as consumer system here.
SOA Management configurations on the consumer system include:
Creating a Provider System in the Consumer System The service groups, to determine which SAP systems may be called per service group from the
GSDO (acting as the consumer).
User Account Management User Account Management, for authentication settings when calling an SAP system.
Technical Administration
System Connections
2. Choose New . Enter a name and description for the provider system.
Note
The name of the Provider system and the name of the WS Provider System (mentioned in section Creating System Alias for Applications) should be
same.
3.
4.
5.
6.
Choose the profile you created as mentioned in the section Creating a New Profile in the Provider System.
Choose Next .
If your SAP system is listed in the SLD Identifier field, select it, else enter a name for your SAP system that uniquely identifies it.
Enter the URL for WSIL (Web Service Inspection Language) of your SAP system. The default value for the URL is http://<host:port>/sap/bc/srt/wsil?
sap-client=<client> . You can also obtain a URL, follow the procedure below.
For obtaining a URL to configure WSIL, proceed as follows:
1. Log on to the provider SAP system you created.
2. Go to transaction SICF.
3. Enter SERVICE for the Type Hierarchy .
4. Enter WSIL for Service Name .
5. Choose Execute .
Note
1. The WSIL service lists the configuration of all web services exposed by the system.
2. Logical ports can be created using SOAMANAGER automatic configuration, which either uses Service registry (If configured) or WSIL to
retrieve WSDL and corresponding endpoints. If you do not have Service registry in your landscape you must provide WSIL details while
configuring the provider system in consumer system SOAMANAGER (in System Connection).
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 86 of 95
7.
8.
9.
10.
Note
For releases lower than SAP Basis 701 this GUID is not available. If this is the case, you cannot use mass configuration on the consumer side for
the services of that system. Proceed as follows:
1. Enter any unique ID in the External Key field.
2. Proceed with the configuration of the business scenario. The activation of the scenario fails.
3. Create the logical ports manually (see section Check the logical ports you have created below).
11. Choose a configuration that suits your requirements and landscape setup like, authentication method and secure communication.
Service Administration
2. Choose New , enter a name and description for the user account.
3. Choose Next, select Business User for Account Type .
4.
5.
6.
7.
8.
9.
10.
11.
Service Administration
7. Choose the service group from the list and click Add To Worklist .
8. One service group (one set of web service consumer proxies) may point to many provider systems. Perform the following steps for each provider
system.
1. Select the service group.
2. Choose Assign Business Application .
3. Choose the business application that was created when creating the Provider Systems, click Assign To Service Group .
9. Choose Finish and activate the configuration scenario.
10. Choose Check for Updates to monitor or trigger the creation of logical ports for each web service consumer proxy and provider system.
Note
For the procedure on creating logical ports manually, see Creating a Fallback Configuration.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 87 of 95
If no logical port is listed, or it is not possible to create logical ports via the business scenario, you can manually create a logical port as mentioned below:
Choose Create Logical Port .
Choose a name and description.
Enter the URL to a WSDL or select a file.
To obtain the URL of a WSDL, see Checking the created endpoints section in Creating a New Profile in the Provider System.
SAP NetWeaver
SAP Gateway
Former Development
Generic
Channel Configuration
Connection Settings
SAP Gateway to SAP System Manage SAP System Aliases
2. Enter a WS provider system in the WS Provider System field, which should be the same as Provider System created in the consumer system.
Creating Roles
You must create roles for Reporting Management and assign these roles to the Reporting Management GSDO group. The Reporting Management users should
be assigned to these roles so that they can receive report templates and can execute the reports. For this:
1. Identify the list of SAP ERP and BI systems (for Reporting Management) on which the functionality should be accessible by SAP Gateway.
2. Creating system alias for each of these systems.
3. For each of these systems, define a role for which the administrator should assign the list of users (who has access to execute the functionality).
Note
1. You must be an SAP Gateway administrator or have an SAP user administrator to create the roles.
2. The roles must be defined/created on the SAP Gateway server.
3. If there is only one SAP ERP or BI system and all the users on SAP Gateway should be able to access Reporting Management functionality
on this system then role creation and assigning of roles to GSDO groups is optional but this is not recommended.
To create roles, proceed as follows:
1. Open transaction pfcg in the SAP Gateway system.
2.
3.
4.
5.
6.
7.
8.
S_RFC
Field
Field Values
SRV_NAME
4268DA7530FAD3798A64BA7232FC0D
SRV_TYPE
HT
RFC Name
/IWCNT/RFC_REPORT_RESULT_SET
RFC Type -
FUGR, FUNC
ACTVT
16
S_TCODE
TCD-SICF
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 88 of 95
While creating role template in the SAP ERP/BW system, include the authorizations provided in the table below. The user must have these authorizations in
the SAP Reporting Management systems (ERP/BW) to access SAP Gateway services for Reporting Management:
Reporting Management System
SAP ERP system
SAP BI system
Authorization Object
Field
S_RFC
S_RFC
Field Value
RFC_TYPE
FUGR
RFC_NAME
/OSP/R3_REPORT
ACTVT
16
RFC_TYPE
FUGR
RFC_NAME
/OSP/BW_REPORT
ACTVT
16
SAP NetWeaver
Configuration
Connection Settings
SAP Gateway to SAP System
2. Choose New Entries .
3. Enter the following details for the system alias:
Field
SAP Gateway
Former Development
Generic Channel
Description
Description
Local SAP GW
RFC Destination
Specify the RFC destination defined for your SAP system, for example,
BKDCNT200 .
WS Provider System
Leave it blank.
Software Version
SAP NetWeaver
SAP Gateway
Former Development
Generic Channel
Former Development
Generic Channel
Administration
General Settings
Manage GSDO Groups
and click the Activity icon.
2. Select the GSDO Group ( IWREPT , IW_SD_REPT or IWRPMD ), from the Manage GSDO Groups list.
3. Choose Assign User Roles on the dialog structure.
4. Choose New Entries .
5. Enter the role name in the Assign User Roles column. For example, ZMANAGER .
6. Save your settings.
Assigning SAP System Aliases to a GSDO Group
Proceed as follows:
1. In transaction SPRO open the SAP Reference IMG and navigate to:
SAP NetWeaver
SAP Gateway
Administration
General Settings
Manage GSDO Groups
and click the Activity icon.
2. Select the GSDO Group ( IWREPT , IW_SD_REPT or IWRPMD ), from the Manage GSDO Groups list.
3. Choose Assign SAP System Aliases on the dialog structure.
4. Choose New Entries .
5. Enter the role name created above ZMANAGER in the User Role column.
6. Press F4 to select a system alias in the SAP System Alias column.
7. Save your settings.
SAP NetWeaver
Configuration
Subscription Settings
Maintain Subscription Settings for GSDO
2. Choose New Entries .
3. Enter the following details in the Maintain Subscription Settings for GSDO screen:
Field
SAP Gateway
Former Development
Generic Channel
Description
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 89 of 95
GSDO Type
IWCNT~OM_REPORT_RESULT_SET
Event Group ID
REPORT_RESULT_NOTIF
Description
XNotification Type
IWCNT~OM_REPORT_PUSH_NOTIF
No Backend
SAP NetWeaver
Peripheral Settings
Manage Source Systems, Report Types and Formats
2. Choose New Entries to define a new format.
Field
SAP Gateway
Content
Reporting Administration
Description
File Type
Delivery Format Description
SAP NetWeaver
SAP Gateway
Content
Reporting Administration
Peripheral Settings
Manage Source Systems, Report Types and Formats
and click the Activity icon.
Select a report delivery format from the Delivery Formats section and double-click Manage Source Systems . The page displays the source systems
for reports that have been defined.
Select a report source type and double-click Manage Report Types . The page displays the report types that have been configured for the source
system.
Choose New Entries to define a new report type. Enter a name and description for the report type.
Save your settings.
In the Manage Report Types view, select a row and double-click Manage Formats . The page lists all report formats that have been defined for the
report type.
Choose New Entries to specify a new format.
Field
Description
Select a delivery format here. The formats you have configured in the Delivery
Formats view is displayed here.
Default
Select this checkbox to specify the format as the default format for the report
type.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 90 of 95
SAP NetWeaver
SAP Gateway
Content
Reporting Administration
Report Settings
Manage Reports and their Properties
and click the Activity icon. All reports that have been configured are listed.
2. Choose New Entries to create a new report.
3. In the Report Source and Type section, enter the following values:
Field
SAP System Alias
Description
Select the source system from which the report is derived.
Note
Choose the source system based on the type of report (ERP or BW).
Report Type
Press F4 in one of these fields and select a value. The other two fields are
automatically populated with their corresponding values.
Note
This is specific to SAP ERP query.
Description
Technical Name
Report Title
Report Description
Category
Active
Select the checkbox to make the report available to the users. This checkbox is
available only if at least one role is maintained for the report.
Not applicable.
5. In the Allow Users to Run the Report section, specify the following values:
Field
Description
Immediately
If this checkbox is selected, the user can run the report any time. It is executed
immediately and is delivered to the users client when ready.
If this checkbox is selected, the user is allowed to schedule when the report
should be run.
If this checkbox is not selected, then If there are report settings created with free
scheduling for the master template, those along with the corresponding jobs on
the backend gets deleted.
If this checkbox is selected, the user is allowed to run the report based on time
points. (Time points are specified in the Report Scheduling view.)
If this checkbox is selected, the Based on user-defined scheduling checkbox is
also selected.
Note
This checkbox is enabled only if at least one time point is maintained.
Based on data change events
If this checkbox is selected, the user is allowed to run the report based on data
change events. (Data change events refer to events that can trigger a report run
when certain conditions are met and data in the SAP system are changed. Data
change events are configured in the Report Scheduling view.)
Note
This option is available only for BW reports. This checkbox is enabled only if
at least one data change event is configured.
If this checkbox is selected, the Based on user-defined scheduling checkbox is
also selected.
6. In the Display Documentation to End users section, select one of the following options:
Field
Description
Existing documentation
Custom documentation
Select this option if you would like to create a new documentation for the report.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 91 of 95
None
SAP NetWeaver
SAP Gateway
Content
Reporting Administration
Report Settings
Manage Reports and their Properties
and click the Activity icon. All reports that have been configured are listed.
2. Choose a report from the Manage Reports and their Properties view list. Double-click Report Parameters and Values in the dialog structure on the left.
The parameters of the report are listed.
3. Enter the following values for the editable fields:
Field
Description
Order
For each parameter, enter a number to represent the order in which it should be
displayed to the user.
Mandatory
Select the checkbox if it is mandatory for the users to enter a value for the
parameter.
Display
Specify whether the parameter should be displayed to users or not, and whether
it should be editable if displayed.
Parameter Name
If you want to group certain parameters together and display them as a series of
radio buttons, enter group names for each set of radio buttons.
For example, you could enter the group name Date for parameters Today ,
Tomorrow and Specify Date ; and the group name Country for parameters
One country and Several countries .
F4 Availability
If this option is enabled, it indicates that the F4 option is available. You cannot
edit this option.
Context Group
Context Variable
Sign
Select Inclusive here to query reports that are within the values specified in the
parameter.
For example, if the parameter dates specify August 01 to August 30, the report
considers these dates when run.
Default Condition
Select the default condition to be displayed for the parameter. This option only
specifies the default display. The user can still select other conditions for the
value.
Enter the default starting value to be displayed for parameters that require a
range of values.
Enter the default ending value to be displayed for parameters that require.
Note
In case a particular parameter has multiple parameter values then the value, which has the lowest parameter order is displayed and this cannot be
modified.
4. Save your settings.
SAP NetWeaver
SAP Gateway
Content
Reporting Administration
Report Settings
Manage Reports and their Properties
and click the Activity icon. All reports that have been configured are listed.
Choose a report from the Manage Reports and their Properties view list. Double-click Report Parameters and Values in the dialog structure on the left.
The parameters of the report are listed.
Choose a parameter for which multiple values can be configured, in the Report Parameters and Values view. Double-click Define Multiple Values in
the dialog structure on the left. The page lists all values that have been configured for the parameter.
Choose New Entries to define a new value.
Enter the default conditions for the new parameter value.
Save your settings.
SAP NetWeaver
SAP Gateway
Content
Reporting Administration
and click the Activity icon. All reports that have been configured are listed.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 92 of 95
Report Settings
Manage Reports and their Properties
and click the Activity icon. All reports that have been configured are listed.
2. Choose a report from the Manage Reports and their Properties view list. Double-click Report Formats in the dialog structure on the left. The
parameters of the report are listed.
3. In the Manage Reports and their Properties view, select a report and double-click Report Formats for Report Type in the dialog structure on the left.
The page lists all delivery formats that have been specified for the report.
4. Configure the following values for a format:
Field
Description
Format
Display
Select whether the format should be allowed or not allowed. You can also
specify whether the format should be the default format if allowed.
SAP NetWeaver
SAP Gateway
Content
Reporting Administration
Report Settings
Manage Reports and their Properties
and click the Activity icon. All reports that have been configured are listed.
2. Choose a report from the Manage Reports and their Properties view list. Double-click Report Roles in the dialog structure on the left. The page lists all
roles that can access the report.
3. Choose New Entries .
4. In the Role field, press F4 and choose a role.
5. Save your settings.
SAP NetWeaver
SAP Gateway
Content
Reporting Administration
Report Settings
Manage Reports and their Properties
and click the Activity icon. All reports that have been configured are listed.
2. Choose a report from the Manage Reports and their Properties view list. Double-click Report Scheduling in the dialog structure on the left. The page
lists all scheduling options that have been defined for the report.
3. Configure the following values for a scheduling option:
Field
Description
Type
Choose if the report should be run based on a time point or a data change
event.
Event Name
Event Description
Display
SAP NetWeaver
SAP Gateway
Content
Report Administration
Report
Settings
Manage Categories
and click onthe Activity icon.
2. Choose New Entries to define a new category. Enter a name and description for the category.
3. Save your settings.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 93 of 95
1. In transaction SPRO open the SAP Reference IMG and navigate to:
SAP NetWeaver
SAP Gateway
Content
Reporting Administration
Report Settings
Manage Context Variables
and click the Activity icon.
2. Choose New Entries to define a new context group
Field
Description
Context Group
Value Type
SAP NetWeaver
SAP Gateway
Content
Reporting Administration
Report Settings
Manage Context Variables
and click the Activity icon.
2. In the Manage Context Groups view, select a context group and double-click Manage Context Variables on the dialog structure in the left menu. The
page lists all context variables that have been defined for the group.
3. Choose New Entries to create a new variable.
Field
Description
Context Variable
Specify the technical name for the context variable to map it to an RFC
destination.
Control Type
Select Parameter if the variable refers to specific values (for example, a date).
Select Select-Options if the variable refers to relative values (for example, a
date range).
SAP NetWeaver
SAP Gateway
Content
Reporting Administration
Report Settings
Manage Context Variables
and click the Activity icon.
2. In the Manage Context Variables view, select a context variable and double-click Enable Context Variables on the dialog structure in the left menu.
The page lists the SAP System Alias that the context variable has been mapped to.
3. Choose New Entries to define a new system.
Field
Description
Select the SAP System Alias of the system to locate the class.
Class
Note
Do not change the default values for Job class, Status, and Exec. Target.
3.
4.
5.
6.
7.
8.
9.
10. Choose Save , and from Job in the Define Background Job menu bar, choose Save .
Page 94 of 95
Note
You must manage events data change only for Business Intelligence (BI) reports.
Time points refer to frequencies (for example, every hour, every 2 days, every Saturday) that are defined and used by various jobs and schedulers. You can
create time points there, so that they can be used by reports and run at such frequencies.
An event signals that a particular situation has occurred in the system and specific background processing that is waiting for this event must be activated
accordingly. Events data changes are associated with a process chain, which is a sequence of processes waiting in the background for an event. You
configure events data change by creating a variant of process chain, defining a schedule, and activating it.
SAP NetWeaver
SAP Gateway
Content
Reporting Administration
Report Settings
Manage System Time Points and Data Change Events
and click the Activity icon.
2. Click Refresh to retrieve the latest list of system time points and data change events. The Status column shows the status of items that have been
updated or deleted.
3. Check the Active checkbox for time points and data change events that should be used to configure reports. These time points and events are now
available in the activity Manage Reports and their Properties .
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 95 of 95