SAP Gateway
PDF download from SAP Help Portal:http://help.sap.com/saphelp_gateway20sp11/helpdata/en/71/376ab03f824ea5bfd0a0e3a307205b/frameset.htm
Created on January 09, 2016
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
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
1.4.3.1.1.2.2 Workflow Settings
1.4.3.1.2 Configuring Business Process Content Services
1.4.3.1.2.1 Configuring Services for Deployment Scenario 1
1.4.3.1.2.1.1 Connecting Business Process Content and Business Suite Systems
1.4.3.1.2.1.1.1 Creating a Software Version for Provider System
1.4.3.1.2.1.1.2 Mapping the Software Version and Technical Model
1.4.3.1.2.1.2 Creating a System Alias
1.4.3.1.2.1.3 Activating the Process Service
1.4.3.1.2.1.4 Registering Process Context Service for Deployment Scenario 1
1.4.3.1.2.1.5 Activating the Process Context Service
1.4.3.1.2.2 Configuring Services for Deployment Scenario 2
1.4.3.1.2.2.1 Connecting Business Process Content and Business Suite Systems
1.4.3.1.2.2.1.1 Creating a Software Version for Provider System
1.4.3.1.2.2.1.2 Mapping the Software Version and Technical Model
1.4.3.1.2.2.2 Creating a System Alias for SAP Business Suite System
1.4.3.1.2.2.3 Connecting SAP Gateway and Business Process Content
1.4.3.1.2.2.4 Creating a System Alias for Business Process Content System
1.4.3.1.2.2.5 Activating the Process Service
1.4.3.1.2.2.6 Registering Process Context Service for Deployment Scenario 2
1.4.3.1.2.2.7 Activating the Process Context Service
1.4.3.1.2.3 User Authorizations for SAP Business Workflow Systems
1.4.3.1.3 Configuring the Task Gateway Service
1.4.3.1.3.1 Creating a System Alias
1.4.3.1.3.2 Activating Task Gateway Service
1.4.3.1.3.3 Assigning a Software Version to Service
1.4.3.1.3.4 Adding Additional System Aliases
1.4.3.1.3.5 Adding New Providers
1.4.3.1.3.6 Enabling User List for Task Gateway Service
1.4.4 Former Development
1.4.4.1 Configurations for ERP on SAP Gateway
1.4.4.1.1 Role Templates for ERP Scenarios
1.4.4.1.2 Configurations on SAP Gateway for SAP ERP
1.4.4.1.3 Settings for Time Management Application - OData Channel
1.4.4.1.3.1 Configurations on the SAP Gateway for Time Management - OData Ch
1.4.4.1.3.2 Configurations on the SAP ERP System (Provider System) for Time
1.4.4.1.3.3 Configurations on the SAP Gateway System (Consumer System) for L
1.4.4.1.4 Configurations for ERP Customer- OData Channel
1.4.4.1.4.1 Configurations for ERP Customer on the SAP Gateway System# OData
1.4.4.1.4.2 Configurations for ERP Customer on the SAP ERP System (Provider
1.4.4.1.4.3 Configurations for ERP Customer on the SAP Gateway System (Consu
1.4.4.1.5 Configurations for ERP Sales Documents on the SAP Gateway System
1.4.4.2 SOA Management Configurations on SAP ERP System
1.4.4.2.1 Importing a Profile using a XML Template
1.4.4.2.2 Profile Management
1.4.4.2.3 Importing Endpoints Template using Business Scenario Configurati
1.4.4.2.4 Creating Endpoints using a Business Scenario
1.4.4.2.5 Verifying the Endpoints Created
1.4.4.2.6 Obtaining the External Key of the Provider System
1.4.4.3 SOA Management Configurations on the SAP Gateway System
1.4.4.3.1 Importing a Profile File
1.4.4.3.2 Creating a System Connection to Provider System
1.4.4.3.3 User Account Management
1.4.4.3.4 Importing a Business Scenario Configuration XML
1.4.4.3.5 Configuring Service Groups using a Business Scenario
1.4.4.3.6 Verifying Logical Ports
1.4.4.4 Generic Channel Configuration
1.4.4.4.1 Defining Settings for Idempotent Services
1.4.4.4.2 Creating an RFC Destination for the WSIL Service
1.4.4.4.3 Assigning the System Alias Pointing to the SAP System
1.4.4.4.4 Checking SAP System Aliases
1.4.4.4.5 Subscription Settings
1.4.4.5 Code List
1.4.4.5.1 Code List Usage
1.4.4.5.2 Customizing the SAP Gateway System for Code List
1.4.4.5.3 Code List Cache Cleanup
1.4.4.6 Configuration Settings for Generic Channel Scenarios
1.4.4.6.1 Settings for Customer Relationship Management on SAP Gateway
1.4.4.6.1.1 Configuring GSDO to Connect to the SAP CRM System
1.4.4.6.1.1.1 SOA Management Configurations on SAP CRM System
1.4.4.6.1.1.1.1 Creating a New Profile in the Provider System
1.4.4.6.1.1.1.2 Configuring Provider Systems
1.4.4.6.1.1.2 SOA Management Configurations on SAP Gateway System
1.4.4.6.1.1.2.1 Creating a Provider System in the Consumer System
1.4.4.6.1.1.2.2 User Account Management
1.4.4.6.2 Settings for Reporting Management
1.4.4.6.2.1 Settings for Reporting Management on SAP Gateway
1.4.4.6.2.2 Configuring Subscriptions for Report Results
1.4.4.6.2.3 Settings for Reporting Administration
1.4.4.6.2.3.1 Managing Source Systems, Report Types and Formats
1.4.4.6.2.3.2 Managing Reports and their Properties
1.4.4.6.2.3.2.1 Configuring a New Report
1.4.4.6.2.3.2.2 Configuring Report Parameters
1.4.4.6.2.3.2.3 Configuring Multiple Values for a Parameter
1.4.4.6.2.3.2.4 Configuring Delivery Formats for a Report
1.4.4.6.2.3.2.5 Specifying Roles for a Report
1.4.4.6.2.3.2.6 Report Scheduling
1.4.4.6.2.3.3 Managing Categories
1.4.4.6.2.3.4 Managing Context Variables
1.4.4.6.2.3.5 Configuring System Time Points
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
SAP Gateway Technical Operations Guide SAP Gateway Security Guide
SAP Gateway Developer Guide SAP Gateway Content Guide
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 and Quick Sizer Tool . You can use the Quick Sizer Tool for your hardware calculations for your system landscape.
The SAP Community Network (SCN) offers additional information, such as community discussions, blogs, forums, etc. under
http://scn.sap.com/community/gateway .
1.1 What's New in SAP Gateway 2.0 SPS 11
This part of the SAP Gateway Library gives you an overview of what is new in SAP Gateway 2.0 Support Package Stack 11. This information is provided as Release Notes.
Area Details
Framework, runtime and metadata What's New in the SAP Gateway Framework
1.1.1 What's New in the Framework
Technical Data
Product Version SAP Gateway 2.0 SPS 11
Area Technology & Innovation Platform
Country Relevance Valid for all countries
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.
Service Context Facade
For application development and monitoring the framework offers a service context façade. For more information, see Service Context Facade.
Support of Conditional Expressions
In the SAP Gateway annotation APIs conditional expressions are supported. For more information, see OData Vocabulary Annotations APIs.
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 client’s 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.
Message Text Enhancements
Message target enhancements are provided with regard to the path relatively to the resource path in the URL. For more information, see /IWBEP/IF_MGW_CONV_SRV_RUNTIME.
Metadata Filter Value List
You can use filter options for value lists.For more information, see Metadata Filtering Value List.
Service-Based Batch Parallelization
You can deactivate the parallelization of batch queries on service level. For more information, see Defining Parallelization of Batch Queries.
$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.
1.2 SAP Gateway Master Guide
The SAP Gateway Master Guide provides you with a starting point for implementation and provides an overview of the required SAP components. The Master Guide comprises the following:
General Overview SAP Gateway and OData Development Overview SAP Gateway Service Builder Deployment Options
Embedded Versus Hub Deployment Glossary
Documentation Structure
For more information, the documentation for SAP Gateway also includes the following guides:
SAP Gateway Installation Guide SAP Gateway Configuration Guide SAP Gateway Technical Operations Guide SAP Gateway Security Guide
SAP Gateway Developer Guide
SAP Gateway Content Guide (including Workflow)
1.2.1 General Overview
SAP Gateway facilitates easier provisioning and consumption of business logic and content of SAP backend systems for mobile and Web applications. It aims to reduce the complexity and the skill set required to access SAP data, thereby removing deployment barriers. Simple interfaces also help to shorten development times.
SAP Gateway enables people-centric applications to consume SAP Business Suite data through popular platforms and devices (such as the iPad and Blackberry) in an easy and standards-based manner. It is a framework that connects business users to SAP systems using consumer technologies, groupware, and mobile devices and is based on open standards (such as the Atom Publishing Protocol and OData) that offer simple services based on the REST principle.
Depending on your development requirements and where you want to develop SAP Gateway content, you can install SAP in either an SAP Business Suite backend system (embedded deployment) or in an SAP Gateway hub system (central hub deployment). For more information about the deployment options and available software components, see Deployment Options.
SAP Gateway uses OData protocol. OData is based on industry standards and offers database-like access to business data using REST-based architecture. For its consumption outside of SAP, no knowledge of SAP structures is required and it supports object navigation. Dynamic binding takes place at runtime. OData can be easily consumed by various platforms and it offers flexibility (filtering, query options). OData for SAP comprises OData plus SAP annotations.
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 . This restriction applies to all OData versions.
OData for SAP
For more information about OData, see SAP Gateway and OData.
More Information
For more information see OData Channel.
1.2.2 SAP Gateway and OData
By exposing SAP Business Suite functionality as REST-based OData (Open Data Protocol) services, SAP Gateway enables SAP applications to share data with a wide range of devices, technologies, and platforms in a way that is easy to understand and consume.
Using REST services provides the following advantages:
Obtain human readable results; you can use your browser to see what data you will get. Use stateless applications
Receive related pieces of information, one leading to another.
Use standard GET, PUT, POST, DELETE, and QUERY. If you know where to GET data, you know where to PUT it, and you can use the same format.
What Is OData and Why Do we Use It?
OData is a Web protocol for querying and updating data, applying and building on Web technologies such as HTTP, Atom Publishing Protocol (AtomPub), and RSS (Really Simple Syndication) to provide access to information from a variety of applications. It is easy to understand and extensible, and provides consumers with a predictable interface for querying a variety of data sources.
AtomPub is the standard for treating groups of similar information snippets as it is simple, extensible, and allows anything textual in its content. However, as so much textual enterprise data is structured, there is also a requirement to express what structure to expect in a certain kind of information snippet. As these snippets can come in large quantities, they must be trimmed down to manageable chunks, sorted according to ad-hoc user preferences, and the result set must be stepped through page by page.
OData provides all of the above as well as additional features, such as feed customization that allows mapping part of the structured content into the standard Atom elements, and the ability to link data entities within an OData service (via “…related…” links) and beyond (via media link entries). This facilitates support
of a wide range of clients with different capabilities: Purely Atom, simply paging through data. Hypermedia-driven, navigating through the data web.
Aware of query options, tailoring the OData services to their needs.
OData is also extensible, like the underlying AtomPub, and thereby allows the addition of features that are required when building easy-to-use applications, both mobile and browser-based.
OData for SAP Products
SAP Gateway uses OData for SAP Products, which contains SAP-specific metadata that helps the developer to consume SAP business data, such as descriptions of fields that can be retrieved from the SAP ABAP Dictionary. The following are examples of OData for SAP applications:
Human-readable, language-dependent labels for all properties (required for building user interfaces).
Free-text search, within collections of similar entities, and across collections using OpenSearch. OpenSearch can use the Atom Syndication Format for its search results, so the OData entities that are returned by the search fit in, and OpenSearch can be integrated into AtomPub service documents via links with rel=”search”, per collection as well as on the top level. The OpenSearch description specifies the URL template to use for searching, and for collections it simply points to the OData entity set, using a custom query option with the name of “search”.
Semantic annotations, which are required for applications running on mobile devices to provide seamless integration into contacts, calendar, and telephony. The client needs to know which OData properties contain a phone number, a part of a name or address, or something related to a calendar event.
Not all entities and entity sets will support the full spectrum of possible interactions defined by the uniform interface, so capability discovery will help clients avoiding requests that the server cannot fulfill. The metadata document will tell whether an entity set is searchable, which properties may be used in filter expressions, and which properties of an entity will always be managed by the server.
Most of the applications for “light-weight consumption” follow an interaction pattern called “view-inspect-act”, “alert-analyze-act”, or “explore & act”, meaning that you somehow navigate (or are led) to an entity that interests you, and then you have to choose what to do. The chosen action eventually results in changes to this entity, or entities related to it, but it may be tricky to express it in terms of an Update operation, so the available actions are advertised to the client as special atom links (with an optional embedded simplified “form” in case the action needs parameters) and the action is triggered by POSTing to the target URI of the link.
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 . This restriction applies to all OData versions.
1.2.3 Development Overview
The creation of data models is an integral part of the development process for SAP Gateway. You can create, edit, and display the data models on which you base an OData service for SAP Gateway either in the Service Builder (transaction SEGW) or in the ABAP Workbench (transaction SE80). The Service Builder not only enables you to define data models, but rather create and maintain complete OData services for SAP Gateway.
The Service Builder is a dedicated design-time transaction, which provides a toolset for creating services easily and efficiently and it supports the entire service development lifecycle. The Service Builder succinctly blends new and existing ABAP development tools in an OData-compliant modeling transaction. The Service Builder supports the following development phases for OData services:
1. Data Model Definition 2. Service Implementation 3. Service Maintenance
More Information
For more information about the new Service Builder, see SAP Gateway Service Builder. For more information, see SAP Gateway Developer Guide.
1.2.4 SAP Gateway Service Builder
The Service Builder (transaction SEGW) provides an easy-to-use set of tools for creating OData services. It supports developers throughout the entire development and modeling process.
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.
Project-Based Service Development
The Service Builder introduces a new service development concept, which is organized around projects. Projects are used to store the artifacts developers need to create a service and a data model together in one place. Since projects consolidate all related data, developers can easily work on multiple projects in parallel and reuse data between projects before generating and activating the actual service.
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.
1.2.5 Deployment Options
Depending on your preferred system landscape, different deployment options are available for SAP Gateway.
Central hub deployment: service development in the SAP Business Suite backend system Central hub deployment: service development in SAP Gateway hub system
Embedded deployment: service development in the SAP Business Suite system
This section describes the two deployment options available for SAP Gateway:
Central hub deployment of SAP Gateway core components IW_FND and GW_CORE in an SAP Gateway hub system.
As of SAP NetWeaver 7.40, the core software component for SAP Gateway is SAP_GWFND, which contains the composite functional scope of IW_FND, GW_CORE, IW_BEP, and IW_HDB.
Embedded deployment of SAP Gateway core components IW_FND and GW_CORE in an SAP Business Suite backend system.
As of SAP NetWeaver 7.40, the core software component for SAP Gateway is SAP_GWFND, which contains the composite functional scope of IW_FND, GW_CORE, IW_BEP, and IW_HDB.
For more information about the SAP Gateway components, see Installing SAP Gateway Components and the SAP Note 1569624 . All SAP Gateway 2.0 components are non-modifying components. For more information, see SAP Note 1569624 .
Embedded or Central Hub Deployment?
You can install SAP Gateway independent of consumer technologies, however the software components installed for the consumer technologies must also be installed on one SAP Gateway server. You can connect multiple consumer technologies to one SAP Gateway instance.
Deployment options:
Central hub deployment: The SAP Gateway core components can be deployed in a standalone system, either behind or in front of the firewall. In
addition, you can install the optional components for central hub deployment in your standalone system. For SAP NetWeaver 7.02, 7.03, and 7.31 you can install the component IW_BEP either in this hub system and/or in the backend system. For SAP NetWeaver 7.40 and higher, the core component SAP_GWFND is installed as standard and includes the functional scope of IW_BEP.
Embedded deployment: The core components for SAP Gateway and any optional backend components are deployed together in the SAP Business
Suite backend system. For this deployment option, you need a backend system only, and not a dedicated SAP Gateway central hub system. For information about how to choose the most suitable deployment option for your system landscape, see Embedded Versus Hub Deployment.
Central Hub Deployment
Central hub deployment of SAP Gateway has the following advantages: Routing and composition of multiple systems is supported. Dedicated SAP Gateway content is available.
Content can be deployed without touching the SAP Business Suite backend system. Decoupled lifecycle of consumer applications from the SAP Business Suite backend system. Central management of routing and connectivity with SAP Business Suite backend systems. SAP Gateway capabilities need to be deployed only once within the landscape.
Better security, as a request is validated at the dedicated box and consequently attacks on the SAP Gateway system will not automatically affect the SAP Business Suite backend system.
A separate SAP Gateway system can be implemented in a demilitarized zone (DMZ) for external access. Independent innovation speed of SAP Gateway and the connected SAP Business Suite backend systems. However, note the following considerations:
There will be redundant deployment of metadata or ABAP Dictionary structures.
For SAP NetWeaver 7.00, 7.01,7.02, 7.03, and 7.31 you can install the component IW_BEP in each backend system. For SAP NetWeaver 7.40 and higher, the core component SAP_GWFND is installed as standard and includes the functional scope of IW_BEP
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.
Core Components for SAP Gateway
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 Contains core functionality of SAP
Gateway as follows: Runtime components Metadata store Shared services, such as monitoring
Note
For SAP NetWeaver 7.40 or higher, see SAP_GWFND.
GW_CORE ABAP 200 Contains OData libraries.
Note
For SAP NetWeaver 7.40 or higher, see SAP_GWFND.
SAP_GWFND ABAP 740 Available as standard in systems based on SAP NetWeaver 7.40 or higher. This core component contains the functional scope of the core components IW_FND and GW_CORE together with the functional scope of the components IW_BEP and IW_HDB. Since this core component is included as standard in the SAP NetWeaver 7.40 delivery, you do not need to install it explicitly or the components it comprises, namely IW_FND, GW_CORE, IW_BEP, IW_HDB.
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.
Optional Components for Central Hub Deployment
The following optional components are available:Name Type Version Notes
IW_BEP ABAP 200 Business Enablement Provisioning
component.
You can install this software component in an SAP Gateway central hub system to enable the implementation of OData resources in the same way as business data in a backend system.
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 Contains well-defined content, including,
for example:
Metadata describing data object ABAP code for data mapping Web service consumer and server proxies
IW_CBS ABAP 200 Contains application basis functionality,
such as SAP Gateway enablement of SAP NetWeaver Business Workflow.
IW_CBS applications are similar to IW_CNT applications.
IW_HDB ABAP 100 Provides business content adapter for
SAP Gateway with SAP HANA that enables OData exposure of SAP HANA views.
For SAP NetWeaver 7.02, 7.03, and 7.31, you can install this component in an SAP Gateway system together with IW_BEP. For SAP NetWeaver 7.40 and higher, you do not need to install component IW_HDB because the core component SAP_GWFND already includes the functional scope of IW_HDB (and IW_BEP) as standard.
IW_SPI ABAP 100 Provides a generic OData adapter for
content based on the Service Provider Infrastructure (SPI).
For SAP NetWeaver 7.02, 7.03, and 7.31, you can install this component in an SAP Gateway system together with IW_BEP or in an SAP Business Suite system together with IW_BEP. For SAP NetWeaver 7.40 and higher, the core component SAP_GWFND in installed as standard and includes the functional scope of IW_BEP. Consequently you can install component IW_SPI in either an SAP Gateway system or an SAP Business Suite backend system provided the system is based on SAP NetWeaver 7.40 or higher.
IW_PGW ABAP 100 Content provider that enables exposure
for SAP NetWeaver Business Process Management (BPM) and Process Observer Task exposure for BPM and SAP NetWeaver Business Workflow. For SAP NetWeaver 7.02, 7.03, and 7.31, you can install this component in an SAP Gateway system together with IW_BEP or in an SAP Business Suite system together with IW_BEP. For SAP NetWeaver 7.40 and higher, the core component SAP_GWFND in installed as standard and includes the functional scope of IW_BEP. Consequently you can install component IW_PGW in either an SAP Gateway system or an SAP Business Suite backend system provided the system is based on SAP NetWeaver 7.40 or higher.
Optional Components for SAP Business Suite System
You can install the following components in an SAP Business Suite system:Name Type Version Notes
IW_BEP ABAP 200 Business Enablement Provisioning
component
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 Component for Screen Scraping
generator.
IW_GIL ABAP 100 Provides a generic OData adapter for
content based on the Generic Interaction Layer (GenIL).
For SAP NetWeaver 7.01, 7.02, 7.03, and 7.31, you can install this component in an SAP Business Suite system together with IW_BEP. For SAP NetWeaver 7.40 and higher, the core component SAP_GWFND in installed as standard and includes the functional scope of IW_BEP. Consequently you can install component
IW_GIL in an SAP Business Suite backend system provided it is based on SAP NetWeaver 7.40 or higher.
IW_SPI ABAP 100 Provides a generic OData adapter for
content based on the Service Provider Infrastructure (SPI).
For SAP NetWeaver 7.02, 7.03, and 7.31, you can install this component in either an SAP Business Suite system or an SAP Gateway system together with IW_BEP. For SAP NetWeaver 7.40 and higher, the core component SAP_GWFND is in installed as standard and includes the functional scope of IW_BEP. Consequently you can install component IW_SPI in either an SAP Business Suite system or in an SAP Gateway system provided it is based on SAP NetWeaver 7.40 or higher.
IW_PGW ABAP 100 Content provider that enables exposure
for SAP NetWeaver Business Process Management (BPM) and Process Observer Task exposure for BPM and SAP NetWeaver Business Workflow. For SAP NetWeaver 7.00, 7.01, 7.02, 7.03, and 7.31, you can install this component in either an SAP Business Suite system or an SAP Gateway system together with IW_BEP. For SAP NetWeaver 7.40 and higher, the core component SAP_GWFND is in installed as standard and includes the functional scope of IW_BEP. Consequently you can install component IW_PGW in either an SAP Business Suite system or in an SAP Gateway system provided it is based on SAP NetWeaver 7.40 or higher.
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 .
1.2.6 Embedded Versus Hub Deployment
Depending on whether you want to develop SAP Gateway content in an SAP Business Suite backend system or in an SAP Gateway central hub system, you can choose to implement SAP Gateway in an embedded or central hub deployment scenario:
Embedded deployment of core software components IW_FND and GW_CORE in an SAP Business Suite backend system.
As of SAP NetWeaver 7.40, the core software component for SAP Gateway is SAP_GWFND, which contains the composite functional scope of IW_FND, GW_CORE, IW_BEP, and IW_HDB.
Central hub deployment of core software components IW_FND and GW_CORE in an SAP Gateway hub system.
As of SAP NetWeaver 7.40, the core software component for SAP Gateway is SAP_GWFND, which contains the composite functional scope of IW_FND, GW_CORE, IW_BEP, and IW_HDB.
Development System — Deployment Scenarios
To help you decide whether embedded or central hub deployment is the most suitable for you, see the following three deployment scenarios. These deployment scenarios have been conceived to provide you with the flexibility to decide which deployment option best meets your individual requirements.
Scenario A: Central Hub Deployment — Development in SAP Business Suite Backend System
SAP NetWeaver Release Software Components Installed in SAP Gateway Hub System
Installed in SAP Business Suite Backend System SAP NetWeaver 7.0, 7.01, 7.02, 7.03, 7.31 IW_FND X GW_CORE X IW_BEP X
SAP NetWeaver 7.40 and higher SAP_GWFND (X — available as standard as part of SAP NetWeaver 7.40 and higher)
X 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
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 Installed in SAP Gateway Hub System
Installed in SAP Business Suite Backend System
SAP NetWeaver 7.0, 7.01, 7.02, 7.03, 7.31
IW_FND X
GW_CORE X
IW_BEP X You can combine this deployment scenario with an installation of IW_BEP in the backend system.
SAP NetWeaver 7.40 and higher SAP_GWFND X (X — available as standard as part of SAP NetWeaver 7.40 and higher) 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 Installed in SAP Gateway Hub System
Installed in SAP Business Suite Backend System SAP NetWeaver 7.0, 7.01, 7.02, 7.03, 7.31 IW_FND X GW_CORE X IW_BEP X
SAP NetWeaver 7.40 and higher SAP_GWFND X
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.
Business Enablement Provisioning (BEP)
Function that handles the OData Channel as well as the events and actions activated in the SAP Business Suite system and publishes these events and actions through SAP Gateway.
Backend Operation Proxy (BOP)
Encapsulates a single RFC call or a Web service operation call and consists of two or more classes, with a BOP data object (BOP DO) class for each BOP.
backend system
SAP Business Suite backend system.
central hub deployment
Deployment of core software components IW_FND and GW_CORE on the SAP Gateway central hub system.
collection
Resource that contains a set of entries, which are structured according to the entity type definition in the respective data model.
complex type (synonym: ComplexType)
Structured types consisting of a list of properties but with no key. Can only exist as a property of a containing entity or as a temporary value.
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.
data provider class (DPC)
Provides all application data of a service to the runtime.
embedded deployment
Deployment of core software components IW_FND and GW_CORE on the SAP Business Suite backend system.
entity set (synonym: EntitySet)
Entities are grouped in entity sets (for example, customers is a set of customer entity type instances)
entity type (synonym: EntityType)
OData-specific. An entity is an instance of an <EntityType>. It has a unique identity, independent existence, and forms the operational unit of consistency. An <EntityType> has a name, a payload consisting of one or more declared properties and a <Key> that describes the set of properties whose values uniquely identify an entity within an entity set.
entity data model (EDM)
Set of concepts that describe the structure of data regardless of its stored form.
event provider
Application-specific component that provides business events. SAP Gateway converts these events in OData for SAP application notifications.
function import (synonym: FunctionImport)
Describes a service operation in an entity data model.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.
hub system
SAP Gateway system.metadata document
Complete XML representation of an Entity Data Model (1:1 relation).
model provider class (MPC)
Provides all metadata of a service to the runtime.
multiple origin composition (MOC)
Collection of data from different backend systems that is aggregated in a single service, thereby enabling a service to be made available for more than one system.
navigation property (synonym: NavigationProperty)
Property of an entry that represents a link from this entry to one or more related entries. A navigation property is not a structural part of the entry to which it belongs.
OData Channel (ODC)
Programming paradigm for SAP Gateway to expose backend functionality. To use the OData Channel, you can install the software component IW_BEP on either an SAP Business Suite backend system or on the SAP Gateway system. You are no longer recommended to use SAP Gateway ODC (using the core software component IW_FND).
OData for SAP Products
OData for SAP Products is a set of rules describing how to apply OData in consumption scenarios, plus a set of extensions to OData that simplify the consumption of OData services.
OData service
Develop OData services in the Service Builder to extract the data you want, when you want it, and where.
OData Services Consumption and Integration (OSCI)
Enables quick consumption of external OData services and converts them to SAP Gateway compliant OData services.
Open Data Protocol (OData)
The Open Data Protocol (OData) is a Web protocol for querying and updating data. It applies and builds upon Web technologies such as HTTP, Atom Publishing Protocol (AtomPub), and JSON to provide access to information from a variety of applications.
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 standards-based fashion.
Screen Scraping
Generator for transforming ABAP dynpro screens into SAP Gateway services.
self link
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.
User Self Service
SAP Gateway feature (similar to the User Management capability of Business-to-Consumer (B2C) scenario) using which SAP Business Suite B2C customers can create users and manage their user profiles.
1.3 SAP Gateway Installation Guide
SAP Gateway is available as an SAP NetWeaver Application Server ABAP (AS ABAP) add-on that you install on top of your existing SAP Business Suite or application platform. The software packages are available on your DVD and on http://service.sap.com/swdc .
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 .
1.3.1 Installation Prerequisites
Hardware
The minimum hardware requirements for SAP Gateway are as follows:
Requirements Specification
Processor Dual Core (2 logical CPUs) or higher, 2 GHz or higher Random Access Memory (RAM) 8 GB or higher
Hard Disk Capacity 80 GB primary, or higher
Software
The minimum software requirements for SAP Gateway are as follows:
Requirements Specification
SAP NetWeaver Stack The latest kernel patch for the corresponding SAP NetWeaver version has to be applied.
Core Components
GW_CORE and IW_FND
SAP NetWeaver 7.0 SPS25 SAP NetWeaver 7.01 SPS10 SAP NetWeaver 7.02 SPS07 SAP NetWeaver 7.03 SPS01 SAP NetWeaver 7.31 SPS01 Core Component
SAP Gateway Foundation SAP_GWFND
Note
Comprises functional scope of components IW_FND, GW_CORE, IW_BEP, and IW_HDB.
SAP NetWeaver 7.40 SPS01
Business Enablement Provisioning Component
IW_BEP SAP NetWeaver 7.0 SPS18 SAP NetWeaver 7.01 SPS03 SAP NetWeaver 7.02 SPS06 SAP NetWeaver 7.03 SPS01 SAP NetWeaver 7.31 SPS01
Content Adapter Components
IW_PGW
Screen Scraping Component
IW_SCS SAP NetWeaver 7.0 SPS18 SAP NetWeaver 7.01 SPS03 SAP NetWeaver 7.02 SPS06 SAP NetWeaver 7.03 SPS01 SAP NetWeaver 7.31 SPS01 SAP NetWeaver 7.40 SPS01
Content Adapter Component
IW_SPI
SAP NetWeaver 7.02 SPS06 SAP NetWeaver 7.03 SPS01 SAP NetWeaver 7.31 SPS01 SAP NetWeaver 7.40 SPS01
Content Adapter Component
IW_HDB
SAP NetWeaver 7.02 SPS09 SAP NetWeaver 7.03 SPS01 SAP NetWeaver 7.31 SPS01
Minimal requirement of HANA database version: SAP HANA 1.0 SPS02
Content Adapter Component
IW_GIL SAP NetWeaver 7.01 SPS03 SAP NetWeaver 7.02 SPS06 SAP NetWeaver 7.03 SPS01 SAP NetWeaver 7.31 SPS01 SAP NetWeaver 7.40 SPS01 Content Components
IW_CNT and IW_CBS
SAP NetWeaver 7.02 SPS07 SAP NetWeaver 7.03 SPS01 SAP NetWeaver 7.31 SPS01 SAP NetWeaver 7.40 SPS01 SAP WEB UIF Core Component Version
IW_FND 250
SAP WEB UIF 7.01 SP01 SAP WEB UIF 7.31 SP00
Optional Core Component
IW_FNDGC (for Generic Channel)
SAP WEB UIF 7.46 SP00 SAP WEB UIF 7.47 SP01
Content Adapter Component
IW_GIL
SAP WEB UIF 7.0 SP03 SAP WEB UIF 7.01 SP00 SAP WEB UIF 7.31 SP00 SAP WEB UIF 7.46 SP00 SAP WEB UIF 7.47 SP01 SAP Backend SAP Business Suite system
More Information
For information about the product availability matrix for SAP Gateway, see http://service.sap.com/pam and search for . Consider the security issues described in SAP Gateway Security Guide.
In addition, ensure you read and implement the latest version of the SAP Notes that apply to the software requirements listed above. You can find these SAP Notes at: http://service.sap.com/notes .
1.3.2 Installing SAP Gateway Components
Install the SAP Gateway components using the SAP Add-On Installation Tool (SAINT), which lets you import the SAP Gateway installation packages from your DVD or the SAP Service Marketplace into your SAP system landscape.
On the SAP Service Marketplace you will find the SAP Gateway download package in the SAP Software Download Center: Go to http://service.sap.com/swdc
and navigate to Installations and Upgrades Browse our Download Catalog SAP NetWeaver and complementary products SAP Gateway SAP Gateway 2.0 . Here you can find links to Installation and Upgrade (choose Downloads ), the documentation, and to the Product Availability Matrix (PAM). The following provides you with an overview of the SAP Gateway components available. You must install the core components. All SAP Gateway 2.0 components are non-modifying components. For more information, see SAP Note 1569624 .
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 and SAP Note 1707368 .
1.3.3 Unicode and Non-Unicode Support
1.3.3 Unicode and Non-Unicode Support
If a SAP Gateway system and/or one of the connected backend systems is a non-unicode system certain technical restrictions need to be considered: If the name of an EDM artifact (that is, a name of an artifact of the service’s EDM model, for example, a property name) contains characters that are not in the system code-page, then the following applies: Such characters are converted into the hash character - #.
This results in an error during the name validation in the OData library.
The origin of such EDM names could, for example, be the Service Builder or OData services generated with SAP Gateway.
If the data (for example, HTTP request/response payload) from a unicode system or unicode clients contains characters that are not in the system code page, then the following applies: A conversion into STRING is done which converts characters that are not available in the system code-page into the hash character - #.
This does not necessarily result in an error.
The origin of such data could, for example, be applications on the basis of the UI development toolkit for HTML5 (SAPUI5) or external OData services in a client scenario.
It is highly recommended that both the SAP Gateway as well as all connected backend systems are unicode systems.
The above listed issues can be overcome by exclusively using characters that are in the code-pages of all systems. Depending on the support package stack level at least the following SAP Notes have to be applied as well:
1994928 1995054 1995517
1.4 SAP Gateway Configuration Guide
Once you have installed the SAP Gateway components, you must configure your system to allow the consumer servers’ applications to retrieve the data requested by users.
The SAP Gateway Configuration Guide contains the steps for customizing settings for SAP Gateway and describes system configuration activities. The sequence of mandatory and optional configuration tasks is as follows and depends on your use case.
1. General Configuration Settings (mandatory) 2. OData Channel Configuration
3. Configuration Settings for content scenarios (optional)
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 SAP Gateway Service Enablement
.
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 .
Additional Software Components
Depending on the additional SAP Gateway components you implement, further component-specific configuration steps are required:
Screen Scraping (IW_SCS) 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.
SAP Gateway with HANA (IW_HDB) 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: SAP NetWeaver SAP Gateway Service Enablement Content Workflow Settings .
Business Process Enablement 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: SAP NetWeaver SAP Gateway Service Enablement Content Business Process Enablement .
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.
1.4.1 General Configuration Settings
After having installed the SAP Gateway software components you need to carry out several configuration steps.
Before starting with the configuration for SAP Gateway itself, you need to collect some information about the SAP Gateway host.
Required Information Description Example
Fully Qualified Domain Name (FQDN) Name of the SAP NetWeaver Application Server ABAP (AS ABAP) system or the load balancing device.
server.domain.com
Administrator credentials Login information of the administrator of the SAP NetWeaver AS ABAP to install and maintain the system
SAP administrator
HTTP/HTTPS ports HTTP and HTTPS port numbers of the central instance of the AS ABAP
80000 for HTTP and 80001 for HTTPS SAP system For each SAP system to which you want to connect the
SAP Gateway server, you need the following information:
System ID, system number Server name
HTTP / HTTPS port Administrator credentials
In addition, several settings are important for smooth operations:
Profile Parameters ICF Services Initial Logon Language Settings
1.4.1.1 Profile Parameters
In both your SAP system and in the SAP Gateway system you need to set the following profile parameters to certain values:
Profile Parameter Value
login/accept_sso2_ticket 1
login/create_sso2_ticket 2
You maintain these profile parameters via transaction RZ10.
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.
1.4.1.2 ICF Services
Once you have installed the Application Server ABAP (AS ABAP) all Internet Communication Framework (ICF) services are available in an inactive state for security reasons. After the installation you have to decide which services must be activated for the applications you want to use.
