95
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 PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved. Page 1 of 95

SAP Gateway

Embed Size (px)

DESCRIPTION

SAP Gateway help

Citation preview

  • SAP GatewayPDF 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 HelpPortal.

    NoteThis 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 missingsubtopics.

    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 purposewithout the express permission of SAP SE. The information contained herein may be changed without prior notice. Some software products marketed by SAPSE and its distributors contain proprietary software components of other software vendors. National product specifications may vary. These materials areprovided by SAP SE and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAPGroup 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 setforth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additionalwarranty. SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP SE inGermany 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 content1 SAP Gateway1.1 What's New in SAP Gateway 2.0 SPS 111.1.1 What's New in the Framework1.2 SAP Gateway Master Guide1.2.1 General Overview1.2.2 SAP Gateway and OData1.2.3 Development Overview1.2.4 SAP Gateway Service Builder1.2.5 Deployment Options1.2.6 Embedded Versus Hub Deployment1.2.7 Glossary1.3 SAP Gateway Installation Guide1.3.1 Installation Prerequisites1.3.2 Installing SAP Gateway Components1.3.3 Unicode and Non-Unicode Support1.4 SAP Gateway Configuration Guide1.4.1 General Configuration Settings1.4.1.1 Profile Parameters1.4.1.2 ICF Services1.4.1.3 Changing Password for Initial Logon1.4.1.4 Language Settings1.4.2 SAP Gateway Configuration1.4.2.1 User, Developer, and Administrator Roles1.4.2.1.1 Creating and Assigning Roles1.4.2.2 Connection Settings for SAP Gateway Hub System1.4.2.2.1 Connection Settings: SAP Gateway to Consumers1.4.2.2.1.1 Creating an RFC Destination for Outbound Queues1.4.2.2.1.2 Registering an RFC Destination for Outbound Queues1.4.2.2.1.3 Creating a bgRFC Supervisor Destination1.4.2.2.2 Connection Settings: SAP Gateway to SAP Systems1.4.2.2.2.1 Creating an RFC Destination for SAP Gateway Hub to SAP System1.4.2.2.2.2 Defining Trust for SAP Systems1.4.2.2.2.3 Configuring SAP System to Accept Assertion Tickets from SAP Gate1.4.2.2.2.4 Configuring SAP Gateway Host to Accept Assertion Tickets from SA1.4.2.2.2.5 Creating an SAP System Alias1.4.2.2.2.6 System ID in Origin Segment Parameter1.4.2.3 Activating SAP Gateway1.4.2.4 Service Development in the Backend System1.4.2.4.1 Maintaining Models and Services1.4.2.4.2 Displaying Models and Services1.4.2.4.3 Defining Parallelization of Batch Queries1.4.2.5 Service Development in the SAP Gateway Hub System1.4.2.5.1 Assigning SAP System Alias to OData Service1.4.2.5.2 Multiple Origin Composition1.4.2.5.3 Dynamic System Alias Calculation Via /IWFND/ES_MGW_DEST_FINDER1.4.2.6 Connection Settings to SAP Gateway1.4.2.6.1 Defining Settings for Idempotent Services1.4.2.6.2 Defining a Remote Function Call to SAP Gateway1.4.2.6.3 Connection Settings to SAP Gateway1.4.2.6.4 Configure the bgRFC Supervisor Destination1.4.2.6.5 Monitoring bgRFC Queues1.4.3 Configuration Settings for SAP Gateway Supported Scenarios1.4.3.1 Configuration Settings for OData Channel Scenarios1.4.3.1.1 Configuring Workflow for SAP Gateway1.4.3.1.1.1 Creating an Administrator Role for Workflow1.4.3.1.1.2 Customizing SAP Gateway Workflow1.4.3.1.1.2.1 Configuring Workflow Notifications1.4.3.1.1.2.1.1 Creating a Type G RFC Destination1.4.3.1.1.2.1.2 Configuring User Authorizations for Push Notifications1.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

  • 1.4.3.1.1.2.2 Workflow Settings1.4.3.1.2 Configuring Business Process Content Services1.4.3.1.2.1 Configuring Services for Deployment Scenario 11.4.3.1.2.1.1 Connecting Business Process Content and Business Suite Systems1.4.3.1.2.1.1.1 Creating a Software Version for Provider System1.4.3.1.2.1.1.2 Mapping the Software Version and Technical Model1.4.3.1.2.1.2 Creating a System Alias1.4.3.1.2.1.3 Activating the Process Service1.4.3.1.2.1.4 Registering Process Context Service for Deployment Scenario 11.4.3.1.2.1.5 Activating the Process Context Service1.4.3.1.2.2 Configuring Services for Deployment Scenario 21.4.3.1.2.2.1 Connecting Business Process Content and Business Suite Systems1.4.3.1.2.2.1.1 Creating a Software Version for Provider System1.4.3.1.2.2.1.2 Mapping the Software Version and Technical Model1.4.3.1.2.2.2 Creating a System Alias for SAP Business Suite System1.4.3.1.2.2.3 Connecting SAP Gateway and Business Process Content1.4.3.1.2.2.4 Creating a System Alias for Business Process Content System1.4.3.1.2.2.5 Activating the Process Service1.4.3.1.2.2.6 Registering Process Context Service for Deployment Scenario 21.4.3.1.2.2.7 Activating the Process Context Service1.4.3.1.2.3 User Authorizations for SAP Business Workflow Systems1.4.3.1.3 Configuring the Task Gateway Service1.4.3.1.3.1 Creating a System Alias1.4.3.1.3.2 Activating Task Gateway Service1.4.3.1.3.3 Assigning a Software Version to Service1.4.3.1.3.4 Adding Additional System Aliases1.4.3.1.3.5 Adding New Providers1.4.3.1.3.6 Enabling User List for Task Gateway Service1.4.4 Former Development1.4.4.1 Configurations for ERP on SAP Gateway1.4.4.1.1 Role Templates for ERP Scenarios1.4.4.1.2 Configurations on SAP Gateway for SAP ERP1.4.4.1.3 Settings for Time Management Application - OData Channel1.4.4.1.3.1 Configurations on the SAP Gateway for Time Management - OData Ch1.4.4.1.3.2 Configurations on the SAP ERP System (Provider System) for Time1.4.4.1.3.3 Configurations on the SAP Gateway System (Consumer System) for L1.4.4.1.4 Configurations for ERP Customer- OData Channel1.4.4.1.4.1 Configurations for ERP Customer on the SAP Gateway System# OData1.4.4.1.4.2 Configurations for ERP Customer on the SAP ERP System (Provider1.4.4.1.4.3 Configurations for ERP Customer on the SAP Gateway System (Consu1.4.4.1.5 Configurations for ERP Sales Documents on the SAP Gateway System1.4.4.2 SOA Management Configurations on SAP ERP System1.4.4.2.1 Importing a Profile using a XML Template1.4.4.2.2 Profile Management1.4.4.2.3 Importing Endpoints Template using Business Scenario Configurati1.4.4.2.4 Creating Endpoints using a Business Scenario1.4.4.2.5 Verifying the Endpoints Created1.4.4.2.6 Obtaining the External Key of the Provider System1.4.4.3 SOA Management Configurations on the SAP Gateway System1.4.4.3.1 Importing a Profile File1.4.4.3.2 Creating a System Connection to Provider System1.4.4.3.3 User Account Management1.4.4.3.4 Importing a Business Scenario Configuration XML1.4.4.3.5 Configuring Service Groups using a Business Scenario1.4.4.3.6 Verifying Logical Ports1.4.4.4 Generic Channel Configuration1.4.4.4.1 Defining Settings for Idempotent Services1.4.4.4.2 Creating an RFC Destination for the WSIL Service1.4.4.4.3 Assigning the System Alias Pointing to the SAP System1.4.4.4.4 Checking SAP System Aliases1.4.4.4.5 Subscription Settings1.4.4.5 Code List

    PUBLIC 2014 SAP SE or an SAP affiliate company. All rights reserved.

    Page 3 of 95

  • 1.4.4.5.1 Code List Usage1.4.4.5.2 Customizing the SAP Gateway System for Code List1.4.4.5.3 Code List Cache Cleanup1.4.4.6 Configuration Settings for Generic Channel Scenarios1.4.4.6.1 Settings for Customer Relationship Management on SAP Gateway1.4.4.6.1.1 Configuring GSDO to Connect to the SAP CRM System1.4.4.6.1.1.1 SOA Management Configurations on SAP CRM System1.4.4.6.1.1.1.1 Creating a New Profile in the Provider System1.4.4.6.1.1.1.2 Configuring Provider Systems1.4.4.6.1.1.2 SOA Management Configurations on SAP Gateway System1.4.4.6.1.1.2.1 Creating a Provider System in the Consumer System1.4.4.6.1.1.2.2 User Account Management1.4.4.6.2 Settings for Reporting Management1.4.4.6.2.1 Settings for Reporting Management on SAP Gateway1.4.4.6.2.2 Configuring Subscriptions for Report Results1.4.4.6.2.3 Settings for Reporting Administration1.4.4.6.2.3.1 Managing Source Systems, Report Types and Formats1.4.4.6.2.3.2 Managing Reports and their Properties1.4.4.6.2.3.2.1 Configuring a New Report1.4.4.6.2.3.2.2 Configuring Report Parameters1.4.4.6.2.3.2.3 Configuring Multiple Values for a Parameter1.4.4.6.2.3.2.4 Configuring Delivery Formats for a Report1.4.4.6.2.3.2.5 Specifying Roles for a Report1.4.4.6.2.3.2.6 Report Scheduling1.4.4.6.2.3.3 Managing Categories1.4.4.6.2.3.4 Managing Context Variables1.4.4.6.2.3.5 Configuring System Time Points1.4.4.6.2.3.6 Managing System Time points and Data Change Events

    PUBLIC 2014 SAP SE or an SAP affiliate company. All rights reserved.

    Page 4 of 95

  • 1 SAP Gateway

    Product InformationProduct SAP GatewayRelease 2.0Documentation Published August 2015

    UseSAP Gateway is a development framework, which is available as an SAP NetWeaver Application Server ABAP (AS ABAP) add-on, which you can install ontop 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 aconnection 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 systemsRuntime features, including user interface, secure data access, database connectivity, and network communications for managing applications runningon top of the frameworkInfrastructure and tools for developing applications to run on the framework or to enhance SAP solutions that integrate desktop programs with SAPsystemsConnection 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. Thetools enable you to generate models based on existing:

    Business objects that can be selected from the Business Object Repository (BOR)Remote function modulesDynpro 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. Datacoming 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 StructureThe SAP Gateway documentation consists of the following sections:

    What's New in SAP Gateway 2.0 SPS 10SAP Gateway Master GuideSAP Gateway Installation GuideSAP Gateway Configuration Guide

    PUBLIC 2014 SAP SE or an SAP affiliate company. All rights reserved.

    Page 5 of 95

  • SAP Gateway Technical Operations GuideSAP Gateway Security GuideSAP Gateway Developer GuideSAP Gateway Content Guide

    DisclaimerFeatures 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 theOpen 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.

    RecommendationWe 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-timedevelopment . 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 canchoose between embedded deployment or central hub deployment. For more information, see Embedded Versus Hub Deployment and DeploymentOptions.

    SAP Gateway uses the open source jQuery JavaScript Library v1.6.2:http://jquery.com/Copyright 2011, John ResigDual licensed under the MIT or GPL Version 2 licenses.http://jquery.org/licenseIncludes Sizzle.jshttp://sizzlejs.com/Copyright 2011, The Dojo FoundationReleased under the MIT, BSD, and GPL Licenses.

    ReferencesYou 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 QuickSizer 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. underhttp://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 asRelease Notes.

    Area DetailsFramework, runtime and metadata What's New in the SAP Gateway Framework

    1.1.1 What's New in the Framework

    Technical DataProduct Version SAP Gateway 2.0 SPS 11Area Technology & Innovation PlatformCountry 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 NameSAP NetWeaver Gateway is rebranded to a new name SAP Gateway. This new name, SAP Gateway, is reflected in UIs for all the software components andalso in the documentation.

    PUBLIC 2014 SAP SE or an SAP affiliate company. All rights reserved.

    Page 6 of 95

  • Service Context FacadeFor application development and monitoring the framework offers a service context faade.For more information, see Service Context Facade.

    Support of Conditional ExpressionsIn the SAP Gateway annotation APIs conditional expressions are supported.For more information, see OData Vocabulary Annotations APIs.

    Vocabulary-Based AnnotationsIt is possible to define vocabulary-based annotations in a way that simple values of type STRING can be language-dependent, that is, have different valuesdepending 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.

    Message Text EnhancementsMessage 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 ListYou can use filter options for value lists.For more information, see Metadata Filtering Value List.

    Service-Based Batch ParallelizationYou can deactivate the parallelization of batch queries on service level.For more information, see Defining Parallelization of Batch Queries.

    $expandAn API extension is provided to support $expand with $select query.For more information, see /IWBEP/IF_MGW_ODATA_EXPAND.

    Application LogService IDs are exposed in the Application Log protocol.For more information, see Application Log Viewer.

    Metadata TextsYou 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.

    RoutingA 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 OverviewSAP Gateway and ODataDevelopment OverviewSAP Gateway Service BuilderDeployment OptionsEmbedded Versus Hub DeploymentGlossary

    Documentation StructureFor 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 Gateway Installation GuideSAP Gateway Configuration GuideSAP Gateway Technical Operations GuideSAP Gateway Security GuideSAP Gateway Developer GuideSAP 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. Itaims to reduce the complexity and the skill set required to access SAP data, thereby removing deployment barriers. Simple interfaces also help to shortendevelopment times.SAP Gateway enables people-centric applications to consume SAP Business Suite data through popular platforms and devices (such as the iPad andBlackberry) 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 theREST principle.Depending on your development requirements and where you want to develop SAP Gateway content, you can install SAP in either an SAP Business Suitebackend system (embedded deployment) or in an SAP Gateway hub system (central hub deployment). For more information about the deployment options andavailable 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.

    NoteWhile SAP Gateway uses OData, the OData implementation in place is not a full implementation according to the official OData specification atwww.odata.org . This restriction applies to all OData versions.

    OData for SAP

    For more information about OData, see SAP Gateway and OData.

    More InformationFor 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 datawith 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 applicationsReceive 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), andRSS (Really Simple Syndication) to provide access to information from a variety of applications. It is easy to understand and extensible, and providesconsumers 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, asso 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 thesesnippets can come in large quantities, they must be trimmed down to manageable chunks, sorted according to ad-hoc user preferences, and the result setmust 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 standardAtom elements, and the ability to link data entities within an OData service (via related links) and beyond (via media link entries). This facilitates support

    PUBLIC 2014 SAP SE or an SAP affiliate company. All rights reserved.

    Page 8 of 95

  • 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 ProductsSAP Gateway uses OData for SAP Products, which contains SAP-specific metadata that helps the developer to consume SAP business data, such asdescriptions 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 forits search results, so the OData entities that are returned by the search fit in, and OpenSearch can be integrated into AtomPub service documents vialinks with rel=search, per collection as well as on the top level. The OpenSearch description specifies the URL template to use for searching, and forcollections 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, andtelephony. The client needs to know which OData properties contain a phone number, a part of a name or address, or something related to a calendarevent.Not all entities and entity sets will support the full spectrum of possible interactions defined by the uniform interface, so capability discovery will helpclients avoiding requests that the server cannot fulfill. The metadata document will tell whether an entity set is searchable, which properties may be usedin 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 eventuallyresults 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 areadvertised to the client as special atom links (with an optional embedded simplified form in case the action needs parameters) and the action istriggered by POSTing to the target URI of the link.

    NoteWhile SAP Gateway uses OData, the OData implementation in place is not a full implementation according to the official OData specification atwww.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 youbase an OData service for SAP Gateway either in the Service Builder (transaction SEGW) or in the ABAP Workbench (transaction SE80). The Service Buildernot 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 entireservice 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 Definition2. Service Implementation3. Service Maintenance

    More InformationFor 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 entiredevelopment and modeling process.

    PrerequisitesTo 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 anSAP 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_BEPsince the core SAP Gateway component SAP_GWFND 740 is installed as standard and includes the functional scope of IW_BEP. For more information, seeDeployment Options.

    Project-Based Service DevelopmentThe Service Builder introduces a new service development concept, which is organized around projects. Projects are used to store the artifacts developersneed 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 inparallel and reuse data between projects before generating and activating the actual service.

    PUBLIC 2014 SAP SE or an SAP affiliate company. All rights reserved.

    Page 9 of 95

  • More InformationFor 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 systemCentral hub deployment: service development in SAP Gateway hub systemEmbedded 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 beinstalled 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. Inaddition, you can install the optional components for central hub deployment in your standalone system. For SAP NetWeaver 7.02, 7.03, and 7.31 youcan 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 componentSAP_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 BusinessSuite 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 DeploymentCentral 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 theSAP 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 andhigher, the core component SAP_GWFND is installed as standard and includes the functional scope of IW_BEP

    Embedded DeploymentDeployment 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

    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 thesecomponents in an SAP Business Suite backend system (embedded deployment) or in an SAP Gateway hub system (central hub deployment).

    Name Type Version NotesIW_FND ABAP 250 Contains core functionality of SAP

    Gateway as follows:Runtime componentsMetadata storeShared services, such asmonitoring

    NoteFor SAP NetWeaver 7.40 or higher,see SAP_GWFND.

    GW_CORE ABAP 200 Contains OData libraries.

    NoteFor SAP NetWeaver 7.40 or higher,see SAP_GWFND.

    SAP_GWFND ABAP 740 Available as standard in systems basedon SAP NetWeaver 7.40 or higher. Thiscore component contains the functionalscope of the core components IW_FNDand GW_CORE together with the functionalscope of the components IW_BEP andIW_HDB. Since this core component isincluded as standard in the SAPNetWeaver 7.40 delivery, you do notneed to install it explicitly or thecomponents it comprises, namelyIW_FND, GW_CORE, IW_BEP, IW_HDB.

    NoteIf you have previously createdservices for the Generic Channel thatare still in use, you must install thecomponent IW_FNDGC 100 insystems based on SAP NetWeaver7.40 or higher. You only need toinstall this component if you haveexisting Generic Channel services.

    NoteFor more information about release dependencies, see Installing SAP Gateway Components.

    Optional Components for Central Hub DeploymentThe following optional components are available:

    Name Type Version NotesIW_BEP ABAP 200 Business Enablement Provisioning

    component.You can install this software componentin an SAP Gateway central hub system toenable the implementation of ODataresources in the same way as businessdata in a backend system.

    NoteIf your system is based on SAPNetWeaver 7.40 or higher, you donot need to install IW_BEP since thisfunctional scope is included in thecore component SAP_GWFND, whichis available as standard in the SAPNetWeaver 7.40 delivery.

    IW_CNT ABAP 200 Contains well-defined content, including,for example:

    Metadata describing data objectABAP code for data mappingWeb service consumer and serverproxies

    IW_CBS ABAP 200 Contains application basis functionality,such as SAP Gateway enablement ofSAP NetWeaver Business Workflow.

    PUBLIC 2014 SAP SE or an SAP affiliate company. All rights reserved.

    Page 11 of 95

  • IW_CBS applications are similar toIW_CNT applications.

    IW_HDB ABAP 100 Provides business content adapter forSAP Gateway with SAP HANA thatenables OData exposure of SAP HANAviews.For SAP NetWeaver 7.02, 7.03, and 7.31,you can install this component in an SAPGateway system together with IW_BEP.For SAP NetWeaver 7.40 and higher,you do not need to install componentIW_HDB because the core componentSAP_GWFND already includes thefunctional scope of IW_HDB (andIW_BEP) as standard.

    IW_SPI ABAP 100 Provides a generic OData adapter forcontent based on the Service ProviderInfrastructure (SPI).For SAP NetWeaver 7.02, 7.03, and 7.31,you can install this component in an SAPGateway system together with IW_BEP orin an SAP Business Suite systemtogether with IW_BEP. For SAPNetWeaver 7.40 and higher, the corecomponent SAP_GWFND in installed asstandard and includes the functionalscope of IW_BEP. Consequently you caninstall component IW_SPI in either anSAP Gateway system or an SAPBusiness Suite backend system providedthe system is based on SAP NetWeaver7.40 or higher.

    IW_PGW ABAP 100 Content provider that enables exposurefor SAP NetWeaver Business ProcessManagement (BPM) and ProcessObserver Task exposure for BPM andSAP NetWeaver Business Workflow.For SAP NetWeaver 7.02, 7.03, and 7.31,you can install this component in an SAPGateway system together with IW_BEP orin an SAP Business Suite systemtogether with IW_BEP. For SAPNetWeaver 7.40 and higher, the corecomponent SAP_GWFND in installed asstandard and includes the functionalscope of IW_BEP. Consequently you caninstall component IW_PGW in either anSAP Gateway system or an SAPBusiness Suite backend system providedthe system is based on SAP NetWeaver7.40 or higher.

    Optional Components for SAP Business Suite SystemYou can install the following components in an SAP Business Suite system:

    Name Type Version NotesIW_BEP ABAP 200 Business Enablement Provisioning

    component

    NoteFor SAP NetWeaver 7.40 and higher,the core component SAP_GWFND ininstalled as standard and includesthe functional scope of IW_BEP.

    IW_SCS ABAP 200 Component for Screen Scrapinggenerator.

    IW_GIL ABAP 100 Provides a generic OData adapter forcontent based on the Generic InteractionLayer (GenIL).For SAP NetWeaver 7.01, 7.02, 7.03, and7.31, you can install this component inan SAP Business Suite system togetherwith IW_BEP. For SAP NetWeaver 7.40and higher, the core componentSAP_GWFND in installed as standard andincludes the functional scope of IW_BEP.Consequently you can install component

    PUBLIC 2014 SAP SE or an SAP affiliate company. All rights reserved.

    Page 12 of 95

  • IW_GIL in an SAP Business Suitebackend system provided it is based onSAP NetWeaver 7.40 or higher.

    IW_SPI ABAP 100 Provides a generic OData adapter forcontent based on the Service ProviderInfrastructure (SPI).For SAP NetWeaver 7.02, 7.03, and 7.31,you can install this component in eitheran SAP Business Suite system or anSAP Gateway system together withIW_BEP. For SAP NetWeaver 7.40 andhigher, the core component SAP_GWFNDis in installed as standard and includesthe functional scope of IW_BEP.Consequently you can install componentIW_SPI in either an SAP Business Suitesystem or in an SAP Gateway systemprovided it is based on SAP NetWeaver7.40 or higher.

    IW_PGW ABAP 100 Content provider that enables exposurefor SAP NetWeaver Business ProcessManagement (BPM) and ProcessObserver Task exposure for BPM andSAP NetWeaver Business Workflow.For SAP NetWeaver 7.00, 7.01, 7.02,7.03, and 7.31, you can install thiscomponent in either an SAP BusinessSuite system or an SAP Gateway systemtogether with IW_BEP. For SAPNetWeaver 7.40 and higher, the corecomponent SAP_GWFND is in installed asstandard and includes the functionalscope of IW_BEP. Consequently you caninstall component IW_PGW in either anSAP Business Suite system or in an SAPGateway system provided it is based onSAP NetWeaver 7.40 or higher.

    More InformationFor 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, youcan 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 ScenariosTo help you decide whether embedded or central hub deployment is the most suitable for you, see the following three deployment scenarios. Thesedeployment 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 SystemSAP NetWeaver Release Software Components Installed in SAP Gateway Hub

    SystemInstalled in SAP Business SuiteBackend 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 ofSAP 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 isstored.

    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 thebackend 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. Minimumrequirement for installation in the backend system is SAP NetWeaver 7.00 Support Package 18.

    Considerations for SAP NetWeaver Release 7.40As 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 SystemSAP NetWeaver Release Software Components Installed in SAP Gateway Hub

    SystemInstalled in SAP Business SuiteBackend 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 deploymentscenario with an installation of IW_BEPin the backend system.

    SAP NetWeaver 7.40 and higher SAP_GWFND X (X available as standard as part ofSAP 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.

    ConsiderationsThe 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. Dependingon the setup of the backend system, this might not be permitted. Minimum requirement for installation in the backend system is SAP NetWeaver7.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. Youmight 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 SystemSAP NetWeaver Release Software Components Installed in SAP Gateway Hub

    SystemInstalled in SAP Business SuiteBackend 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 businesslogic.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

    actionPrepackaged business logic attached to an entity type.

    annotationMetadata 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 andactions through SAP Gateway.

    PUBLIC 2014 SAP SE or an SAP affiliate company. All rights reserved.

    Page 14 of 95

  • 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 systemSAP Business Suite backend system.

    central hub deploymentDeployment of core software components IW_FND and GW_CORE on the SAP Gateway central hub system.

    collectionResource 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 modelRepresents 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 oneor more corresponding entity types or collections in the resulting service. Exposed as service document plus service metadata document in the OData world.

    content generatorSAP Gateway design-time tool that enables a developer to create content quickly without having to write source code. The content is then available for usethrough SAP Gateway. There are three different content generators, Business Object Repository (BOR), Remote Function Call (RFC), and Screen Scraping(SCS).

    data modelRoot entity representing a certain self-contained business object that defines a people-centric view on respective business information. The nodes of thishierarchy are called entity types.

    data provider class (DPC)Provides all application data of a service to the runtime.

    embedded deploymentDeployment 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 . It has a unique identity, independent existence, and forms the operational unit of consistency. An has a name, a payload consisting of one or more declared properties and a that describes the set of properties whose values uniquelyidentify 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 providerApplication-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 ChannelProgramming paradigm for SAP Gateway. Infrastructure components that enable SAP Gateway content to abstract data from the exposed protocol and thebusiness 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 systemSAP Gateway system.

    metadata documentComplete 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 onesystem.

    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 itbelongs.

    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 oneither an SAP Business Suite backend system or on the SAP Gateway system. You are no longer recommended to use SAP Gateway ODC (using the coresoftware component IW_FND).

    OData for SAP ProductsOData 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 theconsumption of OData services.

    OData serviceDevelop 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, AtomPublishing Protocol (AtomPub), and JSON to provide access to information from a variety of applications.

    projectUsed in SAP Gateway Service Builder to consolidate and store all artifacts needed to create a service and model in one place. Projects provide developerswith the freedom to interrupt the service development and modeling process at any time, without being bound to runtime artifacts and without risk of losingdata.

    propertyAn can have one or more properties of the specified EDMSimpleType or ComplexType. A property can be a declared property or a dynamicproperty. The declared properties of an of are defined using the element.

    SAP GatewaySAP Gateway enables people-centric applications to consume SAP Business Suite data through popular devices and platforms in an easy and standards-based fashion.

    Screen ScrapingGenerator for transforming ABAP dynpro screens into SAP Gateway services.

    self linkIn an OData entity or a feed a self link is a link to the entity or the feed itself, for example .

    PUBLIC 2014 SAP SE or an SAP affiliate company. All rights reserved.

    Page 16 of 95

  • serviceExposed as an OData service to be consumed by an external application (such as JavaScript-based client). Is a repository object used for routing (systemaliases are assigned to a service) and authorization checks. It has a dedicated ICF node and contains one or more data models.

    Service BuilderIs a dedicated design-time transaction, which provides a toolset for creating OData services easily and efficiently and supports the entire service developmentlife 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 callRequest sent to the OData service root URI or a resource path extending it.

    service documentTop-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 ofone or more entity sets.

    thingTangible work object from a user perspective.

    thing typeEntity that defines tangible work objects. A prominent entity type fulfilling additional constraints.

    User Self ServiceSAP Gateway feature (similar to the User Management capability of Business-to-Consumer (B2C) scenario) using which SAP Business Suite B2C customerscan 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 orapplication 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 chapterfocuses on all aspects concerning the installation of SAP Gateway:

    Installation PrerequisitesInstalling SAP Gateway ComponentsUnicode and Non-Unicode Support

    More InformationFor 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

    HardwareThe minimum hardware requirements for SAP Gateway are as follows:

    Requirements SpecificationProcessor Dual Core (2 logical CPUs) or higher, 2 GHz or higherRandom Access Memory (RAM) 8 GB or higherHard Disk Capacity 80 GB primary, or higher

    SoftwareThe minimum software requirements for SAP Gateway are as follows:

    Requirements SpecificationSAP NetWeaver Stack 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 ComponentsGW_CORE and IW_FND

    SAP NetWeaver 7.0 SPS25SAP NetWeaver 7.01 SPS10SAP NetWeaver 7.02 SPS07SAP NetWeaver 7.03 SPS01SAP NetWeaver 7.31 SPS01

    Core ComponentSAP Gateway Foundation SAP_GWFND

    NoteComprises functional scope of componentsIW_FND, GW_CORE, IW_BEP, and IW_HDB.

    SAP NetWeaver 7.40 SPS01

    Business Enablement Provisioning ComponentIW_BEP

    SAP NetWeaver 7.0 SPS18SAP NetWeaver 7.01 SPS03SAP NetWeaver 7.02 SPS06SAP NetWeaver 7.03 SPS01SAP NetWeaver 7.31 SPS01

    Content Adapter ComponentsIW_PGWScreen Scraping ComponentIW_SCS

    SAP NetWeaver 7.0 SPS18SAP NetWeaver 7.01 SPS03SAP NetWeaver 7.02 SPS06SAP NetWeaver 7.03 SPS01SAP NetWeaver 7.31 SPS01SAP NetWeaver 7.40 SPS01

    Content Adapter ComponentIW_SPI

    SAP NetWeaver 7.02 SPS06SAP NetWeaver 7.03 SPS01SAP NetWeaver 7.31 SPS01SAP NetWeaver 7.40 SPS01

    Content Adapter ComponentIW_HDB

    SAP NetWeaver 7.02 SPS09SAP NetWeaver 7.03 SPS01SAP NetWeaver 7.31 SPS01

    Minimal requirement of HANA database version:SAP HANA 1.0 SPS02

    Content Adapter ComponentIW_GIL

    SAP NetWeaver 7.01 SPS03SAP NetWeaver 7.02 SPS06SAP NetWeaver 7.03 SPS01SAP NetWeaver 7.31 SPS01SAP NetWeaver 7.40 SPS01

    Content ComponentsIW_CNT and IW_CBS

    SAP NetWeaver 7.02 SPS07SAP NetWeaver 7.03 SPS01SAP NetWeaver 7.31 SPS01SAP NetWeaver 7.40 SPS01

    SAP WEB UIF Core Component VersionIW_FND 250

    SAP WEB UIF 7.01 SP01SAP WEB UIF 7.31 SP00

    Optional Core ComponentIW_FNDGC (for Generic Channel)

    SAP WEB UIF 7.46 SP00SAP WEB UIF 7.47 SP01

    Content Adapter ComponentIW_GIL

    SAP WEB UIF 7.0 SP03SAP WEB UIF 7.01 SP00SAP WEB UIF 7.31 SP00SAP WEB UIF 7.46 SP00SAP WEB UIF 7.47 SP01

    SAP Backend SAP Business Suite system

    More InformationFor 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 SAPNotes 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 fromyour 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 SAPGateway 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.0components are non-modifying components. For more information, see SAP Note 1569624 .

    SAP Gateway 2.0

    PUBLIC 2014 SAP SE or an SAP affiliate company. All rights reserved.

    Page 18 of 95

  • Core ComponentsSAP NetWeaver 7.0 and 7.01

    GW_CORE 190IW_FND 240

    SAP NetWeaver 7.02, 7.03, and 7.31GW_CORE 200IW_FND 250

    SAP NetWeaver 7.40 and higherSAP_GWFND 740: SAP Gateway Foundation 7.40This core component is available as standard in systems based on SAP NetWeaver 7.40 higher and provides the core functional scopecomprising IW_FND 250, GW_CORE 200, IW_BEP 200, and IW_HDB 100. Consequently, if you have an SAP NetWeaver 7.40installation, you can use SAP Gateway without having to install any additional software components.

    NoteIf 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 GenericChannel services.

    For more information about the systems in which you can install these core components, see Deployment OptionsFor more information about the system prerequisites for these core components see, Installation PrerequisitesBusiness Enablement Provisioning Component

    SAP NetWeaver 7.0, 7.01, 7.02, 7.03, and 7.31IW_BEP 200Enables OData Channel programming paradigm and is required for SAP Gateway Service Builder to build OData services. While thiscomponent is, in theory, optional, you require an installation of it in either your SAP Business Suite backend system or your SAP Gatewaysystem if you want to install the content adapter components.

    SAP NetWeaver 7.40 and higherSAP_GWFND 740: SAP Gateway Foundation 7.40This 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 ComponentsIW_HDB 100Provides business content adapter for SAP Gateway with SAP HANA that enables OData exposure of SAP HANA views.

    NoteFor systems based on SAP NetWeaver 7.40 and higher, you do not need to install this component since the functional scope is included inthe core component SAP_GWFND 740, which is available as standard.

    IW_SPI 100Provides a generic OData adapter for content based on the Service Provider Infrastructure (SPI).IW_PGW 100Enables exposure for SAP NetWeaver Business Process Management (BPM) and Process Observer Task exposure for BPM and SAPNetWeaver Business Workflow.IW_GIL 100Provides 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, andIW_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 ComponentsContent is provided in predefined groups. Examples of such content are customer, account, and leave request grouped under CRM (CustomerRelationship 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 200IW_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 200You 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. Fordetailed 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 InformationFor 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 SupportPUBLIC 2014 SAP SE or an SAP affiliate company. All rights reserved.

    Page 19 of 95

  • 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 services EDM model, for example, a property name) contains characters that are notin 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 codepage, then the following applies: A conversion into STRING is done which converts characters that are not available in the system code-page into thehash 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 ina 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 stacklevel at least the following SAP Notes have to be applied as well:

    199492819950541995517

    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 datarequested 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 Configuration3. Configuration Settings for content scenarios (optional)

    Implementation GuideThe SAP Gateway specific configuration tasks are included in the SAP Gateway Implementation Guide (IMG) which is available in the system: In your SAPGateway hub system (IW_FND) go to transaction SPRO, open the SAP Reference IMG and navigate to: SAP NetWeaver SAP Gateway . In yourbackend 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 beforeexecuting each step.

    NoteIf 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.

    RecommendationWe 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-timedevelopment . 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 canchoose between embedded deployment or central hub deployment. For more information, see Embedded Versus Hub Deployment and DeploymentOptions.

    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 GenericChannel .In the SAP Gateway hub system these are the sections in the SAP Reference IMG under SAP NetWeaver SAP Gateway Former Development

    .

    Additional Software ComponentsDepending 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 certainauthorization templates. The templates specify the authorizations for content thatcan 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

  • SAP Gateway with HANA (IW_HDB) If you want to install the SAP Gateway with HANA component (IW_HDB), thisrequires SAP NetWeaver 7.02 SPS09 comprising an ABAP Database Connectivity(ADBC) installation. ADBC is an object-based ABAP API for programming relationaldatabase accesses. It follows the Java Database Connectivity (JDBC) diction in itsclass and model structure.

    Workflow You can find more information about the Workflow-related configuration activities inConfiguring Workflow for SAP Gateway. In addition, the relevant IMG activities areavailable in the Implementation Guide in the backend system: In transaction SPROopen the SAP Reference IMG and navigate to: SAP NetWeaver SAP GatewayService Enablement Content Workflow Settings .

    Business Process Enablement For the special services provided within Business Process Enablement, such asProcess Service and Process Context Service, the relevant IMG activities areavailable in the Implementation Guide in the backend system. In transaction SPROopen the SAP Reference IMG and navigate to: SAP NetWeaver SAP GatewayService Enablement Content Business Process Enablement .

    Consumer SettingsFor information on configuration settings which need to be carried out for the different consumer scenarios and applications, see Configuration Settings forSAP 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 ExampleFully 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 SAPNetWeaver AS ABAP to install and maintain the system

    SAP administrator

    HTTP/HTTPS ports HTTP and HTTPS port numbers of the central instanceof the AS ABAP

    80000 for HTTP and 80001 for HTTPS

    SAP system For each SAP system to which you want to connect theSAP Gateway server, you need the followinginformation:

    System ID, system numberServer nameHTTP / HTTPS portAdministrator credentials

    In addition, several settings are important for smooth operations:Profile ParametersICF ServicesInitial LogonLanguage 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 Valuelogin/accept_sso2_ticket 1

    login/create_sso2_ticket 2

    You maintain these profile parameters via transaction RZ10.

    More InformationFor information on profile parameters and profile parameter maintenance, see Profile Parameters for Logon and Password (Login Parameters) and Changingand 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 forsecurity reasons. After the installation you have to decide which services must be activated for the applications you want to use.

    PUBLIC 2014 SAP SE or an SAP affiliate company. All rights reserved.

    Page 21 of 95

  • CautionActivated ICF services represent a security risk because they can be accessed directly by the HTTP protocol from the Internet. You therefore need to usesuitable 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 ICFsubnodes (services). For example, if you want to activate the services for URL /sap/public/icman, you have to activate the service tree default_hostin 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 withtree icon).For SAP Gateway you need to activate the following services:

    /sap/public/opuNote that /sap/public/opu/resources is needed for loading resources, such as images in the MIME repository. For example, the generic playergets a service document which contains links to images which the player should display for a Sales Order. Then the generic player downloads the imagevia 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 followingnodes on your target system:

    /sap/bc/srt/xip/sap/sap/bc/webdynpro/sap/saml2/sap/public/bc/sap/public/bc/ur/sap/public/mysssocnt

    NoteIf the default_host node is inactive in transaction SICF, the HTTP requests could result in an ABAP runtime error RAISE_EXCEPTION with thefollowing 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 theImplementation Guide for SAP NetWeaver is: Application Server Internet Communication Framework Activate HTTP Services or Activate Servicesin Installation .Note that the system performs a check against the authorization object S_ICF_ADM when an ICF node is created.

    Standard ModeThis standard mode refers to the ICF node /sap/opu/odata. This node is available for OData Channel based applications. When creating a service a newnode is created automatically.

    NoteThe standard mode is the default for all new applications. All new development will be done on this mode. New functions and features will beavailable 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 protectionSee also Cross-Site Request Forgery ProtectionContent-Type required for Put/Post requestAn 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 RequestEmpty property elements (for example, ) are not allowed anymore. Nullable needs to be set properly, and besides that, if an entry with a nullstring is to be created set m:null="true", for example, .

    PUBLIC 2014 SAP SE or an SAP affiliate company. All rights reserved.

    Page 22 of 95

  • Null values in the response of a Get/Put requestIntial values for date time fields in combination with nullable properties are rendered as .Values of keys in Post request in case of server generated keysIf the keys are generated on the server the values need to be filled in the post request anyway. m:null is not allowed.Rendering of key predicatesSee http://www.odata.org/developers/protocols/overview#AbstractTypeSystem .Key propertiesSending properties that are not key fields in an URI is not longer possible.String parametersQuotation marks enclosing string parameters (for example, search string) are now required and removed.Parameters for function importsParametrize with literals, for example, datetime.... See also http://www.odata.org/developers/protocols/overview#AbstractTypeSystem .Inverted commas in URIInverted commas in URI, for example, $filter=name eq 'Jame''s shop' can now be properly escaped by an inverted comma.OData error responseThe OData error response has been enhanced. See http://www.odata.org/media/6655/%5Bmc-apdsu%5D%5B1%5D.htm#_Toc246716641 .The code field is now either build from the leading error message of the message container or build from the text id of the exception.The structured inner error section is available showing Extended Passport (EPP) transaction ID. All messages of the message container and theadditionally provided error details are shown in a special format (micro format).ThingsThe workspace for Things, element , is no longer available.Service maintenanceThe service maintenance transaction distinguishes between services of the Standard Mode and of the Compatibility Mode for SP02 .

    Compatibility Mode for SP02This compatibility mode for SAP Gateway 2.0 SP02 refers to the ICF node /sap/opu/sdata. This node is available for existing applications which might bebased either on OData Channel or Generic Channel.

    CautionThis node is in maintenance mode.

    The request handler for this node is /IWFND/CL_SDATA_ODATA_APP.

    Alias Handling in ICFThe ICF standard function of external aliases is also available for SAP Gateway for the Standard Mode , that is, for ICF node /sap/opu/odata. Thus youcan define an external alias for your service if you have registered class /IWFND/CL_SODATA_HTTP_HANDLER as handler in the Handler List for yourservice node.

    NoteNote 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 activateyour service. After the handler has been set, you can define the external alias.

    More InformationAdministration of ICF server functions (authorization assignment): Server Function AdministrationAdministration of ICF client functions (creation of RFC destinations, and so on): Client Function AdministrationICF services: Creating and Configuring an ICF ServiceAuthentication: Defining the Logon Procedure

    1.4.1.3 Changing Password for Initial Logon

    NoteThis section is only relevant if you want to change the password for the initial logon procedure.

    The logon configurations for SAP Gateway are handled via the ICF layer. For more information, see Defining the Logon Procedure.SAP systems may require some additional (browser) features if the password needs to be changed because of being initial or outdated. Therefore, the ICFnodes can be configured to permit the initial password change and the direct logon. An additional ICF node is offered to allow the change of passwords with abrowser.

    Using an ICF Node for Changing PasswordsSAP Gateway offers a special ICF node which can be accessed to change the password, for example for the initial logon sequence. This node is used tochange the password and to redirect to any other custom web page.

    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 :/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 additionalinformation, 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 takeprecedence over all basic settings.

    Changing the Password for ICF Nodes Accessed by Mobile Devices1. In transaction SICF choose Execute (F8) to display the service tree hierarchy.2. Expand the default host and navigate to the ICF parent node of the initial logon /default_host/sap/opu/utils/initial_logon. This node shall

    be the root node which is accessed by your mobile devices and where you want to deny the direct access via mobile device.3. Double-click on the node and change to edit mode.4. On tab Error Pages choose sub-tab Logon Errors .5. Choose System Logon .6. Choose Configuration .7. Choose Define Service-Specific Settings .8. Under Logon Layout and Procedure choose Custom Implementation and enter ABAP Class /IWFND/CL_COC_SYSTEM_LOGIN.9. Choose Input (Enter) to save your settings.

    CautionIf 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 URLThe 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 InformationFor more information on the generic system logon functionality in ICF, see System Logon.

    1.4.1.4 Language Settings The language which is displayed to the user depends on a variety of factors. For more information see Determining the Logon Language.As to languages, the SAP Gateway system supports only the intersecting set of the languages of the connected SAP Business Suite backend systems.

    1.4.2 SAP Gateway Configuration Depending on your underlying SAP NetWeaver release the configuration settings for SAP Gateway and the structure in the Implementation Guide (IMG) maydiffer.

    SAP NetWeaver 7.00 and 7.01The OData Channel configuration settings are available in the Implementation Guide (IMG) in the system where software component IW_FND is deployed. Inthe SAP Reference IMG navigate to SAP NetWeaver SAP Gateway .

    SAP NetWeaver 7.02 and 7.31The OData Channel configuration activities are listed in the Implementation Guide (IMG) in the system where software component IW_FND is deployed. In theSAP Reference IMG navigate to 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 theImplementation Guide (IMG) in the backend system where software component IW_BEP is deployed. In the SAP Reference IMG navigate to SAPNetWeaver SAP Gateway Service Enablement Backend OData Channel .

    PUBLIC 2014 SAP SE or an SAP affiliate company. All rights reserved.

    Page 24 of 95

  • OData Channel IMG in IW BEP

    SAP NetWeaver 7.40If you use software component SAP_GWFND in SAP NetWeaver 7.40, IMG activities for SAP Gateway Foundation 7.40 are available. In the SAP ReferenceIMG navigate to SAP NetWeaver SAP Gateway and SAP NetWeaver SAP Gateway Service Enablement . There you find all the relevantOData Channel IMG activities.

    SettingsUser, Developer and Administrator AuthorizationsConnection Settings: SAP Gateway to SAP SystemsActivating SAP GatewayService Development in the Backend SystemService Development in the SAP Gateway Hub SystemConnection Settings to SAP Gateway

    More InformationBasic Configuration SettingsOData Channel

    1.4.2.1 User, Developer, and Administrator Roles After you have installed the SAP Gateway components you require, you need to set up an administrator role for SAP Gateway components and assign usersto it. Then you set up one or several user roles and assign users to it as well. As you cannot change existing SAP roles, you create your own roles or copyexisting roles to your new custom roles.The SAP system includes templates as opposed to actual users, so you must use the available role templates to create the users you require in the SAPGateway system. If the users you require exist in your SAP Business Suite backend system, you can replicate these users in the SAP Gateway system byconnecting the SAP Gateway system to Central User Administration or to SAP Identity Management and synchronize the users in this way. If this is notpossible, you must create the users manually.SAP Gateway provides predefined roles as templates for:

    DevelopersAdministratorsEnd users of the different content scenariosThese templates follow the naming convention /IWCNT/RT_USER_.Support colleaguesThese templates provide display authorizations only and are intended to be used by support colleagues who need to view applications logs.

    Use the predefined templates to create administrator, developer, user, and support roles for SAP Gateway components. The template names begin with anamespace ID that corresponds to the software components you use.

    SAP Gateway Developer RoleCreate a developer role based on the available templates for all users that are to carry out development tasks such as creating services. Use the developerrole /IWBEP/RT_MGW_DSP for accessing a remote system from the Service Builder (transaction SEGW) at design time.The following templates are available for developers:

    Template Type Template Name Template forFramework /IWFND/RT_BOR_DEV SAP Gateway BOR Developer

    Framework /IWFND/RT_DEVELOPER SAP Gateway Developer

    PUBLIC 2014 SAP SE or an SAP affiliate company. All rights reserved.

    Page 25 of 95

  • OData Channel /IWBEP/RT_MGW_DEV OData Channel Developer

    Screen Scraping /IWSCS/RT_SCR_DEV SAP Gateway Screen Scraping DeveloperFor more information, see Assigning Authorization toTransaction and Search Help

    SAP Gateway Administrator RoleCreate a role for an administrator user with permissions and privileges for several tasks, including the following:

    Create services.Analyze logs and identify potential issues with the SAP Gateway landscape.Install, configure, and maintain SAP Gateway components and applications that run on SAP Gateway.Configure and maintain users data including roles and user mapping.

    In the SAP Reference Implementation Guide (IMG) (transaction SPRO), navigate to SAP NetWeaver SAP Gateway OData Channel Configuration User Settings Define Role for SAP Gateway Administrator 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 accesstransaction SPRO and find the SAP Gateway Implementation Guide there. You can now log onto the SAP Gateway host as the administrator user you havejust 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 forFramework /IWFND/RT_ADMIN SAP Gateway Framework Administrator

    Content Scenario /IWCNT/RT_ADMIN_REP SAP Gateway Reporting Management Administrator.See Settings for Reporting Management for details onauthorizations required.

    OData Channel /IWBEP/RT_MGW_ADM OData Channel Administrator

    Business Enablement Provisioning (IW_BEPcomponent)

    /IWBEP/RT_BEP_ADM Business Enablement Provisioning Administrator

    Workflow /IWWRK/RT_WF_ADM SAP Gateway Workflow Administrator

    Task Gateway /IWPGW/RT_WF_ADM SAP Gateway Task Gateway Administrator

    SAP Gateway User RoleCreate a role for a user with permissions and privileges for user-specific tasks. Depending on your application, you can either specify different authorizationsfor different user roles or have all authorizations bundled together in one user role.

    NoteYou 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 SAP NetWeaver SAP Gateway OData Channel Configuration User Settings Define Role for SAP Gateway User 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 toyour 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 onsuccessfully. 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 forFramework /IWFND/RT_GW_USER SAP Gateway User

    Framework /IWFND/RT_TU_NOTIF SAP Gateway Technical User for Notifications

    Content Scenario /IWCNT/RT_USER_LEMA SAP Gateway Leave Management User.See Settings for Leave Management Application fordetails on authorizations required.

    Content Scenario /IWCNT/RT_USER_REP SAP Gateway Reporting Management UserSee Settings for Reporting Management for details onauthorizations required.

    PUBLIC 2014 SAP SE or an SAP affiliate company. All rights reserved.

    Page 26 of 95

  • Content Scenario /IWCNT/RT_USER_SS SAP Gateway Sample Services User

    Content Scenario /IWCNT/RT_USER_TRVL SAP Gateway Travel User

    Content Scenario /IWCNT/RT_USER_TIMA SAP Gateway Time Management User.See Settings for Time Management Application fordetails on authorizations required.

    Content Scenario /IWCNT/RT_USER_WF SAP Gateway Workflow User

    Content Scenario /IWCNT/RT_USER_ACT SAP Gateway Activity Management UserSee Settings for Customer Relationship Managementon SAP Gateway for details on authorizations required.

    Content Scenario /IWCNT/RT_USER_ACCNT SAP Gateway User for Account ManagementSee Settings for Cust