SAP Gateway

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 Help Portal. Note This PDF document contains the selected topic and its subtopics (max. 150) in the selected structure. Subtopics from other structures are not included. The selected structure has more than 150 subtopics. This download contains only the first 150 subtopics. You can manually download the missing subtopics. © 2016 SAP SE or an SAP affiliate company. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP SE. The information contained herein may be changed without prior notice. Some software products marketed by SAP SE and its distributors contain proprietary software components of other software vendors. National product specifications may vary. These materials are provided by SAP SE and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty. SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP SE in Germany and other countries. Please see www.sap.com/corporate-en/legal/copyright/index.epx#trademark for additional trademark information and notices. Table of content PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved. Page 1 of 95 Table of content 1 SAP Gateway 1.1 What's New in SAP Gateway 2.0 SPS 11 1.1.1 What's New in the Framework 1.2 SAP Gateway Master Guide 1.2.1 General Overview 1.2.2 SAP Gateway and OData 1.2.3 Development Overview 1.2.4 SAP Gateway Service Builder 1.2.5 Deployment Options 1.2.6 Embedded Versus Hub Deployment 1.2.7 Glossary 1.3 SAP Gateway Installation Guide 1.3.1 Installation Prerequisites 1.3.2 Installing SAP Gateway Components 1.3.3 Unicode and Non-Unicode Support 1.4 SAP Gateway Configuration Guide 1.4.1 General Configuration Settings 1.4.1.1 Profile Parameters 1.4.1.2 ICF Services 1.4.1.3 Changing Password for Initial Logon 1.4.1.4 Language Settings 1.4.2 SAP Gateway Configuration 1.4.2.1 User, Developer, and Administrator Roles 1.4.2.1.1 Creating and Assigning Roles 1.4.2.2 Connection Settings for SAP Gateway Hub System 1.4.2.2.1 Connection Settings: SAP Gateway to Consumers 1.4.2.2.1.1 Creating an RFC Destination for Outbound Queues 1.4.2.2.1.2 Registering an RFC Destination for Outbound Queues 1.4.2.2.1.3 Creating a bgRFC Supervisor Destination 1.4.2.2.2 Connection Settings: SAP Gateway to SAP Systems 1.4.2.2.2.1 Creating an RFC Destination for SAP Gateway Hub to SAP System 1.4.2.2.2.2 Defining Trust for SAP Systems 1.4.2.2.2.3 Configuring SAP System to Accept Assertion Tickets from SAP Gate 1.4.2.2.2.4 Configuring SAP Gateway Host to Accept Assertion Tickets from SA 1.4.2.2.2.5 Creating an SAP System Alias 1.4.2.2.2.6 System ID in Origin Segment Parameter 1.4.2.3 Activating SAP Gateway 1.4.2.4 Service Development in the Backend System 1.4.2.4.1 Maintaining Models and Services 1.4.2.4.2 Displaying Models and Services 1.4.2.4.3 Defining Parallelization of Batch Queries 1.4.2.5 Service Development in the SAP Gateway Hub System 1.4.2.5.1 Assigning SAP System Alias to OData Service 1.4.2.5.2 Multiple Origin Composition 1.4.2.5.3 Dynamic System Alias Calculation Via /IWFND/ES_MGW_DEST_FINDER 1.4.2.6 Connection Settings to SAP Gateway 1.4.2.6.1 Defining Settings for Idempotent Services 1.4.2.6.2 Defining a Remote Function Call to SAP Gateway 1.4.2.6.3 Connection Settings to SAP Gateway 1.4.2.6.4 Configure the bgRFC Supervisor Destination 1.4.2.6.5 Monitoring bgRFC Queues 1.4.3 Configuration Settings for SAP Gateway Supported Scenarios 1.4.3.1 Configuration Settings for OData Channel Scenarios 1.4.3.1.1 Configuring Workflow for SAP Gateway 1.4.3.1.1.1 Creating an Administrator Role for Workflow 1.4.3.1.1.2 Customizing SAP Gateway Workflow 1.4.3.1.1.2.1 Configuring Workflow Notifications 1.4.3.1.1.2.1.1 Creating a Type G RFC Destination 1.4.3.1.1.2.1.2 Configuring User Authorizations for Push Notifications 1.4.3.1.1.2.1.3 Running Scheduled Reports PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved. Page 2 of 95 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 PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved. Page 3 of 95 2.6.6.4.1 Settings for Customer Relationship Management on SAP Gateway 1.4.6.4.1 Managing Source Systems.1 Creating a New Profile in the Provider System 1.6.6.6.6.4.2.2.1.3.1.1.4.2.4.4.1.2.5 Configuring System Time Points 1.6.3 Code List Cache Cleanup 1.2.6.5.1.6.5 Specifying Roles for a Report 1.6.4.4.1.4.6.4.4.2.1.4.4.3.6.2 Customizing the SAP Gateway System for Code List 1.6.2 SOA Management Configurations on SAP Gateway System 1. Page 4 of 95 .2.4.2.4.4.4.3.4.6.1.4.4.4.4.6.4.4.4 Managing Context Variables 1.4.2.4. Report Types and Formats 1.1.3 Managing Categories 1. All rights reserved.4.4.1 Code List Usage 1.6.4.6.2.6.4.4.1.6.4.3.4.1 Configuring GSDO to Connect to the SAP CRM System 1.4.5.4.2.1.6.4.4.3 Settings for Reporting Administration 1.6.6 Report Scheduling 1.4.1 Settings for Reporting Management on SAP Gateway 1.4.4.6 Configuration Settings for Generic Channel Scenarios 1.4.2.4.4.2.3.4.1 Creating a Provider System in the Consumer System 1.5.3.4.2.3.3.2 Managing Reports and their Properties 1.2.2.1.4.4.6.4 Configuring Delivery Formats for a Report 1.1.2.4.1.2 Configuring Report Parameters 1.2.1 Configuring a New Report 1.4.2 Configuring Provider Systems 1.4.1.4.4.3.3 Configuring Multiple Values for a Parameter 1.1.3.1 SOA Management Configurations on SAP CRM System 1.2 Settings for Reporting Management 1.2.2.2.3.2 Configuring Subscriptions for Report Results 1.3.6.2 User Account Management 1.4.4.4.2.6 Managing System Time points and Data Change Events PUBLIC © 2014 SAP SE or an SAP affiliate company. and programming framework. This tool is based on the ABAP Workbench (SE80) and requires ABAP coding skills. it establishes a connection between SAP Business Suite data and target clients. The software also offers a tool to develop models. Put simply. which is available as an SAP NetWeaver Application Server ABAP (AS ABAP) add-on.1 SAP Gateway Product Information Product SAP Gateway Release 2. Data coming from multiple objects can be aggregated. filtered and adapted based on the client application requirements. secure data access. including user interface. database connectivity. platforms. Page 5 of 95 . All rights reserved. Documentation Structure The SAP Gateway documentation consists of the following sections: What's New in SAP Gateway 2. 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. 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. speed up development time. SAP Gateway provides the following functionality: Runtime environment for SAP solutions that integrates desktop programs with SAP systems Runtime features.0 Documentation Published August 2015 Use SAP Gateway is a development framework.0 SPS 10 SAP Gateway Master Guide SAP Gateway Installation Guide SAP Gateway Configuration Guide PUBLIC © 2014 SAP SE or an SAP affiliate company. 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. 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.0 Support Package Stack 11. http://jquery.com/sizing Sizer Tool . blogs. you can choose between embedded deployment or central hub deployment. All rights reserved. The Dojo Foundation Released under the MIT. Area Details Framework. Do not use objects in the /IWCOR namespace. John Resig Dual licensed under the MIT or GPL Version 2 licenses. References You can find additional information about SAP Gateway in SAP Note 1560585 Further release constraints are listed in SAP Note 1574568 . any deviation from this standard is not intentional and is subject to change. are intended to be in accordance with the standards outlined in the Open Data Protocol Specification v2. you are strongly recommended to use the Service Builder (transaction SEGW) for your OData design-time development . 1. and Quick The SAP Community Network (SCN) offers additional information. under http://scn. and GPL Licenses.org ). see Embedded Versus Hub Deployment and Deployment Options. Consequently.sap. PUBLIC © 2014 SAP SE or an SAP affiliate company.1 What's New in the Framework Technical Data Product Version SAP Gateway 2.SAP SAP SAP SAP Gateway Technical Operations Guide Gateway Security Guide Gateway Developer Guide Gateway Content Guide Disclaimer Features of the standard mode. etc. As of SAP Gateway 2.com/community/gateway .0. You can use the Quick Sizer Tool for your hardware calculations for your system landscape. Depending on whether you want to develop SAP Gateway content in an SAP Business Suite backend system or in an SAP Gateway hub system.com/ Copyright 2011. For more information.1. Sizing information for SAP Gateway is available on the SAP Service Marketplace in the Quick Sizer Tool under http://service.0 (see http://odata. Only use official APIs. runtime and metadata What's New in the SAP Gateway Framework 1. see SAP Gateway Service Builder. This information is provided as Release Notes. New Name SAP NetWeaver Gateway is rebranded to a new name SAP Gateway. BSD. introduced with Support Package 03 for SAP Gateway 2.sap.js http://sizzlejs. SAP Gateway uses the open source jQuery JavaScript Library v1.1 What's New in SAP Gateway 2. For more information.2: http://jquery.0 Support Package 05. forums. is reflected in UIs for all the software components and also in the documentation. . Page 6 of 95 . SAP Gateway. all client implementations shall be validated against the Open Data Protocol Specification.org/license Includes Sizzle.0 SPS 11 This part of the SAP Gateway Library gives you an overview of what is new in SAP Gateway 2. Therefore.com/ Copyright 2011. Recommendation We strongly recommend using the OData Channel (ODC) programming paradigm for all SAP Gateway development. such as community discussions. This new name.6. see /IWBEP/IF_MGW_CONV_SRV_RUNTIME. see OData Vocabulary Annotations APIs. see method BIND_DATA_ELEMENT_FOR_TEXT of interface /IWBEP/IF_MGW_ODATA_PROPERTY. For more information. see Service Context Facade. Application Log Service IDs are exposed in the Application Log protocol. that is. For more information. For more information. $expand An API extension is provided to support $expand with $select query. For more information. All rights reserved. see System Query Option APIs. Metadata Texts You can bind data elements for text reference usage in properties. see Metadata Filtering Value List. see Catalog Service. 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. $filter on Navigation $filter is supported on navigation properties. For more information. see Defining Parallelization of Batch Queries. Message Text Enhancements Message target enhancements are provided with regard to the path relatively to the resource path in the URL. For more information. Vocabulary-Based Annotations It is possible to define vocabulary-based annotations in a way that simple values of type STRING can be language-dependent. 1. For more information. Support of Conditional Expressions In the SAP Gateway annotation APIs conditional expressions are supported. see Application Log Viewer. Page 7 of 95 . Service-Based Batch Parallelization You can deactivate the parallelization of batch queries on service level. see /IWBEP/IF_MGW_ODATA_EXPAND. Metadata Filter Value List You can use filter options for value lists. see Vocabulary-Based Annotations. For more information. For more information. the documentation for SAP Gateway also includes the following guides: PUBLIC © 2014 SAP SE or an SAP affiliate company.Service Context Facade For application development and monitoring the framework offers a service context façade. have different values depending on the language defined in the client’s request.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. For more information. For more information. Routing A mapping of system ID to system alias via the HTTP response header is provided. and the ability to link data entities within an OData service (via “…related…” links) and beyond (via media link entries). SAP Gateway enables SAP applications to share data with a wide range of devices. Simple interfaces also help to shorten development times. For more information about the deployment options and available software components. PUT. they must be trimmed down to manageable chunks. Dynamic binding takes place at runtime. you know where to PUT it. OData provides all of the above as well as additional features. DELETE. groupware. For its consumption outside of SAP. 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. thereby removing deployment barriers. Atom Publishing Protocol (AtomPub). Note While SAP Gateway uses OData. you can install SAP in either an SAP Business Suite backend system (embedded deployment) or in an SAP Gateway hub system (central hub deployment). extensible. you can use your browser to see what data you will get. and provides consumers with a predictable interface for querying a variety of data sources. What Is OData and Why Do we Use It? OData is a Web protocol for querying and updating data. Use stateless applications Receive related pieces of information. no knowledge of SAP structures is required and it supports object navigation. It is a framework that connects business users to SAP systems using consumer technologies. see SAP Gateway and OData. and platforms in a way that is easy to understand and consume. Depending on your development requirements and where you want to develop SAP Gateway content. This restriction applies to all OData versions.2. It is easy to understand and extensible. 1. OData for SAP comprises OData plus SAP annotations. OData for SAP For more information about OData. However. More Information For more information see OData Channel. and QUERY.odata. and allows anything textual in its content.SAP SAP SAP SAP SAP SAP Gateway Gateway Gateway Gateway Gateway Gateway Installation Guide Configuration Guide Technical Operations Guide Security Guide Developer Guide Content Guide (including Workflow) 1. If you know where to GET data. see Deployment Options.2. Using REST services provides the following advantages: Obtain human readable results. and you can use the same format. This facilitates support PUBLIC © 2014 SAP SE or an SAP affiliate company. AtomPub is the standard for treating groups of similar information snippets as it is simple. and the result set must be stepped through page by page. the OData implementation in place is not a full implementation according to the official OData specification at www. Page 8 of 95 . applying and building on Web technologies such as HTTP. such as feed customization that allows mapping part of the structured content into the standard Atom elements. one leading to another. All rights reserved. technologies. and RSS (Really Simple Syndication) to provide access to information from a variety of applications. As these snippets can come in large quantities. It aims to reduce the complexity and the skill set required to access SAP data. SAP Gateway uses OData protocol. OData can be easily consumed by various platforms and it offers flexibility (filtering. sorted according to ad-hoc user preferences. query options). OData is based on industry standards and offers database-like access to business data using REST-based architecture. POST. 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. there is also a requirement to express what structure to expect in a certain kind of information snippet. Use standard GET.org .2 SAP Gateway and OData By exposing SAP Business Suite functionality as REST-based OData (Open Data Protocol) services.1 General Overview SAP Gateway facilitates easier provisioning and consumption of business logic and content of SAP backend systems for mobile and Web applications. as so much textual enterprise data is structured. simply paging through data. Note While SAP Gateway uses OData. Page 9 of 95 . which is organized around projects. which are required for applications running on mobile devices to provide seamless integration into contacts. All rights reserved. Since projects consolidate all related data. This restriction applies to all OData versions. per collection as well as on the top level. which contains SAP-specific metadata that helps the developer to consume SAP business data. PUBLIC © 2014 SAP SE or an SAP affiliate company. and OpenSearch can be integrated into AtomPub service documents via links with rel=”search”. If your system is based on SAP NetWeaver 7. you must install the Add-On IW_BEP. a part of a name or address. 1. The following are examples of OData for SAP applications: Human-readable. developers can easily work on multiple projects in parallel and reuse data between projects before generating and activating the actual service. like the underlying AtomPub. you can install this Add-On either in an SAP Gateway system or in an SAP Business Suite system. Data Model Definition 2. within collections of similar entities. and for collections it simply points to the OData entity set.of a wide range of clients with different capabilities: Purely Atom. Not all entities and entity sets will support the full spectrum of possible interactions defined by the uniform interface. navigating through the data web. The metadata document will tell whether an entity set is searchable. The Service Builder succinctly blends new and existing ABAP development tools in an OData-compliant modeling transaction. The chosen action eventually results in changes to this entity. For more information. OpenSearch can use the Atom Syndication Format for its search results. The Service Builder supports the following development phases for OData services: 1. 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). and then you have to choose what to do. language-dependent labels for all properties (required for building user interfaces).odata.4 SAP Gateway Service Builder The Service Builder (transaction SEGW) provides an easy-to-use set of tools for creating OData services. which provides a toolset for creating services easily and efficiently and it supports the entire service development lifecycle. both mobile and browser-based. Project-Based Service Development The Service Builder introduces a new service development concept. Most of the applications for “light-weight consumption” follow an interaction pattern called “view-inspect-act”. so capability discovery will help clients avoiding requests that the server cannot fulfill. which properties may be used in filter expressions. The Service Builder not only enables you to define data models. tailoring the OData services to their needs. The Service Builder is a dedicated design-time transaction. and across collections using OpenSearch. The OpenSearch description specifies the URL template to use for searching.2. and which properties of an entity will always be managed by the server. Hypermedia-driven. see SAP Gateway Developer Guide. Semantic annotations. OData is also extensible. 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. using a custom query option with the name of “search”. Projects are used to store the artifacts developers need to create a service and a data model together in one place. so the OData entities that are returned by the search fit in. 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. the OData implementation in place is not a full implementation according to the official OData specification at www. and thereby allows the addition of features that are required when building easy-to-use applications.3 Development Overview The creation of data models is an integral part of the development process for SAP Gateway. but it may be tricky to express it in terms of an Update operation. Depending on your system landscape.40 or higher. or something related to a calendar event. meaning that you somehow navigate (or are led) to an entity that interests you. or “explore & act”. OData for SAP Products SAP Gateway uses OData for SAP Products. Aware of query options. calendar. or entities related to it. It supports developers throughout the entire development and modeling process. see SAP Gateway Service Builder. Service Implementation 3. For more information. Free-text search. You can create. see Deployment Options.2. Service Maintenance More Information For more information about the new Service Builder. 1. Prerequisites To use SAP Gateway Service Builder. The client needs to know which OData properties contain a phone number. but rather create and maintain complete OData services for SAP Gateway. such as descriptions of fields that can be retrieved from the SAP ABAP Dictionary.org . and telephony. “alert-analyze-act”. As of SAP NetWeaver 7. 7. Lower total cost of ownership as there is one less system to maintain. For information about how to choose the most suitable deployment option for your system landscape.00. You can connect multiple consumer technologies to one SAP Gateway instance. separate SAP Gateway system required. Page 10 of 95 . IW_BEP. All rights reserved.02. see SAP Gateway Service Builder. In addition. Embedded or Central Hub Deployment? You can install SAP Gateway independent of consumer technologies.01. Central management of routing and connectivity with SAP Business Suite backend systems. see Installing SAP Gateway Components and the SAP Note 1569624 All SAP Gateway 2. However. Central SAP Gateway content is not available. 1.02. Independent innovation speed of SAP Gateway and the connected SAP Business Suite backend systems. and not a dedicated SAP Gateway central hub system.40 and higher. Getting Started with the Service Builder. Cross-system composition is not advisable. the core software component for SAP Gateway is SAP_GWFND. and IW_HDB. GW_CORE. Core Components for SAP Gateway PUBLIC © 2014 SAP SE or an SAP affiliate company. different deployment options are available for SAP Gateway. and 7. note the following considerations: The innovation speed of SAP Gateway and the SAP Business Suite backend system need to be synchronized. and 7. SAP Gateway capabilities need to be deployed only once within the landscape. As of SAP NetWeaver 7.More Information For more information about the Service Builder.31 you can install the component IW_BEP either in this hub system and/or in the backend system.0 components are non-modifying components. No content merge for different applications required. Better security. For SAP NetWeaver 7. IW_BEP. Decoupled lifecycle of consumer applications from the SAP Business Suite backend system. For detailed information about the end-to-end service development process. the core component SAP_GWFND is installed as standard and includes the functional scope of IW_BEP. either behind or in front of the firewall. see the Service Builder cookbook. see Embedded Versus Hub Deployment.03. However. you can install the optional components for central hub deployment in your standalone system. which contains the composite functional scope of IW_FND. Dedicated SAP Gateway content is available. see SAP Note 1569624 . Central Hub Deployment Central hub deployment of SAP Gateway has the following advantages: Routing and composition of multiple systems is supported. Embedded deployment of SAP Gateway core components IW_FND and GW_CORE in an SAP Business Suite backend system. A separate SAP Gateway system can be implemented in a demilitarized zone (DMZ) for external access. 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.40. Embedded deployment: The core components for SAP Gateway and any optional backend components are deployed together in the SAP Business Suite backend system. Less runtime overhead as one remote call is reduced.40 and higher.03. Content can be deployed without touching the SAP Business Suite backend system. the core software component for SAP Gateway is SAP_GWFND. you need a backend system only. No additional. For SAP NetWeaver 7. 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.40. and IW_HDB.31 you can install the component IW_BEP in each backend system. Devices need to be integrated with the SAP Business Suite backend system on a point-to-point basis. 7. 7. For this deployment option. For SAP NetWeaver 7.7.5 Deployment Options Depending on your preferred system landscape. however the software components installed for the consumer technologies must also be installed on one SAP Gateway server. . Content specific to SAP Business Suite is used in SAP Business Suite system. note the following considerations: There will be redundant deployment of metadata or ABAP Dictionary structures. For more information. 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.2. Deployment options: Central hub deployment: The SAP Gateway core components can be deployed in a standalone system. For more information about the SAP Gateway components. which contains the composite functional scope of IW_FND. For SAP NetWeaver 7. GW_CORE. IW_BEP. see SAP_GWFND. namely IW_FND. All rights reserved. Note If your system is based on SAP NetWeaver 7. including. PUBLIC © 2014 SAP SE or an SAP affiliate company. you do not need to install it explicitly or the components it comprises. GW_CORE ABAP 200 Contains OData libraries.The mandatory core components for SAP Gateway are listed in the following table.40 or higher. together with a short description of each component.40 delivery. Optional Components for Central Hub Deployment The following optional components are available: Name Type Version Notes IW_BEP ABAP 200 Business Enablement Provisioning component.40 or higher. SAP_GWFND ABAP 740 Available as standard in systems based on SAP NetWeaver 7. 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. Note For SAP NetWeaver 7. Note If you have previously created services for the Generic Channel that are still in use. Note For more information about release dependencies. such as monitoring Note For SAP NetWeaver 7.40 or higher. You can install these components in an SAP Business Suite backend system (embedded deployment) or in an SAP Gateway hub system (central hub deployment). you must install the component IW_FNDGC 100 in systems based on SAP NetWeaver 7. IW_CNT ABAP 200 Contains well-defined content. GW_CORE. 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.40 or higher. Since this core component is included as standard in the 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. Page 11 of 95 . such as SAP Gateway enablement of SAP NetWeaver Business Workflow.40 delivery. see Installing SAP Gateway Components. Name Type Version Notes IW_FND ABAP 250 Contains core functionality of SAP Gateway as follows: Runtime components Metadata store Shared services. see SAP_GWFND. IW_HDB. You only need to install this component if you have existing Generic Channel services. 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. which is available as standard in the SAP NetWeaver 7. and 7.40 or higher.02. 7. IW_HDB ABAP 100 Provides business content adapter for SAP Gateway with SAP HANA that enables OData exposure of SAP HANA views. and 7.40 and higher.31. 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. you can install this component in an SAP Gateway system together with IW_BEP. 7.02.IW_CBS applications are similar to IW_CNT applications. and 7.40 and higher. For SAP NetWeaver 7. you can install this component in an SAP Business Suite system together with IW_BEP. For SAP NetWeaver 7. the core component SAP_GWFND in installed as standard and includes the functional scope of IW_BEP. IW_GIL ABAP 100 Provides a generic OData adapter for content based on the Generic Interaction Layer (GenIL).03. All rights reserved. For SAP NetWeaver 7. IW_SPI ABAP 100 Provides a generic OData adapter for content based on the Service Provider Infrastructure (SPI).01.03.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.02. 7. 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. and 7.03.40 or higher. For SAP NetWeaver 7. For SAP NetWeaver 7.40 and higher.40 and higher. For SAP NetWeaver 7. 7. 7. 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.02. the core component SAP_GWFND in installed as standard and includes the functional scope of IW_BEP. For SAP NetWeaver 7.31. For SAP NetWeaver 7. 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. Consequently you can install component PUBLIC © 2014 SAP SE or an SAP affiliate company. 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. 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.40 and higher. Page 12 of 95 .31. 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.03. the core component SAP_GWFND in installed as standard and includes the functional scope of IW_BEP. the core software component for SAP Gateway is SAP_GWFND. GW_CORE. and 7. the core component SAP_GWFND is in installed as standard and includes the functional scope of IW_BEP. which contains the composite functional scope of IW_FND. 7.com/wiki/display/SLGB/Landscape+Recommendations .03. These deployment scenarios have been conceived to provide you with the flexibility to decide which deployment option best meets your individual requirements.02. IW_BEP. For SAP NetWeaver 7.03.01.0.0. GW_CORE. 7. 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. 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. 1.IW_GIL in an SAP Business Suite backend system provided it is based on SAP NetWeaver 7. IW_SPI ABAP 100 Provides a generic OData adapter for content based on the Service Provider Infrastructure (SPI). 7. 7.40 or higher.01. 7. IW_BEP. As of SAP NetWeaver 7.40 and higher.40 or higher.03.31 PUBLIC © 2014 SAP SE or an SAP affiliate company. More Information For more information about landscape recommendations. Scenario A: Central Hub Deployment — Development in SAP Business Suite Backend System SAP NetWeaver Release Software Components Installed in SAP Gateway Hub System SAP NetWeaver 7. For SAP NetWeaver 7. As of SAP NetWeaver 7. which contains the composite functional scope of IW_FND.01. Considerations for SAP NetWeaver Releases 7.00. and IW_HDB.sap. 7. For SAP NetWeaver 7. IW_FND X GW_CORE X 7.40 and higher SAP_GWFND Installed in SAP Business Suite Backend System (X — available as standard as part of X SAP NetWeaver 7. and 7.40 or higher.31 X IW_BEP SAP NetWeaver 7.40 and higher) 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. Development System — Deployment Scenarios To help you decide whether embedded or central hub deployment is the most suitable for you.40. and 7.40. 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. 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. 7. you can install this component in either an SAP Business Suite system or an SAP Gateway system together with IW_BEP.03. For SAP NetWeaver 7. you can install this component in either an SAP Business Suite system or an SAP Gateway system together with IW_BEP.02.sdn.02.40 and higher. see the following three deployment scenarios. Page 13 of 95 . and IW_HDB.2. the core component SAP_GWFND is in installed as standard and includes the functional scope of IW_BEP.02. 7.31. see the following presentation on SAP Community Network: https://wiki.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.31. 7. 7. Central hub deployment of core software components IW_FND and GW_CORE in an SAP Gateway hub system. the core software component for SAP Gateway is SAP_GWFND. All rights reserved. 0. Scenario B: Central Hub Deployment — Development in SAP Gateway System SAP NetWeaver Release Software Components Installed in SAP Gateway Hub System SAP NetWeaver 7. 1.0. see Deployment Options. Depending on the setup of the backend system. Reduced total cost of ownership (TCO) as you do not require a separate SAP Gateway system.00 Support Package 18. The life cycle of SAP Gateway content is loosely coupled to the lifecycle of the SAP Business Suite backend system. 7. Minimum requirement for installation in the backend system is SAP NetWeaver 7. To enable communication between the SAP Gateway system and the SAP Business Suite backend system. Considerations The SAP Gateway content implementation cannot use the majority of development objects in the SAP Business Suite backend system.03. Scenario C: Embedded Deployment — Development in SAP Business Suite Backend System SAP NetWeaver Release Software Components SAP NetWeaver 7. For more information about embedded deployment and central hub deployment. If you want to use the Screen Scraping generator. Consequently. you must install IW_BEP in the backend system. If you want to use the Screen Scraping generator. 7. You need only a single installation of the SAP Gateway Add-Ons within the system landscape. You might not be able to install Add-Ons in the backend system for reasons of security. Considerations: The life cycle of SAP Gateway content is dictated by the frequency of updates in the SAP Business Suite backend system.00 Support Package 18. annotation Metadata attached to a consumption model element. You can reuse structures from the backend system and access local business logic.40 and higher (X — available as standard as part of SAP NetWeaver 7. Backend-specific content is used in the SAP Business Suite backend system. 7. Minimum requirement for installation in the backend system is SAP NetWeaver 7. 7.02. To enable external access and fulfill security requirements.2. The life cycle of SAP Gateway content is dictated by the frequency of updates in the SAP Business Suite backend system.02. 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.31 IW_FND X GW_CORE X IW_BEP X SAP_GWFND X Installed in SAP Business Suite Backend System You can combine this deployment scenario with an installation of IW_BEP in the backend system. you need to create copies of structures and data domains.31 IW_FND X GW_CORE X IW_BEP X SAP_GWFND X SAP NetWeaver 7. this might not be permitted. Cross-system composition is not advisable. you must install the Add-On IW_SCS in the SAP Business Suite backend system. 7.00 Support Package 18.01. or incompatibility (due to system release). 7. Considerations for SAP NetWeaver Release 7. PUBLIC © 2014 SAP SE or an SAP affiliate company. You must integrate the consuming application or infrastructure with the SAP Business Suite system on a point-by-point basis. 7.01. The life cycle of SAP Gateway content is dictated by the frequency of updates in the SAP Business Suite backend system. stability. For more information about release dependencies. for example. see Installing SAP Gateway Components. you can locate the SAP Gateway system in a demilitarized zone (DMZ).7 Glossary action Prepackaged business logic attached to an entity type.40 As of SAP NetWeaver 7. If you want to use the Screen Scraping generator. SAP NetWeaver 7. 7. Page 14 of 95 . Central SAP Gateway content is not available. you must install the Add-On IW_SCS in the SAP Business Suite backend system. You must choose this deployment scenario if you cannot install the SAP Gateway Add-Ons in the SAP Business Suite backend system.Minimum requirement for installing the Add-On IW_BEP in the SAP Business Suite backend system is SAP NetWeaver 7.40 and higher) Advantages: Noninvasive deployment scenario for SAP Business Suite backend system.40. component SAP_GWFND is already installed as part of the standard SAP NetWeaver delivery.40 and higher Installed in SAP Gateway Hub System Installed in SAP Business Suite Backend System Advantages: Easy reuse of content in SAP Business Suite backend system. you must install the Add-On IW_SCS in the SAP Business Suite backend system.03. All rights reserved. data provider class (DPC) Provides all application data of a service to the runtime. Business Object Repository (BOR). entity data model (EDM) Set of concepts that describe the structure of data regardless of its stored form. consumption model Represents an OData service by bundling a set of SAP Gateway data models for a specific consumption use-case. and forms the operational unit of consistency. customers is a set of customer entity type instances) entity type (synonym: EntityType) OData-specific. with a BOP data object (BOP DO) class for each BOP. entity set (synonym: EntitySet) Entities are grouped in entity sets (for example. function import (synonym: FunctionImport) Describes a service operation in an entity data model. Remote Function Call (RFC). The recommended programming paradigm for SAP Gateway is OData Channel. Exposed as service document plus service metadata document in the OData world. SAP Gateway converts these events in OData for SAP application notifications. collection Resource that contains a set of entries. There are three different content generators. content generator SAP Gateway design-time tool that enables a developer to create content quickly without having to write source code. backend system SAP Business Suite backend system. The nodes of this hierarchy are called entity types. 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. central hub deployment Deployment of core software components IW_FND and GW_CORE on the SAP Gateway central hub system. complex type (synonym: ComplexType) Structured types consisting of a list of properties but with no key. Infrastructure components that enable SAP Gateway content to abstract data from the exposed protocol and the business application implementation. and Screen Scraping (SCS). independent existence. event provider Application-specific component that provides business events. Can only exist as a property of a containing entity or as a temporary value. embedded deployment Deployment of core software components IW_FND and GW_CORE on the SAP Business Suite backend system.Backend Operation Proxy (BOP) Encapsulates a single RFC call or a Web service operation call and consists of two or more classes. All rights reserved. Each data model will be reflected by one or more corresponding entity types or collections in the resulting service. data model Root entity representing a certain self-contained business object that defines a people-centric view on respective business information. The content is then available for use through SAP Gateway. An entity is an instance of an <EntityType>. Generic Channel Programming paradigm for SAP Gateway. which are structured according to the entity type definition in the respective data model. PUBLIC © 2014 SAP SE or an SAP affiliate company. It has a unique identity. An <EntityType> has a name. Page 15 of 95 . you can install the software component IW_BEP on either an SAP Business Suite backend system or on the SAP Gateway system. It applies and builds upon Web technologies such as HTTP. property An <EntityType> can have one or more properties of the specified EDMSimpleType or ComplexType. navigation property (synonym: NavigationProperty) Property of an entry that represents a link from this entry to one or more related entries. PUBLIC © 2014 SAP SE or an SAP affiliate company. and where. thereby enabling a service to be made available for more than one system. OData Services Consumption and Integration (OSCI) Enables quick consumption of external OData services and converts them to SAP Gateway compliant OData services. plus a set of extensions to OData that simplify the consumption of OData services. OData Channel (ODC) Programming paradigm for SAP Gateway to expose backend functionality. metadata document Complete XML representation of an Entity Data Model (1:1 relation). project Used in SAP Gateway Service Builder to consolidate and store all artifacts needed to create a service and model in one place. The declared properties of an <EntityType> of <ComplexType> are defined using the <Property> element. for example <atom:id>. and JSON to provide access to information from a variety of applications. A navigation property is not a structural part of the entry to which it belongs.hub system SAP Gateway system. OData for SAP Products OData for SAP Products is a set of rules describing how to apply OData in consumption scenarios. To use the OData Channel. model provider class (MPC) Provides all metadata of a service to the runtime. without being bound to runtime artifacts and without risk of losing data. when you want it. Screen Scraping Generator for transforming ABAP dynpro screens into SAP Gateway services. Page 16 of 95 . SAP Gateway SAP Gateway enables people-centric applications to consume SAP Business Suite data through popular devices and platforms in an easy and standardsbased fashion. Open Data Protocol (OData) The Open Data Protocol (OData) is a Web protocol for querying and updating data. Projects provide developers with the freedom to interrupt the service development and modeling process at any time. All rights reserved. OData service Develop OData services in the Service Builder to extract the data you want. You are no longer recommended to use SAP Gateway ODC (using the core software component IW_FND). self link In an OData entity or a feed a self link is a link to the entity or the feed itself. multiple origin composition (MOC) Collection of data from different backend systems that is aggregated in a single service. Atom Publishing Protocol (AtomPub). A property can be a declared property or a dynamic property. service document Top-level XML representation of a consumption model (1:1 relation). service call Request sent to the OData service root URI or a resource path extending it. It has a dedicated ICF node and contains one or more data models. 1. A document that describes the location and capabilities of one or more entity sets. Page 17 of 95 . thing Tangible work object from a user perspective.3.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. It blends new and existing ABAP development tools in an OData-compliant modeling transaction and caters for the needs of all developers. see Deployment Options. which provides a toolset for creating OData services easily and efficiently and supports the entire service development life cycle. thing type Entity that defines tangible work objects.sap. 2 GHz or higher Random Access Memory (RAM) 8 GB or higher Hard Disk Capacity 80 GB primary.com/swdc . It contains a list of entity sets. 1.1 Installation Prerequisites Hardware The minimum hardware requirements for SAP Gateway are as follows: Requirements Specification Processor Dual Core (2 logical CPUs) or higher. 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. see the Product Availability Matrix (PAM) under http://service.service Exposed as an OData service to be consumed by an external application (such as JavaScript-based client). PUBLIC © 2014 SAP SE or an SAP affiliate company. Is a repository object used for routing (system aliases are assigned to a service) and authorization checks. see Software Maintenance. 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. Service Builder Is a dedicated design-time transaction. For information about the software maintenance tools and processes. For information about product availability. The software packages are available on your DVD and on http://service. regardless of experience and time available for service development.com/pam . All rights reserved. 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. a number of installation and configuration steps need to be performed. A prominent entity type fulfilling additional constraints.sap. To ensure that SAP Gateway functions smoothly in an ABAP environment. 40 SPS01 SAP WEB UIF Core Component Version SAP WEB UIF 7.com/notes .0 SP03 IW_GIL SAP WEB UIF 7.02 SPS09 SAP NetWeaver 7.03 SPS01 SAP NetWeaver 7.0 .31 SP00 Optional Core Component SAP WEB UIF 7. the documentation. and to the Product Availability Matrix (PAM). GW_CORE.40 SPS01 Content Components SAP NetWeaver 7.47 SP01 SAP Backend SAP Business Suite system More Information For information about the product availability matrix for SAP Gateway.02 SPS07 SAP NetWeaver 7. see http://service.01 SP01 IW_FND 250 SAP WEB UIF 7.0 SPS02 Content Adapter Component SAP NetWeaver 7.03 SPS01 SAP NetWeaver 7.01 SPS03 IW_GIL SAP NetWeaver 7.31 SPS01 Content Adapter Components IW_PGW SAP NetWeaver 7.03 SPS01 SAP NetWeaver 7.31 SPS01 SAP NetWeaver 7.02 SPS06 Screen Scraping Component IW_SCS SAP NetWeaver 7. The following provides you with an overview of the SAP Gateway components available.03 SPS01 SAP NetWeaver 7.01 SPS10 SAP NetWeaver 7.46 SP00 SAP WEB UIF 7.sap. You can find these SAP Notes at: http://service. Page 18 of 95 .31 SP00 SAP WEB UIF 7.01 SPS03 SAP NetWeaver 7.31 SPS01 Minimal requirement of HANA database version: SAP HANA 1.31 SPS01 SAP NetWeaver 7.0 components are non-modifying components.03 SPS01 SAP NetWeaver 7. Here you can find links to Installation and Upgrade (choose Downloads ).01 SP00 SAP WEB UIF 7.sap. IW_BEP. ensure you read and implement the latest version of the SAP Notes that apply to the software requirements listed above.02 SPS06 IW_SPI SAP NetWeaver 7.01 SPS03 SAP NetWeaver 7.02 SPS06 SAP NetWeaver 7.40 SPS01 Content Adapter Component SAP NetWeaver 7. All SAP Gateway 2.Core Components SAP NetWeaver 7.0 SPS18 SAP NetWeaver 7. Consider the security issues described in SAP Gateway Security Guide.31 SPS01 Core Component SAP NetWeaver 7.3. and IW_HDB. On the SAP Service Marketplace you will find the SAP Gateway download package in the SAP Software Download Center: Go to http://service.47 SP01 Content Adapter Component SAP WEB UIF 7.02 SPS07 IW_CNT and IW_CBS SAP NetWeaver 7.0 . .40 SPS01 Content Adapter Component IW_HDB SAP NetWeaver 7. Business Enablement Provisioning Component IW_BEP SAP NetWeaver 7.02 SPS06 SAP NetWeaver 7.com/swdc and navigate to Installations and Upgrades Browse our Download Catalog SAP NetWeaver and complementary products SAP Gateway SAP Gateway 2. 1.sap.0 SPS18 SAP NetWeaver 7.com/pam and search for SAP Gateway 2.03 SPS01 SAP NetWeaver 7.46 SP00 IW_FNDGC (for Generic Channel) SAP WEB UIF 7. see SAP Note 1569624 PUBLIC © 2014 SAP SE or an SAP affiliate company.40 SPS01 SAP Gateway Foundation SAP_GWFND Note Comprises functional scope of components IW_FND. You must install the core components.0 SPS25 GW_CORE and IW_FND SAP NetWeaver 7. All rights reserved.2 Installing SAP Gateway Components Install the SAP Gateway components using the SAP Add-On Installation Tool (SAINT).31 SPS01 SAP NetWeaver 7.03 SPS01 SAP NetWeaver 7. In addition. which lets you import the SAP Gateway installation packages from your DVD or the SAP Service Marketplace into your SAP system landscape.31 SPS01 SAP NetWeaver 7. For more information. you must install the software component IW_FNDGC 100. you do not need to install this component since the functional scope is included in the core component SAP_GWFND 740. Import the installation packages. see Deployment Options For more information about the system prerequisites for these core components see. IW_PGW 100. For more information about SAINT. other vendors. IW_GIL 100 Provides a generic OData adapter for content based on the Generic Interaction Layer (GenIL). For an overview of software components and where to deploy them.40 installation and you have previously created services for the Generic Channel that are still in use. and IW_HDB 100. To install the SAP Gateway components: 1. 2. and IW_GIL 100 are dependent on an installation of IW_BEP 200. optional. Next. These installation packages have a compressed format. 7. IW_SPI 100.40 and higher. see Installing and Upgrading Add-ons. and IW_GIL 100 are dependent on an installation of SAP_GWFND 740.03. Content Components Content is provided in predefined groups. Note For systems based on SAP NetWeaver 7. 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. Page 19 of 95 . so first unpack them into your local file system. which is available as standard.01. 7.31. see Loading Installation Packages from the Application Server. see SAP Note 1569624 and SAP Note 1707368 1.40 and higher SAP_GWFND 740: SAP Gateway Foundation 7.0 and 7. While this component is. you do not need to install IW_BEP 200 in systems based on SAP NetWeaver 7. Consequently. More Information For a detailed overview of the installation prerequisites that must be fulfilled for each of the components. All rights reserved.Core Components SAP NetWeaver 7. For more information about the systems in which you can install these core components. . and 7. For more information about the system prerequisites for the content adapter components see. the content components IW_CNT 200 and IW_CBS 200 are dependent on an installation of IW_FND 250. in theory. The sub components contained in this package are as follows: IW_CNT 200 IW_CBS 200 For SAP NetWeaver 7. account.31 IW_BEP 200 Enables OData Channel programming paradigm and is required for SAP Gateway Service Builder to build OData services.0. You only need to install this optional component if you have existing Generic Channel services. 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. and 7.3. Examples of such content are customer. the content components IW_CNT 200 and IW_CBS 200 are dependent on an installation of IW_FNDGC 100. For detailed information on importing the installation packages. and leave request grouped under CRM (Customer Relationship Management). For detailed information on unpacking the installation packages. 7.02.3 Unicode and Non-Unicode Support PUBLIC © 2014 SAP SE or an SAP affiliate company. Installation Prerequisites Business Enablement Provisioning Component SAP NetWeaver 7. you can use SAP Gateway without having to install any additional software components. For SAP NetWeaver 7. Consequently. if you have an SAP NetWeaver 7.02. Note If you have an SAP NetWeaver 7. For all SAP NetWeaver releases lower than SAP NetWeaver 7. IW_PGW 100. IW_SPI 100 Provides a generic OData adapter for content based on the Service Provider Infrastructure (SPI). Log on to the SAP system in which you want to install the SAP Gateway components and enter the transaction SAINT. For more information about installing SAP Gateway. Content Adapter Components IW_HDB 100 Provides business content adapter for SAP Gateway with SAP HANA that enables OData exposure of SAP HANA views.40 and higher SAP_GWFND 740: SAP Gateway Foundation 7.31 GW_CORE 200 IW_FND 250 SAP NetWeaver 7. Installation Prerequisites.40.40 and higher.40 higher and provides the core functional scope comprising IW_FND 250.03. 7.03. the content adapter components IW_SPI 100. IW_BEP 200. see Add-On Installation Tool.40 and higher. IW_PGW 100 Enables exposure for SAP NetWeaver Business Process Management (BPM) and Process Observer Task exposure for BPM and SAP NetWeaver Business Workflow. see Installation Prerequisites.40 as standard and it contains the full functional scope of IW_BEP 200. GW_CORE 200. 7. System integrators. For SAP NetWeaver 7. import them using the installation tool. see Deployment Options.02.40 This core component is available as standard in systems based on SAP NetWeaver 7. and 7. SAP NetWeaver 7.01 GW_CORE 190 IW_FND 240 SAP NetWeaver 7.40 This core component is included in SAP NetWeaver 7. the content adapter components IW_HDB 100. and other SAP development teams can also provide similar content.40 and higher.40 installation. see Deployment Options. In your backend system (IW_BEP) go to transaction SPRO. For more information. For all steps in the IMG there is always consumer-independent documentation available. you can choose between embedded deployment or central hub deployment.#. HTTP request/response payload) from a unicode system or unicode clients contains characters that are not in the system code page. General Configuration Settings (mandatory) 2. Additional Software Components Depending on the additional SAP Gateway components you implement. you must configure your system to allow the consumer servers’ applications to retrieve the data requested by users. 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. The origin of such data could. a property name) contains characters that are not in the system code-page. see Setting Up User and Administrator Authorizations. This does not necessarily result in an error. for example. select the Display icon before executing each step. Depending on whether you want to develop SAP Gateway content in an SAP Business Suite backend system or in an SAP Gateway hub system. For more information. This results in an error during the name validation in the OData library. open the SAP Reference IMG and navigate to: SAP NetWeaver SAP Gateway . a name of an artifact of the service’s EDM model. The same applies if you use SAP Gateway in SAP NetWeaver 7. Note If you have software components GW_CORE 190 and IW_FND 240 installed in your system. for example.40 (software component SAP_GWFND). open the SAP Reference IMG and navigate to: SAP NetWeaver SAP Gateway Service Enablement .3. OData Channel Configuration 3. several sections in the Implementation Guide (IMG) are merely available for reference and maintenance purposes. then the following applies: Such characters are converted into the hash character . you are strongly recommended to use the Service Builder (transaction SEGW) for your OData design-time development . For more information. If you want to see more information. In the backend system this is the section in the SAP Reference IMG under SAP NetWeaver SAP Gateway Service Enablement Generic Channel .4 SAP Gateway Configuration Guide Once you have installed the SAP Gateway components. PUBLIC © 2014 SAP SE or an SAP affiliate company. The origin of such EDM names could.1. 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 . The SAP Gateway Configuration Guide contains the steps for customizing settings for SAP Gateway and describes system configuration activities. Depending on the support package stack level at least the following SAP Notes have to be applied as well: 1994928 1995054 1995517 1.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. The sequence of mandatory and optional configuration tasks is as follows and depends on your use case. It is highly recommended that both the SAP Gateway as well as all connected backend systems are unicode systems. As of SAP Gateway 2. As such. the IMG tree will only offer the activities for OData Channel. be the Service Builder or OData services generated with SAP Gateway. In the SAP Gateway hub system these are the sections in the SAP Reference IMG under SAP NetWeaver SAP Gateway Former Development . Recommendation We strongly recommend using the OData Channel (ODC) programming paradigm for all SAP Gateway development.#. be applications on the basis of the UI development toolkit for HTML5 (SAPUI5) or external OData services in a client scenario. see Embedded Versus Hub Deployment and Deployment Options. see SAP Gateway Service Builder. 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. 1. For more information. The templates specify the authorizations for content that can be accessed by the users and activities for developers. The above listed issues can be overcome by exclusively using characters that are in the code-pages of all systems. Page 20 of 95 . for example.0 Support Package 05. All rights reserved. If the data (for example. 4. several settings are important for smooth operations: Profile Parameters ICF Services Initial Logon Language Settings 1.02 SPS09 comprising an ABAP Database Connectivity (ADBC) installation. Administrator credentials Login information of the administrator of the SAP SAP administrator NetWeaver AS ABAP to install and maintain the system HTTP/HTTPS ports HTTP and HTTPS port numbers of the central instance 80000 for HTTP and 80001 for HTTPS of the AS ABAP SAP system For each SAP system to which you want to connect the SAP Gateway server. ADBC is an object-based ABAP API for programming relational database accesses. such as Process Service and Process Context Service. 1.SAP Gateway with HANA (IW_HDB) If you want to install the SAP Gateway with HANA component (IW_HDB).1. you need to collect some information about the SAP Gateway host. the relevant IMG activities are available in the Implementation Guide in the backend system: In transaction SPRO open the SAP Reference IMG and navigate to: Service Enablement Business Process Enablement Content SAP NetWeaver Workflow Settings SAP Gateway . PUBLIC © 2014 SAP SE or an SAP affiliate company.1 General Configuration Settings After having installed the SAP Gateway software components you need to carry out several configuration steps.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. see Profile Parameters for Logon and Password (Login Parameters) and Changing and Switching Profile Parameters. this requires SAP NetWeaver 7.1. It follows the Java Database Connectivity (JDBC) diction in its class and model structure. After the installation you have to decide which services must be activated for the applications you want to use. More Information For information on profile parameters and profile parameter maintenance.4. Page 21 of 95 . Consumer Settings For information on configuration settings which need to be carried out for the different consumer scenarios and applications. Required Information Description Fully Qualified Domain Name (FQDN) Name of the SAP NetWeaver Application Server ABAP server. In transaction SPRO open the SAP Reference IMG and navigate to: Service Enablement Content SAP NetWeaver Business Process Enablement SAP Gateway . Workflow You can find more information about the Workflow-related configuration activities in Configuring Workflow for SAP Gateway. All rights reserved. Before starting with the configuration for SAP Gateway itself. the relevant IMG activities are available in the Implementation Guide in the backend system. system number Server name HTTP / HTTPS port Administrator credentials In addition. For the special services provided within Business Process Enablement. In addition.com Example (AS ABAP) system or the load balancing device.domain.4. see Configuration Settings for SAP Gateway Supported Scenarios.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. you need the following information: System ID. 1. In transaction SPRO. you have to activate the service tree default_host in transaction SICF.png. Note The standard mode is the default for all new applications. the generic player gets a service document which contains links to images which the player should display for a Sales Order. Do not use it for all requests except for those to get service document . Set parameter: Content-Type=application/xml XSRF Security Token Security Session Id $format parameter $format=xml leads to an error except for service document. If a service is inactive in transaction SICF. When creating a service a new node is created automatically. For example. if an entry with a null string is to be created set m:null="true". only permitting access to the ICF service for users with the appropriate authorizations.. PUBLIC © 2014 SAP SE or an SAP affiliate company. and besides that. Then you have to activate services sap. Since multiple services can be executed when you call a URL. The path in the Implementation Guide for SAP NetWeaver is: in Installation . When creating a service a new node is created automatically. For example. All rights reserved. The URL path is mapped in ICF subnodes (services). an error text appears when you try to access the service. choose Display SAP Reference IMG . This is the standard mode for all new applications. <name/>) are not allowed anymore.Caution Activated ICF services represent a security risk because they can be accessed directly by the HTTP protocol from the Internet. Page 22 of 95 . Using the context menu and choosing Activate Service . Nullable needs to be set properly. You can also activate services from the SAP Implementation Guide (IMG). then you also need to activate the following nodes on your target system: /sap/bc/srt/xip/sap /sap/bc/webdynpro/sap/saml2 /sap/public/bc /sap/public/bc/ur /sap/public/mysssocnt Note If the default_host node is inactive in transaction SICF. such as images in the MIME repository. http://. You therefore need to use suitable methods for restricting access. /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. Then the generic player downloads the image via URL from the MIME Repository.. public and icman separately. that is. You activate an ICF service as follows: 1. You can either activate only a selected service node ( Yes ). for example. Activate the ICF service in one of the following ways: Using menu option Service/Host Activate . if you want to activate the services for URL /sap/public/icman. Standard Mode This standard mode refers to the ICF node /sap/opu/odata. it is called Compatibility Mode for SP02 . for example. /sap/opu/odata with its sub-nodes. for example. If you use Web service based scenarios. all service nodes must be activated in the SICF tree. The request handler for this node is /IWFND/CL_SODATA_HTTP_HANDLER. if content is consumed which is provided via Web services. <name m:null="true" />. For SAP Gateway you need to activate the following services: /sap/public/opu Note that /sap/public/opu/resources is needed for loading resources. the HTTP requests could result in an ABAP runtime error RAISE_EXCEPTION with the following short text: Exception condition "HOST_INACTIVE" triggered. The following list consists of the differences of the standard mode as opposed to the compatibility mode for SP02: XSRF protection See also Cross-Site Request Forgery Protection Content-Type required for Put/Post request An unsupported media type error is thrown if Content-Type is not set for Put/Post requests./sap/opu/resources/pic1. Select the required ICF service in the ICF tree in transaction SICF. All new development will be done on this mode. Application Server Internet Communication Framework Activate HTTP Services or Activate Services Note that the system performs a check against the authorization object S_ICF_ADM when an ICF node is created. or the selected service node including all the subservices maintained for it in SICF ( Yes with tree icon). This node is available for OData Channel based applications. New functions and features will be available for this mode. Null values in Put/Post Request Empty property elements (for example. 2. datetime. for example for the initial logon sequence. More Information Administration of ICF server functions (authorization assignment): Server Function Administration Administration of ICF client functions (creation of RFC destinations. Values of keys in Post request in case of server generated keys If the keys are generated on the server the values need to be filled in the post request anyway. Service maintenance The service maintenance transaction distinguishes between services of the Standard Mode and of the Compatibility Mode for SP02 .org/developers/protocols/overview#AbstractTypeSystem .. String parameters Quotation marks enclosing string parameters (for example. This node is available for existing applications which might be based either on OData Channel or Generic Channel.0 SP02 refers to the ICF node /sap/opu/sdata. and so on): Client Function Administration ICF services: Creating and Configuring an ICF Service Authentication: Defining the Logon Procedure 1.org/developers/protocols/overview#AbstractTypeSystem . 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.3 Changing Password for Initial Logon Note This section is only relevant if you want to change the password for the initial logon procedure.1. Using an ICF Node for Changing Passwords SAP Gateway offers a special ICF node which can be accessed to change the password. OData error response The OData error response has been enhanced. Compatibility Mode for SP02 This compatibility mode for SAP Gateway 2.odata. The logon configurations for SAP Gateway are handled via the ICF layer.odata. element <app:workspace sap:semantics="things"> .4. Therefore. Rendering of key predicates See http://www. Alias Handling in ICF The ICF standard function of external aliases is also available for SAP Gateway for the Standard Mode . m:null is not allowed. $filter=name eq 'Jame''s shop' can now be properly escaped by an inverted comma.m:null="true" />. Thus you can define an external alias for your service if you have registered class /IWFND/CL_SODATA_HTTP_HANDLER as handler in the Handler List for your service node. Things The workspace for Things. SAP systems may require some additional (browser) features if the password needs to be changed because of being initial or outdated. The structured inner error section is available showing Extended Passport (EPP) transaction ID. that is. Parameters for function imports Parametrize with literals.. for example. For more information. The request handler for this node is /IWFND/CL_SDATA_ODATA_APP. Page 23 of 95 .Null values in the response of a Get/Put request Intial values for date time fields in combination with nullable properties are rendered as <. for example. is no longer available. see Defining the Logon Procedure. you can define the external alias.odata. PUBLIC © 2014 SAP SE or an SAP affiliate company. See http://www. All messages of the message container and the additionally provided error details are shown in a special format (micro format). Note Note that external aliases are not supported for namespaces in SICF. An additional ICF node is offered to allow the change of passwords with a browser.htm#_Toc246716641 . All rights reserved. If the handler /IWFND/CL_SODATA_HTTP_HANDLER is not yet registered for your service node.org/media/6655/%5Bmc-apdsu%5D%5B1%5D. Inverted commas in URI Inverted commas in URI. After the handler has been set. for ICF node /sap/opu/odata. See also http://www.. search string) are now required and removed. This node is used to change the password and to redirect to any other custom web page. Key properties Sending properties that are not key fields in an URI is not longer possible. the ICF nodes can be configured to permit the initial password change and the direct logon.. enter the handler name on tab Handler List and activate your service. Caution This node is in maintenance mode.. In the SAP Reference IMG navigate to SAP NetWeaver SAP Gateway Service Enablement Backend OData Channel . the SAP Gateway system supports only the intersecting set of the languages of the connected SAP Business Suite backend systems. If the URL is extended by ? redirectURL=/X then the browser is redirected to the URL wherever X points to. Do not use Save as Global Settings . so that the new password data could be used in the settings of a mobile application. 8. In the SAP Reference IMG navigate to SAP NetWeaver SAP Gateway OData Channel . Changing the Password for ICF Nodes Accessed by Mobile Devices 1.00 and 7. 2. SAP NetWeaver 7. Choose Define Service-Specific Settings . 7. be the root node which is accessed by your mobile devices and where you want to deny the direct access via mobile device. 4. This node shall 3. Caution If you have administrator rights you have the additional option to save your settings as global settings.02 and 7. PUBLIC © 2014 SAP SE or an SAP affiliate company. Choose System Logon . On tab Error Pages choose sub-tab Logon Errors . a redirect URL can be configured and will take precedence over all basic settings. 6.You can find this special ICF node in the service tree under /default_host/sap/opu/utils under the name initial_logon. Apart from basic configuration settings the OData Channel configuration activities for the SAP Business Suite backend system are listed in the Implementation Guide (IMG) in the backend system where software component IW_BEP is deployed. For more information see Determining the Logon Language. You can define your own logoff pages via Error Pages Logoff Page . Double-click on the node and change to edit mode. 1. 5. Activate your ICF node. 10. You can access this node as soon as it has been activated via the URL <host>:<port>/sap/opu/utils/initial_logon. In the SAP Reference IMG navigate to SAP NetWeaver SAP Gateway .31 The OData Channel configuration activities are listed in the Implementation Guide (IMG) in the system where software component IW_FND is deployed. More Information For more information on the generic system logon functionality in ICF.4 Language Settings The language which is displayed to the user depends on a variety of factors. As to languages. see System Logon. In transaction SICF choose Execute (F8) to display the service tree hierarchy.01 The OData Channel configuration settings are available in the Implementation Guide (IMG) in the system where software component IW_FND is deployed. SAP NetWeaver 7. 9. All rights reserved.1. A typical use case for such a redirect URL would be to display additional information.4. Logoff URL The Internet Communication Framework also offers a default logoff URL on each system. The call of the service requires authentication and does allow to change an initial password via a browser application. Page 24 of 95 . If needed. Under Logon Layout and Procedure choose Custom Implementation and enter ABAP Class /IWFND/CL_COC_SYSTEM_LOGIN. Choose Configuration .4. 1. Expand the default host and navigate to the ICF parent node of the initial logon /default_host/sap/opu/utils/initial_logon.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) may differ. Choose Input (Enter) to save your settings. 2.4. All rights reserved. Developer and Administrator Authorizations Connection Settings: SAP Gateway to SAP Systems Activating SAP Gateway Service Development in the Backend System Service Development in the SAP Gateway Hub System Connection Settings to SAP Gateway More Information Basic Configuration Settings OData Channel 1. Then you set up one or several user roles and assign users to it as well. As you cannot change existing SAP roles.40. Developer. IMG activities for SAP Gateway Foundation 7. The following templates are available for developers: Template Type Template Name Template for Framework /IWFND/RT_BOR_DEV SAP Gateway BOR Developer Framework /IWFND/RT_DEVELOPER SAP Gateway Developer PUBLIC © 2014 SAP SE or an SAP affiliate company. If the users you require exist in your SAP Business Suite backend system. SAP Gateway Developer Role Create a developer role based on the available templates for all users that are to carry out development tasks such as creating services. user.OData Channel IMG in IW BEP SAP NetWeaver 7.40 are available. Page 25 of 95 . SAP Gateway provides predefined roles as templates for: Developers Administrators End users of the different content scenarios These templates follow the naming convention /IWCNT/RT_USER_<application name>. Use the predefined templates to create administrator. and Administrator Roles After you have installed the SAP Gateway components you require. In the SAP Reference IMG navigate to SAP NetWeaver OData Channel IMG activities. The template names begin with a namespace ID that corresponds to the software components you use. and support roles for SAP Gateway components. so you must use the available role templates to create the users you require in the SAP Gateway system. you create your own roles or copy existing roles to your new custom roles. The SAP system includes templates as opposed to actual users. If this is not possible. you must create the users manually. SAP Gateway and SAP NetWeaver SAP Gateway Service Enablement . you can replicate these users in the SAP Gateway system by connecting the SAP Gateway system to Central User Administration or to SAP Identity Management and synchronize the users in this way. Use the developer role /IWBEP/RT_MGW_DSP for accessing a remote system from the Service Builder (transaction SEGW) at design time. There you find all the relevant Settings User.40 If you use software component SAP_GWFND in SAP NetWeaver 7. developer. Support colleagues These templates provide display authorizations only and are intended to be used by support colleagues who need to view applications logs.1 User. you need to set up an administrator role for SAP Gateway components and assign users to it. OData Channel /IWBEP/RT_MGW_DEV OData Channel Developer Screen Scraping /IWSCS/RT_SCR_DEV SAP Gateway Screen Scraping Developer For more information, see Assigning Authorization to Transaction and Search Help SAP Gateway Administrator Role Create 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 User Settings Define Role for SAP Gateway Administrator SAP NetWeaver SAP Gateway OData Channel Configuration and click on the Activity icon. The Role Maintenance page displays. To check that the role was properly created and assigned, log onto the SAP Gateway system as the user you just assigned. You should be able to access transaction SPRO and find the SAP Gateway Implementation Guide there. You can now log onto the SAP Gateway host as the administrator user you have just created to configure SAP Gateway components and content, and to install consumer applications. For more information about SAP user administrator types, see Setting Up User and Authorization Administrators. The following templates are available for administrators: Template Type Template Name Template for Framework /IWFND/RT_ADMIN SAP Gateway Framework Administrator Content Scenario /IWCNT/RT_ADMIN_REP SAP Gateway Reporting Management Administrator. See Settings for Reporting Management for details on authorizations required. OData Channel /IWBEP/RT_MGW_ADM OData Channel Administrator Business Enablement Provisioning (IW_BEP component) /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 Role Create a role for a user with permissions and privileges for user-specific tasks. Depending on your application, you can either specify different authorizations for different user roles or have all authorizations bundled together in one user role. Note You must be a SAP Gateway administrator or have a SAP user administrator to create user roles. In the SAP Reference Implementation Guide (IMG) (transaction SPRO), navigate to User Settings Define Role for SAP Gateway User SAP NetWeaver SAP Gateway OData Channel Configuration and click on the Activity icon. The Role Maintenance page displays. Proceed as described below. Once you have assigned users to the relevant roles, you can log on as one of these users and work as them. If you use Web service based scenarios, copy the SAP_BC_WEBSERVICE_CONSUMER role to a customer role for end users. Then assign this customer role to your end users. To do this, proceed as follows: 1. Click on the Activity icon of the IMG activity Define Role for SAP Gateway User mentioned above. The Role Maintenance page displays. 2. In the Role field, enter your customer role for Web services and choose Change . 3. On the User tab enter the names of the users to whom you want assign this role and save your settings. 4. Choose User Comparison . 5. Choose Complete Comparison . 6. Save your settings. To check that you have successfully assigned roles to users, take some of the users assigned to the different roles and make sure that you can log on successfully. If these steps have not been performed successfully, an HTTP request of an authenticated user returns an HTTP 500 error. The following templates are available for end users: Template Type Template Name Template for Framework /IWFND/RT_GW_USER 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 for details on authorizations required. Content Scenario /IWCNT/RT_USER_REP SAP Gateway Reporting Management User See Settings for Reporting Management for details on authorizations 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 for Content Scenario /IWCNT/RT_USER_WF SAP Gateway Workflow User Content Scenario /IWCNT/RT_USER_ACT SAP Gateway Activity Management User details on authorizations required. See Settings for Customer Relationship Management on SAP Gateway for details on authorizations required. Content Scenario /IWCNT/RT_USER_ACCNT SAP Gateway User for Account Management See Settings for Customer Relationship Management on SAP Gateway for details on authorizations required. Content Scenario /IWCNT/RT_USER_CONT SAP Gateway User for Contact Management See Settings for Customer Relationship Management on SAP Gateway for details on authorizations required. OData Channel /IWBEP/RT_MGW_USR OData Channel User OData Channel /IWHDB/RT_USER OData Channel HANA Integration User OData Channel /IWBEP/RT_SUB_USR On-behalf Subscription User Business Enablement Provisioning (IW_BEP component) /IWBEP/RT_BEP_USR Business Enablement Provisioning User Workflow /IWWRK/RT_WF_GW_USR SAP Gateway Workflow User Workflow /IWWRK/RT_WF_SUB_USR On-Behalf Subscription for SAP Gateway Workflow Task Gateway /IWPGW/RT_WF_USR SAP Gateway Task Gateway User Screen Scraping /IWSCS/RT_SCR_USR SAP Gateway Screen Scraping User Services For more information, see Assigning Authorization to Transaction and Search Help SAP Gateway Support User Role The following templates are available for support users (display authorization only). The support templates are available in the SAP Gateway hub system and the SAP Business Suite backend systems respectively. These templates contain read-only authorizations to access SLG1, the application log viewer and the corresponding log objects and sub-objects. Template Type Template Name Template for Support /IWFND/GW_SUPPORT_RO Read-only supportability role for SAP Gateway system Support /IWBEP/GW_SUPPORT_RO Read-only supportability role for SAP Business Suite backend system More Information Creating and Assigning Roles Roles in the SAP Gateway Landscape 1.4.2.1.1 Creating and Assigning Roles To create a role and assign it to users (user roles, administrator roles or developer roles), proceed as follows: 1. On the Role Maintenance page enter an existing SAP_BC* role : For an administrator role choose a listed standard administrator role, for example SAP_BC_BASIS_ADMIN, and for a user role, enter an existing generic user role, for example SAP_BC_ENDUSER. 2. Select Copy Role to create a copy of the standard role. 3. In the Query dialog box, enter a name for the new role and then select Copy all . The new role is created. 4. On the Role Maintenance page, select Change . 5. On the Authorizations tab select Change Authorization Data under the Maintain Authorization Data and Generate Profiles section. 6. Select Edit Insert authorization(s) From template... . The Choose Template page displays. 7. Select the appropriate template from the list (see User and Administrator Authorizations) and choose Continue (Enter) . 8. Choose Generate . 9. On the Generate Profile window choose Generate . 10. In the Assign Profile Name for Generated Authorization Profile dialog box, maintain the profile name according to your requirements and choose Execute (Enter) . 11. The Change role: Authorizations page displays, with the Status of the profile showing as generated . 12. Go back to the Change Roles page and select the User tab. 13. Under User Assignments enter the names of the users to whom you want to assign this role and save your settings. 14. Choose User Comparison . 15. Choose Complete Comparison . 16. Save your settings. PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved. Page 27 of 95 16. Save your settings. For more information about role maintenance, see Changing Standard Roles. 1.4.2.2 Connection Settings for SAP Gateway Hub System The connection settings you need to make in the SAP Gateway hub system are organized by those you need to make from the hub system to consumers and from the hub to other SAP systems. Connection Settings: SAP Gateway to Consumer Connection Settings: SAP Gateway to SAP Systems 1.4.2.2.1 Connection Settings: SAP Gateway to Consumers When using Push flow and also Web services, you have to specify settings from your SAP Gateway system to consumers. In the following sections only the basic configuration activities to set up the connection between the SAP Gateway host and the consumer system are listed. You can find the complete set of configuration activities in the SAP Gateway Configuration implementation guide (IMG) in the system. In transaction SPRO open the SAP Reference IMG and navigate to Gateway to Consumer . SAP NetWeaver SAP Gateway OData Channel Configuration Connection Settings SAP Creating a bgRFC Destination for Outbound Queues Registering the bgRFC Destination for the Outbound Queue Creating the bgRFC Supervisor Destination 1.4.2.2.1.1 Creating an RFC Destination for Outbound Queues You must create a Background Remote Function Call (bgRFC) destination for communications in an outbound queue or an inbound queue respectively. To create a bgRFC destination for the outbound queue, proceed as follows: 1. In transaction SPRO open the SAP Reference IMG and navigate to: Connection Settings SAP Gateway to Consumer 2. Choose Create . 3. In RFC Destination , enter IWFND_BGRFC_DEST . SAP NetWeaver SAP Gateway Create RFC Destination for Outbound Queues OData Channel Configuration and click on the Activity icon. 4. In Connection Type , enter 3 . 5. In Description 1 , enter RFC Destination for Outbound Queues . 6. 7. 8. 9. Choose Enter and then select the Special Options tab. In the Select Transfer Protocol section, select the option Classic with bgRFC from the list and save your settings. Accept the warning message with Yes . Choose Connection test . Information about the connection type displays. 1.4.2.2.1.2 Registering an RFC Destination for Outbound Queues Register the bgRFC destination for the outbound queue to handle communications efficiently. Proceed as follows: 1. In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver SAP Gateway Connection Settings SAP Gateway to Consumer Register RFC Destination for Outbound Queues 2. Select the Define Inbound Dest. tab. 3. Choose Create . 4. In the Inb. Dest. Name field, enter IWFND_BGRFC_DEST . OData Channel Configuration and click on the Activity icon. 5. Choose Enter and Save . 6. In the New Prefix field, enter IWFND_CNP for example and choose Create . Repeat the step using IWCNT_WF , for example. 7. Save your settings. 8. On the Scheduler: Destination tab choose Create . A message displays, asking if you want an outbound or inbound destination. 9. Choose Inbound . 10. In the Destination field, enter IWFND_BGRFC_DEST and choose Save . 11. Save your settings. 1.4.2.2.1.3 Creating a bgRFC Supervisor Destination The supervisor destination for bgRFC receives the configuration settings for the bgRFC scheduler and also starts or stops the schedulers as required. Note The bgRFC supervisor user you specify must have authorizations from authorization object S_RFC. These are defined in role SAP_BC_BGRFC_SUPERVISOR. To create the bgRFC supervisor destination, proceed as follows: 1. In transaction SPRO open the SAP Reference IMG and navigate to: Connection Settings SAP Gateway to Consumer SAP NetWeaver SAP Gateway Create bgRFC Supervisor Destination PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved. OData Channel Configuration and click on the Activity icon. Page 28 of 95 enter a user name. RFC destinations of type 3 are for connections to SAP ABAP systems. 4. In the Destination Name field.2. Save your settings. choose Connection Test . On the bgRFC Destination page. enter the (message) server name of the of the SAP system. open transaction SM59 and choose Create . enter 3 . Note This RFC destination is used to establish trust between the systems and is not used at runtime. Save your settings. 5. enter BGRFC_SUPERVISOR . 00 . 3. for example. In the User Name field. 4. In the Connection Type field. In the SAP business system. In the Connection Type field.2. 13. Create the RFC destination of type 3 as follows 1. If the user ID with which you are logged on to SAP Gateway and your user ID for the SAP system is the same.2. RFC Destination to SAP Gateway Server . Choose Save . Save your settings. On tab Technical Settings and Load Balancing select the relevant option according to your system’s settings. In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver SAP Gateway OData Channel Configuration Connection Settings SAP Gateway to SAP System Manage RFC Destinations and click on the Activity icon. for example. select Remote Logon . enter the RFC destination name in the following format: <system id >CLNT<Client>. 4. In transaction SPRO open the SAP Reference IMG and navigate to SAP NetWeaver SAP Gateway OData Channel Configuration Connection Settings SAP Gateway to SAP System .2. enter 3 .. 11. enter the (message) server name of the SAP Gateway system. select Save . 6.2. 3. and the SAP Gateway host to be the trusted system. 1. 8. 5. Note Ensure that you have previously created the trusted relationship. Activate Current User . For Trust Relationship activate Yes . Select Create User and choose Enter . To check that you have successfully created the type 3 connection.2. Select Generate Password and choose Save . enter the RFC destination name in the following format: <system id >CLNT<Client>. 10. On tab Define Supervisor Dest.2. 6. Choose Create . 8. 5. and this user ID has the object S_RFCACL assigned to it on the SAP system. Page 29 of 95 . proceed as follows: 1. In the following sections only the basic configuration activities are listed. PUBLIC © 2014 SAP SE or an SAP affiliate company. 9. On tab Logon & Security enter the SAP system’s client number. enter an explanatory text. as outlined in Defining Trust between the SAP Gateway Host and Your SAP System. In the Description 1 field. The connect test should pass. Creating an RFC Destination for SAP Gateway Hub to SAP System Defining Trust for SAP Systems Configuring SAP System to Accept Assertion Tickets from SAP Gateway Configuring SAP Gateway Host to Accept Assertion Tickets from SAP Systems Creating an SAP System Alias System ID in Origin Segment Parameter 1. 12. You can find the complete set of configuration activities in the SAP Gateway Configuration Implementation Guide (IMG) in the system. RFC Destination to SAP Server . On tab Technical Settings and Load Balancing select the relevant option according to your system’s settings.4.4. All rights reserved. To configure trust. If you have any problems. you need to create an RFC destination (type 3) from the SAP Gateway hub to the SAP Business Suite system. enter the SAP Gateway system number. BgRFC_user . In the System Number field.2 Defining Trust for SAP Systems You define the trust relationship between your SAP Business Suite system and the SAP Gateway system by configuring the SAP Business Suite system (backend system) to be the trusting system. In the RFC Destination field.2.4.1 Creating an RFC Destination for SAP Gateway Hub to SAP System For all scenarios. 7. 2. 7. enter an explanatory text. 1. choose Create . In the RFC Destination field. 3. In the Target Host field. for example. 7. You should not see any error messages in the status. check SAP Note 128447 for troubleshooting tips.2. In the Description 1 field. 6. In the Target Host field. 2. for example.2 Connection Settings: SAP Gateway to SAP Systems You must configure settings for SAP Gateway components and define how these settings interface with your existing SAP Business Suite system (backend system). Proceed as follows: 1. you must import them manually.2. 2. use STRUSTSSO2 to import the certificates from the SAP Gateway server. The wizard for creating trusting relationships displays. For further information. 1. Choose Activate (Enter Certificate in ACL and.2. Note If transaction SSO2 does not work. You may be asked to provide a user name and password. 9. see Using Transaction STRUSTSSO2 in SAP System >= 4. 4. Enter the Type 3 RFC destination created above (from your backend system) or the Host Name and Instance Number for the backend system in the appropriate fields.6C. Choose Execute .2. On the Logon page enter your password. 5. Enter the following details for the SAP system alias: Field SAP NetWeaver Manage SAP System Aliases SAP Gateway OData Channel Configuration and click on the Activity icon. The SSO administration report for the designated SAP system displays. An RFC logon to the SAP Gateway host takes place and the necessary information is exchanged between the systems. Note If transaction SSO2 does not work. 3. In your SAP Gateway system make sure that the profile parameters are set as outlined in Profile Parameters. In the RFC Destination field. In your backend system go to transaction SSO2 to run the SSO2 administration wizard. All rights reserved.8. Page 30 of 95 . 5. Note End users must have authorization object S_RFCACL assigned to them before they can use a trusted connection.5 Creating an SAP System Alias You need to specify where the SAP system alias should point to. Choose New Entries . 1. Choose Activate (Enter Certificate in ACL and. In transaction SPRO open the SAP Reference IMG and navigate to: Connection Settings SAP Gateway to SAP System 2. The system alias is the result of the routing for an inbound request on SAP Gateway. 13. 1. 00 . Log on to the SAP Gateway host using your administrator user and password.4 Configuring SAP Gateway Host to Accept Assertion Tickets from SAP Systems You must configure your SAP Gateway host to accept SAP assertion tickets from the SAP Business Suite (backend) system for message-based Web service communication.2.4. Save your settings. if Necessary. 2. enter the SAP Gateway system number. The trusted entry for the SAP Gateway host displays. In your SAP Gateway system go to transaction SSO2 to run the SSO2 administration wizard. if Necessary. 4. Depending on the SAP Gateway content scenario and your system landscape you thus set up the system alias. 12. To accept SAP assertion tickets. see RFC Trusted/Trusting Systems. 11. Description PUBLIC © 2014 SAP SE or an SAP affiliate company. enter the RFC destination you created. you must import them manually. 10.4.6C.3 Configuring SAP System to Accept Assertion Tickets from SAP Gateway You must configure your SAP Business Suite (backend) system to accept SAP assertion tickets from the SAP Gateway host for message-based Web service communication. For more information.2. Choose Execute . It can be a remote or a local system. 3. Enter the Type 3 RFC destination created above (for your SAP Gateway system) or the Host Name and Instance Number for the SAP Gateway system in the appropriate fields. Proceed with the steps outlined in the wizard.4. see Using Transaction STRUSTSSO2 in SAP System >= 4. Make sure that the profile parameters are set as outlined in Profile Parameters. for example.2. Save your settings. it means that the system that is responsible for processing (managing and storing) the data of an inbound request is the local SAP Gateway instance itself.2. For further information. 1.2. proceed as follows: 1. If that system alias is flagged as a Local SAP Gateway instance. Certificate List) to configure the SAP system. If everything has been configured correctly the traffic lights are green. The SSO2 administration report for the designated SAP system displays. In transaction SMT1 choose Create . In the System Number field. 3. Certificate List) to configure the SAP Gateway system. use STRUSTSSO2 to import the certificates from the SAP Gateway server.2. 1. Note When specifying SAP system aliases we recommend always to enter the system ID. For more information. then SAP Gateway checks whether one of the above system aliases has defined a system ID XYZ and client 999. This option is typically used for testing scenarios. this system will be used.SAP System Alias Name of the system alias. Select your GSDO type and choose GSI Implementation . Here you only need to enter a setting if you use content scenarios which are configured via Web services. together with the target client. ensure that you have first installed and configured the consumer server. this system ID will be used.999). Software Version This setting is specified by the content scenario you are using. 3.4. Example Sample syntax for system alias: /sap/opu/odata/IWBEP/TEA_TEST_APPLICATION.2. The SAP Gateway system searches for all existing system aliases for the user and the specified service. If this is the case.3 Activating SAP Gateway Before you can use SAP Gateway functionality you have to activate it globally in your system. However. 1. Client Target client. If this is the case. all SAP Gateway OData services stop running. With multiple origin composition you can have access to several backend systems to retrieve data and might not necessarily want to use system aliases but instead use a combination of system ID and client. For Local App The system alias is to be used by BEP. When you deactivate it. The SAP Gateway system checks if one from above system aliases equals sid(XYZ.6 System ID in Origin Segment Parameter In the URL of your service you can use the origin segment parameter o to expose the system alias. determines the system alias for a remote call to a backend system. you must activate SAP Gateway. 4. All rights reserved. If you activate Local SAP GW for a SAP System Alias called LOCAL the RFC Destination is usually NONE . Otherwise an error message is displayed. WS Provider System Name of the Web service provider business system. see the F1 help in the system and Hub OData Channel with IW_BEP Installation. check the following to determine the value to set for your GSDOs: In transaction SPRO open the SAP Reference IMG and navigate to: NetWeaver SAP Gateway Former Development SAP Former Generic Channel Development Generic Service Data Object (GSDO) GSDO Types & GSDO Contexts & GSI Implementations and click on the Activity icon.o=XYZ_999/Teams Sample syntax for system ID and client: /sap/opu/odata/IWBEP/TEA_TEST_APPLICATION. Save your settings. You can activate and deactivate SAP Gateway.2. In the context of Generic Channel development. If no such system exists underneath the specified service. System ID Name of the SAP target system.o=sid(XYZ. Local SAP GW The system that is responsible for processing (managing and storing) the data of an inbound request is the local SAP Gateway instance itself. and an error message is sent to any system that calls for the services.999)/Teams The processing is as follows: 1. Page 31 of 95 . for example when using the BOR Generator locally. Description Descriptive text for the system alias. Configuration Steps For each system alias you need to enter also a system ID and a client. The SAP target system. if this has not yet been configured already. Note Before activating SAP Gateway. instead of the system name you can also use the system ID (SID) together with the corresponding client. no consumer servers can communicate with it. PUBLIC © 2014 SAP SE or an SAP affiliate company. Typically it is DEFAULT . you might wish to refrain from thus exposing the system name of your SAP Gateway system in the URL of your service for security reasons. see Creating the SAP System Alias for Applications. 4.4. When you have completed the installation and post-installation configuration described in the sections above. 2. In this case. RFC Destination Specify the RFC destination defined for your SAP system. Therefore. If you also want to create OData requests you might not have information on any SAP Gateway system alias. there can be different system aliases for one backend system if you use multiple origin composition. For more information.2. SAP Gateway also supports OData requests with a combination of system ID and client as backend origin.2. In addition. To maintain models. Thus two additional repository object types exist in SAP Gateway.4 Service Development in the Backend System Data is retrieved from an SAP Business Suite (backend) system. In transaction SPRO open the SAP Reference IMG and navigate to SAP NetWeaver SAP Gateway Service Enablement Backend OData Channel Service Development for Backend OData Channel and Maintain Services . Choose Activate . For more information see Maintaining Models and Services. Click on the Activity icon. For more information.1 Maintaining Models and Services To retrieve data from a backend system. For more information see Display Models and Services.Proceed as follows: 1. see Define Parallelization of Batch Queries. which is the name of the class providing metadata for this model. Prerequisites The following entities must exist: The data provider class for the service The model provider class for all models More Information OData Channel 1. You can also display. After this registration SAP Gateway can expose the corresponding OData services. More Information Periodical Tasks 1. Enter the Model Provider Class . A message displays informing you of the current status.4. The external name of a service is derived from the technical name and cannot be freely defined to ensure a GTADIR connection to guarantee unique services. For more information. This is integrated into transaction SU22. register it on the SAP Business Suite system: Maintain models Maintain services You can maintain these settings in IMG activities in the SAP Business Suite system. In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver SAP Gateway OData Channel Configuration Activate or Deactivate SAP Gateway and click on the Activity icon. Repository Objects The registration process of OData Channel models and services is unique: In order to allow collecting authorizations per data provider class (DPC) a repository object type is available.2. After the service has been developed. Once a service has been defined in the SAP Business Suite system it can be activated on the SAP Gateway system. proceed as follows: 1. you have to define a service in the backend system. Note that this activity is read-only.4. Enter 0001 as Model Version . 3. Maintain Model Start the SAP Reference IMG (transaction SPRO) and choose Service Development for Backend OData Channel SAP NetWeaver Maintain Models SAP Gateway Service Enablement Backend OData Channel . Choose Create . For more information see Roles in the SAP Gateway Landscape. 4. see OData Channel Generation Tool. then define a service. PUBLIC © 2014 SAP SE or an SAP affiliate company. you need to activate (register) the service. Page 32 of 95 . 2. You create service /MYNAMESPACE/MYSERVICE with version 0001 which then results in http://<host>:<port>/sap/opu/odata/mynamespace/MYSERVICE. 2. 5. and finally assign the model to the service. edit or delete an existing model.4.2. To activate the service. an activity is provided to define parallelization of batch queries. for example. Under the IMG path SAP NetWeaver SAP Gateway Service Enablement Backend OData Channel Service Development for Backend OData Channel an additional activity OData Channel Generation Tool is provided. First you have to define a model. Maintain Models To get an overview of the settings the IMG activity SAP NetWeaver SAP Gateway Service Enablement Backend OData Channel Service Development for Backend OData Channel Display Models and Services is provided. These repository objects have the following impact: Models and services shall only be transported via the transport objects. See Maintain Services. Enter a Technical Model Name . In addition. which can include a namespace within /. A message displays. All rights reserved. Both the application logic and metadata are hosted on the SAP Business Suite system. /MYNAMESPACE/. Maximum Number of Parallel Queries Specify the maximum number to limit the amount of parallel processing queries to save system resources. you might want to deactivate this on service level for individual services. Assign Model to Service To assign your model to a service. Choose Create . Default value: 0. Save your settings. In case of serialization the duration of the consecutive queries is the sum of all query processing times. 3. 2. Service-Based Batch Parallelization You can deactivate the parallelization of batch queries for a single service. Start the SAP Reference IMG (transaction SPRO) and navigate to Service Development for Backend OData Channel SAP NetWeaver Display Models and Services SAP Gateway Service Enablement Backend OData Channel .2. see Maintaining Models and Services.5 Service Development in the SAP Gateway Hub System PUBLIC © 2014 SAP SE or an SAP affiliate company. Click on the Activity icon. Enter the central transaction for Activating and Maintaining Services . which is the name of the class providing the runtime data for this service This class implements the interface /IWBEP/IF_MGW_CORE_SRV_RUNTIME. 7. which provides an overview of existing configuration settings. proceed as follows: 1. Zero (0) means it only depends on current system resources. parallelization of batch requests will be deactivated at runtime. you can display existing models and the assignment of these models to services. The following parameters are valid for the current SAP client: Activate Parallelization for Batch Queries Mark or unmark this option to enable or disable the parallelization. Enter an explanatory text as Description . For this an IMG activity is available: In transaction SPRO open the SAP NetWeaver reference IMG and navigate to SAP Gateway Service Enablement Backend OData Channel Configuration Settings Define Parallelization of Batch Queries . This number will be ignored if it is greater than the maximum number of dialog work processes available at parallelization time which is based on system settings (transaction RZ11.6. Soft state and parallelization do not work together. If soft state mode remains activated for the current service. The service configuration window is displayed. the total duration in parallel mode is just the maximum duration of these query processing times and a minimal overhead for parallelization.4. Choose Assign Model . In general you would activate parallelization of batch queries globally in the implementation guide (IMG activity Define Parallelization of Batch Queries ) and specify how many batch queries can be processed in parallel. 7. This means that the service will run sequentially. Note Parallelization of batch requests is not possible in soft state mode. Choose Save . Save your settings. 5. To maintain the service. Enter a Technical Service Name . 4. Maintain Service Start the SAP Reference IMG (transaction SPRo) and choose Service Development for Backend OData Channel SAP NetWeaver Maintain Service SAP Gateway Service Enablement Backend OData Channel . 1. profile parameters rdisp/rfc*) .4. Enter the Technical Model Name and the corresponding Model Version .2. 1. 2.3 Defining Parallelization of Batch Queries The transaction for defining parallelization of batch queries allows you to optimize the performance of batch request processing. Choose Service Implementation and then Service Configuration (F6) . proceed as follows: 1. 4. You can activate the option for disabling of parallelization as soon as batch parallelization is active globally.2. which you created in Maintain Models . Page 33 of 95 . Contrary to this. Activate parallelization globally in the implementation guide (IMG) as explained above. which can include a namespace. 1. 1. 3. If you want to maintain models and services. 5. Enter the Data Provider Class . Enter 0001 as Version . All rights reserved.2 Displaying Models and Services In your SAP Business Suite backend system. It can be chosen to specify that it is deactivated for this service if you change the global setting later and later allow parallelization globally.4. Enter an explanatory text as Description . 3. This option cannot be activated if parallelization has been switched off globally. In the Service Catalog select your service and select your system alias in System Alias . In section Service Settings you can activate Disable Parallelization of Batch Requests . This is a read-only activity. This option Disable Parallelization of Batch Requests is no longer greyed out on service level. The default configuration is active for parallelization.4. 6. However. 2.4. From the SAP Gateway system. activate the desired service. Example It is possible to separate the development. Note If your SAP Gateway hub system is based on an SAP NetWeaver release lower than 7.2.4.40. 2.40 or higher. if you specify corresponding roles/host names and system aliases. you need to make some additional configuration settings in the SAP Gateway hub system in which you intend to develop OData services. 1. an OData request from an SAP Gateway consumer can be routed to the corresponding backend system. Ideally you have a system alias without any role assignment for all users without a role assignment and disjunct roles for the system aliases for all other users to the different backend systems (development. see Deployment Options. see Register your Service in the SAP Gateway System. the core component SAP_GWFND is installed as standard. MOC is also used for CREATE calls and the metadata. CREATE calls cannot be done in all configured backend systems. aggregate them in one single service and updating different backend systems while using the same user. so that you can specify different roles or host names for the same system alias for a service.5 Service Development in the SAP Gateway Hub System After you have made the relevant configuration settings in the SAP Business Suite backend system in which component IW_BEP is installed (SAP NetWeaver releases lower than 7. 1. productive).4. Note In previous support packages OData Channel based content was routed via GSDO groups which are no longer relevant in SAP Gateway 2.2 Multiple Origin Composition Multiple origin composition (MOC) is the ability to collect data from different backend systems.5. The system can correctly identify the SAP system that is responsible for processing (managing and storing) the data of an inbound request. one located in America and one in Europe.40 or higher). and combine them. the quality and the production landscape via dedicated clients on the SAP Gateway hub system. you could have two identical systems. Customize your service to support MOC. For applications based on OData Channel with IW_BEP on the hub navigate to OData Channel Development with IW_BEP Registration Assign SAP System Aliases to OData Service . For example. For more information. If you leave the User Role or the Host Name field empty. This feature is relevant only for entity sets with an annotation of addressable=true. With this assignment. Proceed as follows to use the MOC: 1. The user will be directed as follows if he or she has two or several roles relative to different system aliases: If a user is assigned to more than one system alias the system alias which is marked as default wins. but only in the default system. PUBLIC © 2014 SAP SE or an SAP affiliate company. Open transaction SPRO and choose SAP Reference IMG . The user will be directed as follows if he or she does not have special roles: If there is a system alias maintained without any role assignment then it is used for all users. For information on how to activate your service.4. you will need to install the core component IW_FND in your hub system. The roles are only for user grouping and do not need to have any special authorization. Thus a service can be made available for several system aliases. Different backend systems are supported.2. If more than one system alias is found and either none of the system aliases or more than one of these aliases are flagged as default an error is raised. For this an IMG activity is available in the SAP Gateway Implementation Guide (IMG): in transaction SPRO open the SAP Reference IMG and navigate to SAP Gateway : For applications based on backend OData Channel system navigate to OData Channel Administration General Settings Assign SAP System Aliases to OData Service .5. The SAP system alias can have a specific role or a specific host name associated to itself. Thus. Page 34 of 95 . quality.0 SP03. OData Channel based content which is developed either on the SAP Gateway hub system or on a SAP Business Suite backend system is based on the service.40) or in which core component SAP_GWFND is installed (SAP NetWeaver 7. The system aliases with role assignment should be marked as default in this case. the setting is valid for all roles/host names. Implementing this feature creates a different version of the service (the SAP_Origin field is added).1 Assigning SAP System Alias to OData Service You can assign SAP system aliases to a service. Assigning SAP System Alias to OData Service Activate and Maintain Services Multiple Origin Composition Dynamic System Alias Calculation Via /IWFND/ES_MGW_DEST_FINDER 1. If your SAP Gateway hub system is based on SAP NetWever 7. At present.2. All rights reserved.1. Note This feature is only supported in Standard Mode . 1. enter the relevant system alias. In the System Aliases section. On the SAP Gateway system. Additionally. The next call with this skiptoken or any other call with skiptoken will not be parallelized because the result has to be continued by the backend system which returned this skiptoken before. http://<host name>:<port>/sap/opu/odata/iwfnd/RMTSAMPLEFLIGHT. the first system is used as the default. changesets are also supported. Identifier field. If a feed of a service is called in MOC mode. In the Service Catalog list. The default value zero ( 0 ) means it only depends on current system resources. In the Service Doc. all system aliases assigned for the current user and service are identified. Test the service. 3. Page 35 of 95 . the service composes the data from all backend systems assigned to it. Finally the results of each backend system are composed into one feed that is returned to the client. 2. Contrary to this. An example URL for RMTSAMPLEFLIGHT looks as follows: SAP NetWeaver SAP Gateway OData . 7. you can use parameter Maximum Number of Parallel Backend Calls to limit the use of current system resources. then the OData consumer will only receive results up to this backend including a skiptoken. To call a service in MOC mode the segment parameter . /sap/opu/odata/iwfnd/RMTSAMPLEFLIGHT.mo/TravelagencyCollection Error Behavior The default error behavior is not error-tolerant. All changeset operations for one backend are collected and sent to this backend via one RFC. Make sure that the SAP_Origin field appears in the service's metadata. _0001). In the ICF Nodes section. Performance Improvement In case of serialization the duration of a READ_ENTITYSET within a hub system is the sum of all backend calls. 6. 1. Parallelization of Multiple Origin Composition When using multiple origin composition you can determine both the minimum number of backend systems and the maximum number of parallel backend calls. select the desired service. Note The default system is used whenever the service is not called as MOC. If you have defined more than one default system alias. 5. Only one system is to be defined as the default. Changesets In the context of multiple origin composition. In the SAP System Alias field. If the data retrieval from any of the backend systems causes an error the READ feed request returns that error. The service appears in the ICF Nodes section on the lower left corner of the screen. You can find an example in SAP Note 1890049 . Parallelization and Skiptoken If server paging is realized in any backend data providers. Choose New Entries or select an existing entry and choose Copy . If a service is marked to be error-tolerant this behavior changes: PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved. For this a new IMG activity is available: On the SAP Gateway system.3. In the IMG activity you can set the following configuration parameters: Minimum Number of Backend Systems can have the following values: 0 : No parallelization n : Parallelization will only be done from n backend systems onwards The maximum number of parallel backend calls is always based on current resources of the SAP Gateway hub system. Then the backend system of each of these system aliases is called reading the data from each system. open the SAP Reference IMG in transaction SPRO and navigate to Channel Administration General Settings Activate and Maintain Services 2. choose System Alias to add the system alias. open the SAP Reference IMG in transaction SPRO and navigate to SAP NetWeaver SAP Gateway OData Channel Composition Define Parallelization for Multiple Origin Composition . Syntax Example: 01. 2. select the Standard Mode ICF Node. the duration in parallel mode is just the maximum duration of all backend calls and means a minimal overhead for parallelization. Navigate to SAP NetWeaver SAP Gateway OData Channel Administration General Settings Activate and Maintain Services to add the system aliases for the relevant backend systems and define the desired default system. Search for the desired service with the Filter icon.mo is added to the service name of the request URI. enter the ID of the service document followed by an underscore and the 4–digit version number (for example. 4. Repeat as necessary to add the desired backend systems. More precisely. Error Tolerance You can flag READ feed requests of a service in MOC mode error-tolerant. You can use this parallelization of READ_ENTITYSET to several backend systems to achieve optimized performance. 3.mo/ 4. Select the desired service and choose Call Browser under ICF Nodes . Otherwise if only some of the backend systems causes an error a feed is returned to the client. The data retrieved successfully from some of the backend systems is composed into that feed. If a service is not listed in this configuration the service is not error-tolerant. All rights reserved.5. is_default of TYPE /iwfnd/mgw_inma_default_alias. The system searches for all system aliases assigned to a service for a user.An error is returned only if the data retrieval from all backend systems causes an error. developers can use method SET_SERVICE_SCHEMA_VERSION of interface /IWBEP/IF:MGW_ODATA_MODEL to set the SAP schema version. Note that this field can be empty. the one system with the Metadata default flag is chosen. In addition. For requests in multiple origin composition mode this flag specifies the backend system from which to retrieve the metadata. If none of the found systems has the Default System flag assigned an error is triggered. In this context internal policies of customers might prevent the upgrades of certain backends simultaneously. Page 36 of 95 . More Information Error Log 1. This field is filled according to the standard routing in the implementation guide which has the role as an optional “filer”. You can create an entry for each service that shall be error-tolerant. user_role of TYPE /iwfnd/defi_role_name. When multiple origin composition is used in such a scenario this might lead to issues because of a mismatch in the metadata.2. The enhancement sport returns a list of system aliases with the following fields: system_alias of TYPE /iwfnd/defi_system_alias. The data missing form those backend systems that caused an error can be requested again. a service sub-version is available. To remedy this. This sub-version can be used within multiple origin composition to load the metadata of the minimal service sub-version from the cache. If the table contains more than one entry exactly one entry must be flagged as default. That system alias is used for all normal (non multi destination composition) requests. The metadata in single backends differs due to inhomogeneous extensibility or maintenance cycles.4. In the central transaction for activating and maintaining services the flag Metadata is available for an SAP system alias. in order to work on the basis of this minimal sub-version. If the table contains only one entry this can be empty.3 Dynamic System Alias Calculation Via /IWFND/ES_MGW_DEST_FINDER Enhancement spot /IWFND/ES_MGW_DEST_FINDER is provided to help you in dynamically calculating which system alias should be used. Example The service created in the backend system is as follows: Technical Service Name: /IWBEP/TEA_TEST_APPLICATION External Service Name: TEA_TEST_APPLICATION Version: 0001 The service registered on the SAP Gateway system is as follows: Namespace: /IWBEP/ PUBLIC © 2014 SAP SE or an SAP affiliate company. open the SAP Reference IMG in transaction SPRO and navigate to SAP Gateway OData Channel Composition Flag OData Services to be error tolerant in case of MDC SAP NetWeaver . 1. so as to limit the load on that backend system. This has to be defined with the standard implementation guide activity for system aliases. You can therefore use this enhancement spot to overwrite or enhance the standard routing for a service. Syntax Example: 01. an enhancement might reach one of a number of backends at a later point of time. you can use this enhancement spot to control the traffic from the SAP Gateway system to a backend system. If none of the found systems has the Metadata default flag assigned the one with the Default System flag is chosen. 2. metadata or function imports of multiplicity 1. <link rel="next" href=" TravelagencyCollection?$skiptoken=MISSING_DATA_FROM__1_2"/> For this an IMG activity is available: On the SAP Gateway system. 2. The enhancement spot needs the following input: OData service ID User ID Result of the standard routing in the form of a list of system aliases List of HTTP request parameters which is only provided for data requests and not for metadata requests. For that an OData skiptoken is added to that feed. The processing mode is as follows: 1. If more than one system is found. That system alias is used for multi destination composition requests in case of CREATE. Multiple Service Versions Customers might have different timelines in updating their backends. Alternatively. Thus. accepted The request was accepted and the server guarantees that the server state reflects a single execution of the operation. rejected The request was rejected because the combination of RepeatabilityCreation and RequestID was invalid or because the RepeatabilityCreation time was outside the range of values held by the server.4. … RAISE EXCEPTION TYPE EXPORTING textid http_status_code system_alias /iwfnd/cx_mgw_dest_finder = /iwfnd/cx_mgw_dest_finder=>backend_load_too_high = /iwfnd/cx_mgw_dest_finder=>gc_status_service_unavailable = lv_system_alias.External Service Name: TEA_TEST_APPLICATION Version: 0001 Technical Service Name: ZTEA_TEST_APPLICATION (provided during registration) Service Document Identifier: ZTEA_TEST_APPLICATION_0001 (technical service name plus version) The URI would be as follows: URI = /sap/opu/odata/iwbep/TEA_TEST_APPLICATION/TeamCollection The BAdI input would be as follows: IV_USER =MRMEYER IV_SERVICE_ID = ZTEA_TEST_APPLICATION_0001 Table of system aliases containing the result of the standard routing The BAdI output would then be a table of system aliases which were changed by the BADI (or not changed) as a result of the standard routing. But for operations that change the server state (for example. Page 37 of 95 . 1. The request header attributes are passed on to the SAP Business Suite backend system. identifier for the request. Defining Settings for Idempotent Services Defining a Remote Function Call to SAP Gateway Defining Connection Settings to SAP Gateway Creating a bgRFC Supervisor Destination Monitoring bgRFC Queues 1. The server state is the same as if the request had never been received. The server state is the same as if the request had never been received. PUBLIC © 2014 SAP SE or an SAP affiliate company.1 Defining Settings for Idempotent Services HTTP is an inherently unreliable protocol. The client can make the request multiple times with the same RequestID and RepeatabilityCreation header values and get back an appropriate response without the server executing the request multiple times. Defining Settings for Idempotent Services You configure idempotent services by scheduling a background job that ensures that request messages in SAP Gateway only occur once. the client directs that the request must be repeatable. as for example two items instead of one item are created.4. If specified. RepeatabilityCreation The date and time at which the request was first created. When the backend system receives a request it delegates the handling of the RepeatabilityCreation header to the idempotent utility class. and reflects either the current state of the system or the state as it existed when the request was first received. Idempotency guarantees delivery of synchronous messages exactly once. The server returns 412 (Precondition Failed) without attempting to execute the request. All rights reserved. The following values are possible. For idempotent requests (for example GET) the client can simply re-try the request.3 Connection Settings to SAP Gateway Perform the following activities to set up the connection settings to SAP Gateway from your SAP Business Suite backend system. Response Header: RepeatabilityResult A string describing how the server has handled the requested repeatability. Two optional request header attributes and one response header attribute facilitate the ability to retry requests without incurring unintended side-effects: Request Headers RequestID A 32 character GUID string representing a client-generated.6. globally unique for all time. unsupported The request was rejected because the server does not support repeatable execution of the request. creating a new item or invoking a side-effecting service operation such as “Reject Workflow”) re-issuing the request may result in an undesired state. The response returns the success or failure state of the operation as first executed by the server. The server returns 412 (Precondition Failed) without attempting to execute the request.4. Syntax Sample coding throwing an exception in case of too much load on the backend system: 01.4. In the backend system the idempotent utility (provided by the underlying SAP NetWeaver) handles the idempotent support generically. If connection or other issues prevent the client from receiving a response the client is left in doubt if the request was processed by the server.2. For SAP NetWeaver 7. you must first identify the SAP Gateway landscape to use with it. For Period Hours in Document ID the typical value is 12 . and an inbound queue among SAP systems. go to section Select qRFC Version and select bgRFC from the list in qRFC Version . All rights reserved. 2. 12. that is. which is used for communications in an outbound queue. Backend OData Channel Connection Settings to SAP Gateway SAP Define Settings for Idempotent To define settings for idempotent services. 7. If you are using push from a backend system to an SAP Gateway hub system. 1.2. 2.6. SAP Gateway Service Enablement Backend OData Channel Connection Settings to SAP Gateway SAP Create RFC Destination for Outbound Proceed as follows to create the bgRFC destination: 1. 5. Depending on the SAP NetWeaver version. In transaction SPRO open the SAP Reference IMG and navigate to SAP NetWeaver SAP Gateway Settings . For example. . BEP_BGRFC_DEST . enter an explanatory text. 3. Specifying Connection Settings You can specify settings for connecting to a SAP Gateway landscape by using the implementation guide (IMG). On tab Logon & Security enter the technical user and make sure that Current User is not selected. Choose Continue . Choose Enter . Client Specify the system client ID of the host of SAP Gateway. client ID. Click on the Activity icon. This is an activity that is done in the backend system. The RFC Destination Window displays.0. go to section Select Transfer Protocol and select 1 Classic with bgRFC from the list. proceed as follows: 1. 11. the system where software component IW_BEP is installed.4. This is because the WFBATCH user which is the current user in the case of Workflow is not a dialog user and therefore cannot be used for RFC. Enter the SAP Gateway host name in Target Host .3 Connection Settings to SAP Gateway The Business Enablement Provisioning (BEP) functionality can publish events to one or more hosts running SAP Gateway. RFC Destination Specify the name of the RFC destination to the host of SAP Gateway. However. 8. In transaction SPRO open the SAP Reference IMG and navigate to NetWeaver Queues . 2. Note You can also use an existing bgRFC destination in your SAP system to the host of SAP Gateway.For this the SAP Gateway Implementation Guide (MG) has been enhanced. and a system alias of the host of the SAP Gateway landscape to which you want to connect. The client ID you specify should be in the specified system. You can define this remote function call by using the implementation guide (IMG). Click on the Activity icon. A message displays confirming that the job has been scheduled. it is important not to have a trusted RFC connection. Choose Enter and select the Special Options tab. 10. 3. 4.for example BEP_BRFC_DEST .6. In transaction SPRO open the SAP Reference IMG and navigate to NetWeaver SAP Gateway Service Enablement Services .02. for ABAP connections. In RFC Destination specify a name for the RFC destination to be created. 9. Choose Save and Yes to close the warning message that displays. SAP Gateway Service Enablement Backend OData Channel Connection Settings to SAP Gateway 1. Instead a dedicated technical user like ALEREMOTE has to be maintained in the RFC destination in the backend system. and select tab Technical Settings . PUBLIC © 2014 SAP SE or an SAP affiliate company. Page 38 of 95 . Choose Create . Prerequisites Make sure that you have: Defined an RFC destination to SAP Gateway to broadcast the events. 1. Choose Remote Connection to test the connection. In Connection Type enter 3 . In Description 1 .2. For OData Channel you also specify the SAP Gateway landscape. Choose Schedule . The system name. System Alias Enter a unique name for the host of SAP Gateway. do the following: For SAP NetWeaver 7. Information about the connection type displays. 6. Click on the Activity icon of the above mentioned IMG activity. Choose New Entries and enter the following: Destination System Specify the system name of the host of SAP Gateway.2 Defining a Remote Function Call to SAP Gateway You create or define a background remote function call (bgRFC) destination.4. Enter the following default values: For Period Hours in Document the typical value is 6 . and enter its corresponding system number. 4. which consist of function modules to be processed as an indivisible unit. using the RFC destination name BGRFC_SUPERVISOR . Page 39 of 95 . language and password. Click on the Activity icon. Note Application fault exceptions are displayed in the application itself. otherwise delete the unit. Prerequisites Make sure that you have the authorization object S_BGRFC for monitoring or customizing activities assigned to your user role. All rights reserved. SAP Gateway host and service. Save your settings. in Destination under New Supervisor Destination . If the error can be fixed. the supervisor starts or stops the schedulers as required. System faults are all standard REST errors. 2.0. The supervisor destination and the user details display. 1.2. Specify the user. choose Create . make the necessary corrections and then send it to the unit again.6. For SAP NetWeaver 7. BGRFCSUPER . Note The bgRFC supervisor user you specify must have authorizations from authorization object S_RFC. 4. do the following: For SAP NetWeaver 7. Find all the messages that failed to be transported from the host of the backend or OData Channel to the consumer environment. Configuring the bgRFC Supervisor Destination You can configure this bgRFC supervisor destination by using the implementation guide (IMG). target host. Use transaction SU01 to assign role to the user BGRFCSUPER . or other errors that occurred during the activation and operations of Web services. make sure you have already created a separate bgRFC destination for the supervisor using the name BGRFC_SUPERVISOR. More Information bgRFC (Background Remote Function Call) 1. For example.6.4 Configure the bgRFC Supervisor Destination You configure a supervisor destination for the bgRFC to receive the configuration settings for the bgRFC scheduler. Enter the bgRFC supervisor destination name BGRFC_SUPERVISOR . Choose Enter . Depending on the version of SAP NetWeaver. Select tab Define Supervisor Dest . Prerequisites You have created a system user of type B called BGRFCSUPER . Save your settings. These are defined in role SAP_BC_BGRFC_SUPERVISOR.02. 2. You can go into the code to debug the unit (this requires the appropriate PUBLIC © 2014 SAP SE or an SAP affiliate company. For SAP NetWeaver 7. because of system fault exceptions. The Create bgRFC Destination for Supervisor window is displayed.0. In the bgRFC Configuration window choose Save . For example. The procedure you employ depends on the version of SAP NetWeaver in your system.2.5 Monitoring bgRFC Queues You can monitor and display items in the Background Remote Function Call (bgRFC) queue to check for messages which the system failed to send. you have created a bgRFC destination as an ABAP connection. 3. 2. for example: communication error. 1. without load balancing.4. You can manually restart the unit even if the retry limit has been exceeded.3. This user is used for the bgRFC communication using the destination you will create. you configure the supervisor destination for the bgRFC to receive the configuration settings for the bgRFC scheduler. Analyzing the Results of the Monitor You analyze each error message and decide how best to correct the error. In transaction SPRO open the SAP Reference IMG and navigate to SAP NetWeaver Supervisor Destination . BGRFC_SUPERVISOR . 1.4. You have assigned role SAP_BC_BGRFC_SUPERVISOR to user BGRFCSUPER . Use transaction SU01 to create the system user. Later. SAP Gateway Service Enablement Backend OData Channel Connection Settings to SAP Gateway Create bgRFC Proceed as follows: 1. Choose Create User . In addition. All the messages are written in unit queues. This ensures that the scheduler is activated on the same application server as the specified user. 1.1 Configuring Workflow for SAP Gateway This section explains how to configure Workflow for use with SAP Gateway scenarios. . Workflow Settings 1. Generic Channel — See Generic Channel Scenarios for information on configuration settings for Generic Channel supported scenarios. You can download the packages and patches from the SAP Service Marketplace at: http://service. If your system is based on SAP NetWeaver 7. you do not need to install the component IW_BEP since the SAP Gateway Foundation component SAP_GWFND is installed as standard. Select other parameters of the monitor as required.sap.1.com/swdc .4. This section provides the configuration information for all the SAP Gateway supported scenarios. Prerequisites Following are the different components (along with their releases) required for SAP Gateway.4. SAP Gateway supports services on these channels: OData Channel — See OData Channel Scenarios for information on configuration settings for OData Channel supported scenarios.4. PUBLIC © 2014 SAP SE or an SAP affiliate company. 3. If you do not configure the IW_BEP component. Page 40 of 95 .3.40 or higher. This is because Workflow for SAP Gateway is reliant on the BEP functionality. Choose Execute to run the monitor. Monitor the Queue with the Event ID and instance number for the messages which were not sent.5 – SP 22 or BI 7.3. Proceed as follows to monitor bgRFC queues: 1. Select the option for the Outbound scenario and the Queued unit type. you can still use the Workflow functionality. 2.4.3 Configuration Settings for SAP Gateway Supported Scenarios The SAP Gateway system should be configured to start using the SAP Gateway services for different supported channels. You can configure Workflow in the following ways: Configuring Workflow Notifications Note If you want to obtain notifications. but you will not be able to use Push notifications.0 SPS 18 (validated stack) SAP ECC add-on ECC-SE 602 or higher SAP BI (optional) BI 3. you first need to configure the Business Enablement Provisioning (IW_BEP) component before configuring Workflow. The status of the queues is displayed.1. You can monitor the bgRFC queues by using the implementation guide (IMG). or delete all the units inside the inbound destination.1 Creating an Administrator Role for Workflow Procedure Note To perform Workflow configuration steps. Alternatively you can use transaction SBGRFCMON.3. OData Channel Scenarios Configuration Settings SAP Enterprise Resource Planning (SAP ERP) Settings for SAP ERP on SAP Gateway Workflow Services Configuring Workflow for SAP Gateway Business Process Content Powered by SAP Gateway Configuring Business Process Content Powered by SAP Gateway 1. Component Release SAP ERP ERP 2004 with NW 7. 1.authorization role). All rights reserved.1 Configuration Settings for OData Channel Scenarios In the following you can find information on the configuration of the SAP Gateway OData Channel supported scenarios.0 or higher 1. you must have an Administrator Role.SP 17 SAP CRM CRM 6. 4. Click on the Activity icon to open the bgRFC monitor. In transaction SPRO open the SAP Reference IMG and navigate to NetWeaver SAP Gateway Service Enablement Backend OData Channel Connection Settings to SAP Gateway Monitor bgRFC Queues SAP .0 . The flow is composed of the following steps: 1. 19. On the ERP system. To create the administrator role and assign it to users: 1. and install consumer applications. 2. 12. 5. You can logon to the ERP host with the administrator user you have created to configure the ERP components and content. for example. 1. see Setting Up User and Authorization Administrators in the SAP Help Portal. You should be able to access transaction SIMGH and search for the entry Workflow Pattern Customization . 15.2.4. The Complete Role Master Record page is displayed. 21. enter any of the basis roles. In the Role field. The Choose Template page is displayed. choose the Edit icon. You can logon to the ERP host with the administrator user you have created to configure the ERP components and content. 11. open transaction PFCG . for example: SAP_BC_BASIS_ADMIN SAP_BC_CTS_ADMIN SAP_BC_BASIS_MONITORING SAP_BC_BATCH_ADMIN SAP_BC_BDC_ADMIN SAP_BC_WEBSERVICE You can choose any of the listed standard administrator roles. Select /IWWRK/RT_WF_ADM from the list. 10. 8. The Generate profile dialog box is displayed. 17. The status of the profile is displayed as “Generated”. Choose Copy all . Creating a type G RFC destination. or enter an existing one. and select the Users tab in the User Assignment section. Select the Generate option. For more information about SAP user administrator types.3.1. Choose the checkmark. and install consumer applications. In the Assign Profile name for Generated Authorization Profile dialog.4. Recommendation Log on to the ERP system using the user you just assigned. Choose User comparison . 1. Select Edit > Insert Authorization(s) > From template . Choose the ( Copy Role ) icon to create a copy of the standard role. You should be able to access transaction SIMGH and search for the entry Workflow Pattern Customization . Note For all steps in the IMG there is always consumer independent documentation available. The Role Maintenance page is displayed. Choose the checkmark.1. Page 41 of 95 . PUBLIC © 2014 SAP SE or an SAP affiliate company. enter a name for the new role in the to role field. maintain the profile name according to your requirements. 20. Configure and maintain Workflow-specific ERP components and applications. 7. 4. 6.2 Customizing SAP Gateway Workflow Activities This section explains how to customize Workflow for use with SAP Gateway scenarios. Choose Complete comparison . In the Query dialog box. Choose Change Authorization Data under the Maintain Authorization Data and Generate Profiles section. All rights reserved.3. 16. Choose Save . 3. Recommendation Log on to the ERP system using the user you just assigned. Prerequisites Before sending notifications. For example T-SCL550003 . 9. Z_SAP_BC_BASIS_ADMIN . The Change role: Authorizations page is displayed. Choose Generate . In the Role Maintenance page. 14. 2. 13. Choose Save .1. Enter the names of the users you want to assign to this role. 18. Select the Authorizations tab. The Change Roles dialog box is displayed and the role is created. 22. you must configure the SAP Gateway Workflow process as described in the Configuring Workflow Notifications topic.1 Configuring Workflow Notifications This section describes the basic flow for sending notifications. Check that the role was properly created and assigned. Configuring User Authorizations for Push Notifications. Go back to the Change Roles page.You create a role for an administrator user with permissions and privileges for several tasks including the following: Analyze logs and identify potential issues with the ERP landscape.1. Choose the Generate option. The Complete Role Master Record page is displayed. 1. The status of the profile is displayed as “Generated”.1. An Information dialog box is displayed. For example T-SCL550 . To continue with the flow. In the SAP Gateway system. 12. if relevant. All rights reserved. Choose Change Authorization Data under the Maintain Authorization Data and Generate Profiles section.3. Under the Technical Settings tab. Running scheduled reports. To create a user role to be used in the SAP Business Suite system: Note When creating a role in the SAP Business Suite system.3. press F4 and select G HTTP Connection to External Server . In the Assign Profile name for Generated Authorization Profile dialog. 9.4. to the customer's SAP Gateway instance. 9. maintain the profile name according to your requirements. The Choose Template page is displayed. Choose SAP Reference IMG . are configured in the system and can be triggered in the SAP Business Suite system. Choose Save.3. Note The delivery address is that of the SAP connectivity service. Choose User comparison . 7. enter the port number. Choose Single Role . 3. 16.2. Enter the names of the users you want to assign to this role. Choose Generate. you must subscribe to the relevant Workflow service as described in the Subscribing to Notification Types topic. 17. 8. enter name of role you want to create. 11. 15. Choose Complete comparison . Enter the security settings as required. 2. Choose Save.2. Choose Save. Select the Authorizations tab and choose the Edit icon. PUBLIC © 2014 SAP SE or an SAP affiliate company. located in customer's onpremise environment. To create a type G RFC destination: 1. Select Edit > Insert Authorization(s) > From template . 4. It is responsible for enabling the connectivity from the SAP connectivity service servers. Choose Save. field. 19. The Configuration of RFC Connections page is displayed. Choose Create. in the Description field. The Change role: Authorizations page is displayed. 15. 13. make sure you use the Role Template. Prerequisites The following prerequisite must be complied with before you can send notifications: Workflows containing User Decisions or Activity Steps. 1. In the Role field. In the Path Prefix field. 14. Select SAP Customizing Implementation Guide SAP NetWeaver SAP Gateway SAP Gateway to Consumer Create RFC Destination for Outbound Queues .1. 4. go to Configuring User Authorizations for Push Notifications. 6. Choose the checkmark to continue. Press Enter. 5. 16. Choose the checkmark. In the SAP Business Suite system. open transaction SPRO. Choose Execute. enter any additional directories.1 Creating a Type G RFC Destination You must create a type G RFC destination with the delivery address given in the subscription request body to allow the notification to be delivered to the user. 1. 8. 11. If relevant.1. 13. 2. 12. located in SAP's on-demand environment. 5. select the Logon & Security tab. enter the host IP. 10. open transaction PFCG.1. Choose the Adopt reference .4. for example GW_RFC . The Generate profile dialog box is displayed. In the RFC Destination field. 20. The SAP connectivity service on-demand component resides in the customer's on premise environment. and select the Users tab in the User Assignment section. 7.1. 14. enter the desired name. After the notifications have been configured. In the Target Host field.2 Configuring User Authorizations for Push Notifications All users who are allowed to receive full payload need to be assigned a specific role in the SAP Business Suite system. In the Service No. 6. 10. OData Channel Configuration Connection Settings In the Connection Type field. 18. Page 42 of 95 . 3. Go back to the Change Roles page. Select /IWWRK/TR_WF_GW_USR from the list. Check that the role was properly created and assigned.1. enter the desired description. 8. 7. 9. go to Running Scheduled Reports. 2. Choose Job wizard to create a new job. In the Variant field. 3. enter the variant’s description. Choose Save. In the wizard’s opening page. To schedule running of various reports. 2.3 Running Scheduled Reports To send notifications tasks between the ECC SAP system and consumer applications. Choose Create. The ABAP: Variants – Initial Screen page is displayed. On to the SAP system. In the Program field.1. Choose Save. filter OSP_DELTA. 5. In the Filter field. Select the Immediately radio button and choose Continue . 4. The Maintain Variant: Report page is displayed. 4. In the Description field. 10. open transaction SM36. Check the Add additional steps (optional) checkbox. Choose Display. In the Variant field. All rights reserved. GW_VAR1 6. PUBLIC © 2014 SAP SE or an SAP affiliate company. open transaction SE38 The ABAP Editor: Initial Screen page is displayed.1. Schedule the NetWeaver report RSWNSEL (or run the report when required). In the Job Name field enter a name and choose Continue . This report should run after the successful execution of the NetWeaver report RSWNSEL. you need to know the following parameters: Program field – Name of the report you want to run Variant field – Name of the variant you want to create Meaning field – Description of the variant you want to create Scheduling running of reports involves: Creating variants Scheduling background job for the variant Creating Variants for Report RSWNSEL To create variants for the RSWNSEL report: 1. and choose Continue . enter the variant’s description. 4. In the Program field. Choose Attributes . 6. 3. For example. 2. enter the variant name. GW_VAR1 6. The Variant Attributes page is displayed. Save to save the value of the variants. 3. The necessary variant of the report is Scenario OSP. enter the name of the variant. This report retrieves the workflow items created in the ECC SAP ERP system and sends it for processing by Workflow SAP Gateway. Refer to the next section Procedure to Schedule Running of Reports to run the reports. enter RSWNSEL .4. enter OSP. 11. Page 43 of 95 . Schedule the reports as per the following sequence: 1. 5. Choose Create. Choose Display. Save to save the value of the variants. 5. Creating Variants for Report /IWWRK/R_WF_ITEM_SELECTION_GW To create variants for the /IWWRK/R_WF_ITEM_SELECTION_GW report: 1. 10. Choose 10. In the Description field. This report processes the workflow items retrieved by the report RSWNSEL and sends task notifications. On the SAP system. We recommend that you run this report at a frequency of 15 minutes. 2. In the ABAP Program Name field enter the report name (/IWWRK/R_WF_ITEM_SELECTION_GW) In the Variant field. 9. the following 2 reports must be scheduled in the ECC SAP system: RSWNSEL /IWWRK/R_WF_ITEM_SELECTION_GW The logon user used to schedule the reports should be a valid administrator user. The Maintain Variant: Report page is displayed. Select the Variants radio button. 9. enter OSP_DELTA. In the ABAP Program Name field enter the report name (RSWNSEL). 8. Select the Variants radio button. On the SAP system. 1.1. 11. In the Variant field. Select the ABAP program step radio button and choose Continue . Schedule the Workflow SAP Gateway pattern report /IWWRK/R_WF_ITEM_SELECTION_GW (or run the report when required). The Maintain Variant: Report page is displayed. 8. open transaction SE38 The ABAP Editor: Initial Screen page is displayed. Scheduling Background Jobs To schedule background jobs: 1. Procedure to Schedule Running of Reports You can schedule the running of reports using your administrator user. The necessary variant of the report is a Default variant. For example. enter the name of the variant. In the Scenario field. The Maintain Variant: Report page is displayed.To continue with the flow. enter /IWWRK/R_WF_ITEM_SELECTION_GW . Choose Attributes . 12. enter the variant name. Select the ABAP program step radio button and choose Continue . Choose 12. The ABAP: Variants – Initial Screen page is displayed. for example GW_VAR1 and choose Continue twice. 7. The Define Background Job page is displayed. for example GW_VAR1 and choose Continue . 7.3. The Variant Attributes page is displayed.2. choose Continue . We recommend that you run the reports at a frequency of 15 minutes. Refer to the next section Procedure to Schedule Running of Reports to run the reports. 2. You can also maintain additional services for the provider. PUBLIC © 2014 SAP SE or an SAP affiliate company. From the Providers table. Choose Complete . To consume it. In the Dialog Structure section. Workflow Task Service: Central Hub Deployment with IW_BEP Backend Installation Workflow Task Service: Central Hub Deployment with IW_BEP Hub Installation For more information about installing SAP Gateway in your system landscape. Choose New Entries . 3. Activating an Existing Provider To activate an existing provider: 1. Choose Create .1. 1.com/saphelp_wp/helpdata/en/c4/3a8009505211d189550000e829fbbd/frameset.2 Workflow Settings This section describes how to configure the Workflow process. From your SAP system. which is installed as standard. The Task Provider Framework consists of twocomponents: Push Framework Generic Worklist The Push Framework collects notifications from all customized active task providers and sends them to the SAP Gateway system.2. Navigate to SAP NetWeaver SAP Gateway Service Enablement Content Workflow Settings . Depending on whether you use the Business Enablement Provisioning (BEP) functionality in an SAP Business Suite backend system or an SAP Gateway hub system. Choose Save.htm This is the last step in the configuration flow. double-click Providers . Note If your system landscape is based on SAP NetWeaver 7. the service is deactivated.com/saphelp_nw70ehp1/helpdata/en/1d/ab3207b610e3408fff44d6b1de15e6/frameset. you must register an entry in the Providers section. set the For Local App flag. 3. 18. open transaction SPRO.sap.13. The Generic Worklist collects the user items from all customized active task providers to create a unified inbox view. refer to the topic Background Job Monitoring Monitor on the SAP Library at http://help. Adding a New Provider To add a new provider. In the Minute(s) field. add its details in the Provider Details section and define its adapter classes for the Task Provider Framework in the Adapter Classes section. 16. 2. select the BWF checkbox to activate the /IWWRK/WFSERVICE subscription notification. 2. 15. 2. go to Subscribing to Notification Types to subscribe to the relevant Workflow service. 17. In the Dialog Structure section. 14. To activate the service on the SAP Gateway system: 1. Set the system alias as described in the Creating the SAP System Alias for Applications section.3.1. Choose SAP Reference IMG . you must first activate it. choose the appropriate service for your system landscape. Select None of the above and choose Other periods . 3. 1. see Deployment Options.4. select the Period checkbox and choose Continue . In the Periodic jobs section. you do not need to install the IW_BEP component in your system since the BEP functionality is included in the core SAP Gateway component SAP_GWFND.40 or higher. If you are using the central hub deployment option.htm and to the topic Managing Jobs from the Job Overview on the SAP Library at http://help.sap. Activate the /iwwrk/WFSERVICE service for backend deployment or the /IWWRK/WFHUBSERVICE service for embedded deployment using the system alias created above as described in the Register your Service in the SAP Gateway System section. Page 44 of 95 . Choose Continue . Workflow Configurations You can perform the following configurations on the Workflow process: Task Provider Customizing Maintain Workflow Filter Settings Maintain Task Names and Decision Options Enable Task Filter To reach these activities: 1. All rights reserved. double-click Providers . Updating Background Jobs To update background jobs: For help on updating a job. enter 15 . Task Provider Customizing This activity allows you to maintain Workflow task providers in the Task Provider Framework. Activating the Service By default. 3. 4. 5. 6. 7. In the Providers section, enter the provider ID and select the Active checkbox. Choose Save. In the Dialog Structure section, select Provider Details . Choose New Entries . In the Provider Details table, enter the provider ID, the default internal service name, the version number, and the provider's description. Note If no specific service can be found for an item, the default service and version number is used instead. 8. Choose Save. Defining the Provider Adapter Classes 1. 2. 3. 4. 5. 6. In the Dialog Structure section, select Task Providers . In the Task Providers table, select the relevant provider. In the Dialog Structure section, double-click Adapter Classes . Choose New Entries . In the first line of the Adapter Classes table, under Adapter Type , select Generic Worklist from the drop-down list. In the Class/Interface field, enter the class you implemented for retrieving all the user items from the provider (inherited from /IWWRK/CL_GWL_ABS_DATA). 7. In the second line of the Adapter Classes table, under Adapter Type, select Push Framework from the drop-down list. 8. In the Class/Interface field, enter the class you implemented for retrieving all the notifications that need to be sent from the provider to the SAP Gateway system (inherited from /IWWRK/CL_PFW_ABSTR). 9. Choose Save. Defining the Provider Specific Services 1. 2. 3. 4. 5. In the Dialog Structure section, select Task Providers . In the Task Providers section, select the relevant provider. In the Dialog Structure section, double-click Services . Choose New Entries . In the Services table, enter the internal service name, the version number, the main and secondary unique IDs (values used to identify the service), and the service description. 6. Choose Save. Maintain Task Names and Decision Options This activity allows you to maintain Workflow tasks that need to be included in the task filter together with their names and decision keys. Note For user decision steps, these customizing settings are required only when the filter is active. When the filter is not active, all user decision items are read and all notifications are sent. Adding a new Workflow Task with its Corresponding ID to the Workflow Task Filter You can add Workflow tasks and their corresponding IDs to the Workflow task filter. If the filter is active, only the Workflow items maintained in this list are included in the query results. Notifications are sent to the SAP Gateway only for these items. You can define a name to be displayed when reading a specific task. Names can be maintained in several languages. You can add names only in the language in which you logged on to the system. If a task is read in a specific language in which no name is maintained, the name is read according to the system kernel language. If no name is maintained for the system kernel language, the name consists of the Workflow and step ID. To add the new Workflow task: 1. In the Dialog Structure section, select Step Name . 2. Choose New Entries . 3. In the Step Name section, enter the Workflow ID and step ID, and step description in the relevant columns. Defining Decision Keys You can use decision keys to help include steps in the user decision service. A decision can be applied to the task using these keys. The functionality is carried out using the following enhancement spot customer implementation: /IWWRK/ES_WF_WI_BEFORE_UPD_IB. The descriptions for the decision keys can be maintained in several languages. You can only enter text in the language in which you logged on to the system. If a task is read in a specific language and no text is maintained for the decision key in this language, the text is read according to the system kernel language. To define decision keys: 1. 2. 3. 4. In the Step Name section, select the relevant Workflow. In the Dialog Structure section, double-click Decision keys . Choose New Entries . In the Decision Key section, add a new decision key and its description in the relevant columns. Enable Task Filter This activity allows you to activate or deactivate the task filter. By default, the filter is deactivated. When the task filter is set to Active: Sending Notifications: Only notifications of items that were configured using the Maintain Task Names and Decision Options IMG activity or the Workflow Pattern Customization IMG activity are sent. The SAP Gateway Workflow service only receives items that were configured using the Maintain Task Names and Decision Options IMG activity or the Workflow Pattern Customization IMG activity. When the task filter is not set to active: PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved. Page 45 of 95 All notifications are sent. All items are read. 1.4.3.1.2 Configuring Business Process Content Services Business Process Content Powered by SAP Gateway allows users to consume process data from SAP Business Suite systems in a standards-based fashion. It consists of the following services: Process Service – Allows users to consume process definition and instance information. Process Context Service – Allows users to consume context related information associated with a process. There are two types of deployment scenarios for Business Process Content Powered by SAP Gateway . The actions required to configure the services depend on the deployment scenario: Scenario 1: Business Process Content Powered by SAP Gateway is deployed as an addon for SAP Gateway For more information, see Configuring Services for Deployment Scenario 1. Scenario 2: Business Process Content Powered by SAP Gateway and SAP Gateway are deployed on separate systems For more information, see Configuring Services for Deployment Scenario 2. 1.4.3.1.2.1 Configuring Services for Deployment Scenario 1 You use this procedure to configure the services for the deployment scenario where Business Process Content Powered by SAP Gateway and SAP Gateway are available on the same system. In this case, you perform all the configuration steps on one system. Procedure 1. Create a connection from the Business Process Content Powered by SAP Gateway system to the SAP Business Suite provider system. For more information, see Connecting Business Process Content and Business Suite Systems. 2. Create a system alias for the SAP Business Suite system. For more information, see Creating a System Alias. 3. Activate the process service for the SAP Business Suite system. For more information, see Activating the Process Service. 4. If you want to enable a user to consume process context information, perform the following substeps: 1. Register the process context service for the SAP Business Suite system. For more information, see Registering Process Context Service for Deployment Scenario 1. 2. Activate the process context service for the SAP Business Suite system. For more information, see Activating the Process Context Service. 1.4.3.1.2.2.1 Connecting Business Process Content and Business Suite Systems You use this procedure to create a connection between the Business Process Content Powered by SAP Gateway and SAP Business Suite systems. Prerequisites A software version for the provider system ( SAP Business Suite system) is created and a mapping to the technical model of the Business Process Content system is defined. For more information, see: Creating a Software Version for Provider System Mapping the Software Version and Technical Model Trusted RFC connection is enabled in the SAP Business Suite system. Procedure 1. Log on to the Business Process Content Powered by SAP Gateway system. 2. In transaction SPRO open the SAP Reference IMG and navigate to SAP NetWeaver 3. 4. 5. 6. 7. 8. SAP Gateway Service Enablement Content Business Process Enablement . Expand the Process Service node. Expand the required node. Click the Create RFC Destination activity icon. Choose Create . In the RFC Destination field, enter a name for the RFC destination that you want to create. In the Connection Type field, enter 3 . 9. In the Description 1 field, enter a description for the RFC destination. 10. Press Enter . 11. Choose the Technical Settings tab page. 12. Check that the Load Balancing option is set to No . 13. In the Target Host field, enter the server name of the business suite system. 14. In the System Number field, enter the instance number of the business suite system. 15. Choose the Logon & Security tab page. PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved. Page 46 of 95 16. Select the Current User checkbox. 17. Check that the Trust Relationship or Trusted System option is set to Yes . 18. Save your settings. 19. To check if the connection is working, choose Connection Test . 1.4.3.1.2.2.1.1 Creating a Software Version for Provider System Procedure 1. Log on to the SAP Gateway system. 2. Call transaction SM30. 3. In the Table/View field, enter /IWFND/V_COCCOL . 4. 5. 6. 7. 8. 9. 10. Choose Display . Choose Display > Change . Choose New Entries . In the Type field, select Software Version for Instance Manager . In the Identifier field, enter a name for the software version. In the Description field, enter a long text for the software version. Save your settings. 1.4.3.1.2.2.1.2 Mapping the Software Version and Technical Model You use this procedure to create a mapping for each of the software version created for your Business Process Content system. Procedure 1. Log on to the SAP Gateway system. 2. Call transaction SPRO. 3. Choose SAP Reference IMG . 4. Choose SAP Customizing Implementation Guide SAP NetWeaver SAP Gateway OData Channel Development with IW_BEP . 5. Click the Assign Data Provider to Data Model activity icon. 6. Choose Display > Change . 7. Choose New Entries . 8. In the Model Identifier field, enter a name for your model. 9. In the Type field, select (Adaptation) Data Provider . 10. In the Software Version field, enter the software version you created for your provider system. 11. In the Class/Interface field, select /IWFND/CL_MGW_RUNT_RCLNT_PRXY . 12. In the Description field, enter a long text. 13. Save the changes. Registration 1.4.3.1.3.1 Creating a System Alias You use this procedure to create a system alias for an SAP Business Suite system. Prerequisites You have configured a connection to the SAP Business Suite system. Procedure 1. Create System Alias in SAP Gateway 1. Log on to the SAP Gateway system where Business Process Content Powered by SAP Gateway is deployed. 2. In transaction SPRO open the SAP Reference IMG and navigate to SAP NetWeaver SAP Gateway Service Enablement 3. 4. 5. 6. 7. 8. 9. Content Business Process Enablement . Expand the Process Service node. Click the Maintain System Alias activity icon. Choose New Entries . In the SAP System Alias field, enter a name for the alias. In the Process Platform field, select Business Suite Process Observer Provider . In the RFC Destination field, enter the RFC destination of the business suite system. Save your settings. 2. Create System Alias in Business Process Content PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved. Page 47 of 95 enter /IWPGW/PO . 5. This enables a user to retrieve and use process context information in addition to process definition and instance information. If ZPGW exists. Click the Activate and Maintain Services activity icon. In the System Alias field. In the RFC Destination field. select the alias of the provider system. Press Enter . 6. check if the ZPGW technical service name exists. enter NONE .4. 9. In the Service Catalog section. 5.1. enter a long text. 9. Click the Register Context Service for Process Definition activity icon. Choose Yes for the confirmation message. In transaction SPRO open the SAP Reference IMG and navigate to SAP NetWeaver SAP Gateway Service Enablement 3. Log on to the SAP Gateway system. In transaction SPRO open the SAP Reference IMG and navigate to SAP NetWeaver SAP Gateway OData Channel Administration General Settings . 2.1. In the Service Doc. Save your settings. 3. Select the entry with technical service name /IWPGW/PGW . Identifier field. 7. 6. Content Business Process Enablement . 3. 6. perform the following substeps: 1. All rights reserved.2.2.2.4. In the SAP System Alias field. In the System Alias field. Choose System Alias . Choose Continue . Make a note of the value in the Technical Model Name field.4.4 Registering Process Context Service for Deployment Scenario 1 You use this procedure to register the process context service for an SAP Business Suite system. 4.1. select the alias of the required provider system. In the Software Version field. 11. 5. 2. 8. Select the process definition entry for which you want the system to retrieve the context details. 4. In the Package field. Press Enter . In the Description field. 5. Click the Manage SAP System Aliases activity icon. Choose New Entries . 13. 10.3. 1. Procedure 1. 1. enter the name of the alias that you created. 12.5 Activating the Process Service You use this procedure to activate the process service for an SAP Business Suite system.3. 7. 4. Choose Select . 1. Expand the Process Context Service node.2. SAP NetWeaver SAP Gateway OData Channel Configuration Connection Settings SAP Gateway to SAP System . In transaction SPRO open the SAP Reference IMG and navigate to 2. enter $TMP . 8. 7. Choose New Entries .1. Save your settings.3. Page 48 of 95 . 5. In the SAP System Alias field. Prerequisites You have created a system alias for the SAP Business Suite system. Procedure 1. 3. If ZPGW does not exist. 2. 3. Select the For Local App checkbox. 6. 4. Select the ZPGW service. This enables a user to retrieve and use process definition and instance information.1. Choose Add Service . Choose Add Service . 2.7 Activating the Process Context Service You use this procedure to activate the process context service for an SAP Business Suite system. Log on to the SAP Gateway system where Business Process Content Powered by SAP NetWeaver is deployed.2. Press Enter . Choose Continue . 4. perform the following substeps: 1. This enables a user to retrieve and use process context PUBLIC © 2014 SAP SE or an SAP affiliate company. select the alias of your provider system. enter ZPGW_0001 . 5. Page 49 of 95 . Procedure 1.2 Configuring Services for Deployment Scenario 2 You use this procedure to configure the services for the deployment scenario where Business Process Content Powered by SAP Gateway and SAP Gateway are available on separate systems. 5. SAP NetWeaver SAP Gateway OData Channel Administration General Settings . For more information. Click the Activate and Maintain Services activity icon. see: Creating a Software Version for Provider System Mapping the Software Version and Technical Model Trusted RFC connection is enabled in the SAP Business Suite system. 6. see Creating a System Alias for Business Process Content System. If you want to enable a user to consume process context information. see Activating the Process Context Service. In the Package field. 10. Choose Continue . 1. All rights reserved. 7. For more information.3. 4. Press Enter . select the technical service name entry. select the alias of the provider system. 4. In transaction SPRO open the SAP Reference IMG and navigate to SAP NetWeaver 3. Create a system alias for the SAP Business Suite system in Business Process Content Powered by SAP Gateway system. 2. In transaction SPRO open the SAP Reference IMG and navigate to 3. In the RFC Destination field. For more information.2. 1. see Registering Process Context Service for Deployment Scenario 2. In the Add Service section. For more information. 2.1 Connecting Business Process Content and Business Suite Systems You use this procedure to create a connection between the Business Process Content Powered by SAP Gateway and SAP Business Suite systems. For more information.4. Activate the process context service for the SAP Business Suite system.2. 5. Create a system alias for the Business Process Content Powered by SAP Gateway system in the SAP Gateway system. see Connecting Business Process Content and Business Suite Systems.2. Create a connection from Business Process Content Powered by SAP Gateway system to SAP Business Suite system. Choose Add Service . enter $TMP . Click the Create RFC Destination activity icon. Activate the process service for the SAP Business Suite system. PUBLIC © 2014 SAP SE or an SAP affiliate company. Prerequisites You have created the system alias for the SAP Business Suite system. In the System Alias field. enter a name for the RFC destination that you want to create. perform the following substeps: 1.information in addition to process definition and instance information. Expand the required node. Prerequisites A software version for the provider system ( SAP Business Suite system) is created and a mapping to the technical model of the Business Process Content system is defined. 7. see Activating the Process Service. 2. For more information. 8. SAP Gateway Service Enablement Content Business Process Enablement . Create a connection from SAP Gateway system to Business Process Content Powered by SAP Gateway system. you perform the configuration steps on two different systems. 2. see Connecting SAP Gateway and Business Process Content. Log on to the SAP Gateway system. In the Technical Service Name field.3. Choose Create . 9. 3. 6.1. Procedure 1. Register the process context service for the SAP Business Suite system. Procedure 1. 4. Expand the Process Service node. In this case. For more information. see Creating a System Alias for SAP Business Suite System.4. For more information. 6.1. enter the service name you made a note of when registering the context service. Log on to the Business Process Content Powered by SAP Gateway system. enter a name for the alias. PUBLIC © 2014 SAP SE or an SAP affiliate company. 19. 3. Expand the Process Service node. 10.1 Creating a Software Version for Provider System Procedure 1.4. 2. Registration 1. 2. 13. SAP Gateway Service Enablement Content Business Process Enablement . Choose the Logon & Security tab page. enter the instance number of the business suite system. enter a name for your model. Log on to the Business Process Content Powered by SAP Gateway system.1. 8. select /IWFND/CL_MGW_RUNT_RCLNT_PRXY . 10. Procedure 1. enter the RFC destination of the business suite system. 4.2. 17. enter a description for the RFC destination.3. 12.2. 11. enter a long text for the software version. In the Description 1 field. Check that the Load Balancing option is set to No . 16. 6. In the Identifier field. 7. 2.2. select Business Suite Process Observer Provider . 1. enter /IWFND/V_COCCOL . 18. 3. 5. In the Description field. 9. Save your settings. Select the Current User checkbox. In the Connection Type field. 1. In the System Number field. Click the Assign Data Provider to Data Model activity icon. Save the changes. Check that the Trust Relationship or Trusted System option is set to Yes . In the Class/Interface field. 6. Call transaction SM30. Choose SAP Customizing Implementation Guide SAP NetWeaver SAP Gateway OData Channel Development with IW_BEP . 6.4. All rights reserved.1. enter a long text. 5. 10. 5. select (Adaptation) Data Provider . Log on to the SAP Gateway system.1.1. In the Type field. 7. 15.8. 7. 13.2. In the Table/View field. enter the software version you created for your provider system. 4. 14. select Software Version for Instance Manager . Choose the Technical Settings tab page.2 Creating a System Alias for SAP Business Suite System Prerequisites You have configured a connection to the SAP Business Suite system. enter the server name of the business suite system. In the Model Identifier field. Save your settings. In the Software Version field. In the RFC Destination field.2. To check if the connection is working. Choose SAP Reference IMG . 9. Choose New Entries . Choose Display > Change . In the Description field. Choose Display > Change .1. 8. 11. In transaction SPRO open the SAP Reference IMG and navigate to SAP NetWeaver 3. 12. Press Enter .4. Procedure 1. In the Type field. Page 50 of 95 . In the SAP System Alias field. 8.3. choose Connection Test . Click the Maintain System Alias activity icon. In the Target Host field.2 Mapping the Software Version and Technical Model You use this procedure to create a mapping for each of the software version created for your Business Process Content system.3. 4. Choose New Entries . In the Process Platform field. enter 3 .2. Call transaction SPRO. Choose New Entries . enter a name for the software version. Choose Display . 9. Log on to the SAP Gateway system. 8. 6. Prerequisites You have enabled a trusted RFC connection in the Business Process Content Powered by SAP Gateway system. In the System Number field. 1. Log on to the SAP Gateway system. Procedure 1.9. Choose Create . Choose the Manage RFC Destinations activity icon.2.2. 14.3.3. Log on to the SAP Gateway system. Select the Current User checkbox. enter the name of the alias that you created in the Business Process Content system. Press Enter . In the Connection Type field. SAP NetWeaver SAP Gateway OData Channel Configuration Connection Settings SAP Gateway to SAP System . To check if the connection is working. 7. Prerequisites You have created a system alias for the SAP Business Suite system.4. This enables a user to retrieve and use process definition and instance information. Procedure 1.5 Activating the Process Service You use this procedure to activate the process service for an SAP Business Suite system.2. enter the RFC destination of Business Process Content system. 13. In the RFC Destination field.2. 8.1. In transaction SPRO open the SAP Reference IMG and navigate to 3. Save your settings. Choose the Logon & Security tab page. Page 51 of 95 . 1. 11. enter 3 .3. enter the server name of the Business Process Content system.2. Check that the Load Balancing option is set to No . 7. 4. Choose the Technical Settings tab page.4 Creating a System Alias for Business Process Content System Prerequisites You have created a system alias in the Business Process Content Powered by SAP Gateway system. 2. enter a long text. 6. In the SAP System Alias field. PUBLIC © 2014 SAP SE or an SAP affiliate company. 15. enter a name for the RFC destination you want to create. In transaction SPRO open the SAP Reference IMG and navigate to 3. Save your settings.2. 5. Choose New Entries . In the Description field. choose Connection Test . enter the instance number of the Business Process Content system.1.1.4.3 Connecting SAP Gateway and Business Process Content You use this procedure to create a connection between the SAP Gateway and Business Process Content Powered by SAP Gateway systems. 17. In the Description 1 field. 9. In the Target Host field. In the RFC Destination field. All rights reserved. Save your settings. 9. enter a description for the RFC destination. Log on to the SAP Gateway system. Check that the Trust Relationship option is set to Yes . 1. 16. In the Software Version field.4. 5. 10. SAP NetWeaver SAP Gateway OData Channel Configuration Connection Settings SAP Gateway to SAP System . enter /IWPGW/PO . 4. Click the Manage SAP System Aliases activity icon. 2. 12. Procedure 1. select the alias of the provider system. Make a note of the value in the Technical Model Name field. In the System Alias field. select the alias of the required business suite provider system. Choose Continue . In the Add Service section. 5. 7. All rights reserved. 5. Page 52 of 95 .2. SAP NetWeaver SAP Gateway OData Channel Administration General Settings . enter the service name you made a note of when registering the context service. Press Enter . If ZPGW exists. enter $TMP . Prerequisites You have created the system alias for the SAP Business Suite system. 3. 6. Choose New Entries . Press Enter . 2. In transaction SPRO open the SAP Reference IMG and navigate to SAP NetWeaver SAP Gateway OData Channel Administration General Settings . In the SAP System Alias field. 5. select the alias of the provider system. select the technical service name entry. check if the ZPGW technical service name exists. Press Enter . Choose Add Service .1.1. Click the Activate and Maintain Services activity icon. In the Package field. 12. Choose Add Service . 2. In the Service Doc. 6.2.3. Log on to the Business Process Content Powered by SAP Gateway system. 3. In the System Alias field. 2. 9. 10.1. In the Service Catalog section. In the Technical Service Name field. Log on to the SAP Gateway system. 5. In the System Alias field. This enables a user to retrieve and use process context information in addition to process definition and instance information. In transaction SPRO open the SAP Reference IMG and navigate to 3. Press Enter . select the alias of your provider system. Choose Add Service . If ZPGW does not exist.7 Activating the Process Context Service You use this procedure to activate the process context service for an SAP Business Suite system. Press Enter .2. 10. 6. Choose System Alias . 7. 4. 4. SAP Gateway Service Enablement Content Business Process Enablement . enter $TMP . Procedure 1. Click the Activate and Maintain Services activity icon. 8. In the Add Context Service section. 7.4.3. select the process definition for which you want to register the context service. 4. which enables a user to retrieve and use process context information in addition to process definition and instance information.2.3 User Authorizations for SAP Business Workflow PUBLIC © 2014 SAP SE or an SAP affiliate company. Choose Continue . perform the following substeps: 1. 4. 4. Select the entry with technical service name /IWPGW/PGW . Click the Register Context Service for Process Definition activity icon. Save your settings.4.3. 1. 2. enter ZPGW_0001 .2. Procedure 1. 6. Prerequisites You have created the system alias for the SAP Business Suite system. 1. Select the ZPGW service. Choose Yes for the confirmation message. 11. In the Package field. perform the following substeps: 1. 1.4. 9. Identifier field. In transaction SPRO open the SAP Reference IMG and navigate to SAP NetWeaver 3.2. 3. 8. Expand the Process Context Service node.6 Registering Process Context Service for Deployment Scenario 2 You use this procedure to register the process context service for an SAP Business Suite system. 5. 3 User Authorizations for SAP Business Workflow Systems To access the process details from an SAP Business Workflow system. Authorization Object: PLOG Authorization Field Value PPFCODE DISP PLVAR dummy OTYPE WS INFOTYP 1000 SUBTYP dummy ISTAT 1 1. 4. enter TaskFacade . see Deployment Options. 8. Choose Single Service Configuration . 10. select External Name . In the Configuration for Logical Port section. you require SAP NetWeaver 7. 16.01. In the Details of Proxy Definition section.3 Configuring the Task Gateway Service The Task Gateway service provides an access point for consumer applications to different tasks using SAP Gateway. Developer. select the SAP Authentication Assertion Ticket radio button. 22. you must create a logical port to it before installing the Task Gateway service. 17. Choose Go . Prerequisites If you have an SAP NetWeaver Business Process Management (BPM) system. 15. 7. Activating the Service Activating the service consists of two main steps: 1. Select the Consumer Security tab. For more information. enter the relevant port number. The SOA Management popup is displayed.3. 6.1. Installing the Service To use the Task Gateway service: If your system landscape is based on SAP NetWeaver 7. you must install the component IW_PGW. Choose Create Logical Port . 11. 12. see the Administration for User Authentication and Single Sign-On (SSO) section. To support the Business Workflow. Under Configuration Type . 21.0. 2. select the consumer proxy. In your SAP Gateway system. From the Field: by drop-down list. select the Configurations tab.1. select the Transport Settings tab. 13. However.2. In the Logical Port Name field. enter a description providing additional information about the connection. see User. In the Computer Name of Access URL field. 5. Choose Apply Settings . In the Search Pattern: field.1. PUBLIC © 2014 SAP SE or an SAP affiliate company. 7. enter the port name. 9. select the Manual Configuration radio button. 18. 7.40 or higher.31. For more information about role templates required for configuration.4. and Administrator Authorizations. Select the Service Administration tab. it contains the core SAP Gateway component SAP_GWFND as standard and as such you do not need to install IW_BEP in your SAP Gateway system. Under the Authentication Settings section. Page 53 of 95 . you must first install the components IW_PGW and IW_BEP in your SAP Gateway system. 7.3. enter the computer's name. Note For more information about SSO (Single Sign On).31 SP05 or higher. In the Search Results table. Choose Apply Selection . To create a logical port: 1. If your system landscape is based on SAP NetWeaver 7. 20. Save the changes. enter TaskFacadeService/TaskFacade .03 or 7. From the Search by: by drop-down list. Setting up the service in the SAP Gateway system: Create a system alias.02. This OData service allows different task providers to expose tasks within one harmonized view. In the Port Number of Access URL field. All rights reserved. a user must have the authorizations listed below.4. 19. To integrate BPM. 3. you must also install the component IW_BEP in your SAP Business Suite system. select Consumer Proxy . 14. In the Description field. In the URL Access Path field. open transaction SOAMANAGER. 7. Choose New Entries . Under the System Aliases section. 3. repeat steps 5 to 7. Under Type . 6. /IWPGW/BWF or/IWPGW/BPM (for a BPM system). open transaction SPRO. Select SAP Customizing Implementation Guide 4. For Local App . Select SAP Customizing Implementation Guide SAP NetWeaver SAP Gateway OData Channel Configuration Connection Settings SAP Gateway to SAP System . enter a description for the system alias. 4. To create a system alias: 1. 6. All rights reserved. 10. make sure the checkbox is not selected. The Activate and Maintain Services page is displayed. To add additional system aliases: 1. search for TASKPROCESSING in the External Service Name column and select the entire line. Under Under Under Under Description . Open the Manage SAP System Aliases activity. 11. 7. Choose Save. Note If you have an SAP NetWeaver BPM system. 13. In the SAP Gateway system. 4. 2. Choose Save. enter the following: Under SAP System Alias . Choose SAP Reference IMG . Open the Activate and Maintain Services activity. Choose the checkmark. 2. Select SAP Customizing Implementation Guide SAP NetWeaver SAP Gateway OData Channel OData Channel Development with IW_BEP Registration . Under the ICF Nodes section. set WS Provider System as the RFC Destination. Choose Add New Service . Under Description . 3. In the System Alias field. For more information. GWQ_800_BEP. Page 54 of 95 . make sure the ODATA node status is set to Active . enter the following: Under Model Identifier . enter /IWFND/CL_MGW_RUNT_RCLNT_PRXY. for example. enter enter the technical name you obtained in the previous step (To activate the service). 2.Activate the service. Choose Save. Press Enter . 8. Open the Activate and Maintain Services activity. 5. 5. Under Software Version . Choose SAP Reference IMG . select the checkbox. the checkbox does not need to be selected. you will need it to assign the software version to the service. 8. enter the trusted RFC destination to the SAP system. In the SAP System Alias field. Local SAP GW . Assign the software version to the service. press F4 and select the relevant data provider (software version). Create a new system alias as described in the procedure above. For example. Under Class/Interface . PUBLIC © 2014 SAP SE or an SAP affiliate company. In the Assign Data Provider to Data Model table. make sure the system alias we activated is displayed. 6. Choose SAP Reference IMG . press F4 and select the System Alias you have created. From the Technical Service Name column. 5. Copy the name that appears in the Technical Model Name field. 2. Choose New Entries . The Add Service table is populated. Open the Assign Data Provider to Data Model activity. see the Multiple Origin Composition section. In the Default System field. 9. 8. In the SAP Gateway system. The Add Service page is displayed. enter a description of the data model. 5. <model identifier name>_0001_BE . The Activate and Maintain Services page is displayed. 3. 3. In the SAP Gateway system. open transaction SPRO. The service uses the multi-origin composition (MOC) component. To create additional system aliases for other providers like BPM repeat steps 5 to 7. 12. Select an existing SAP system alias and choose Copy. In the Manage SAP System Aliases table. The Add Service page is displayed. 7. 11. Under Software Version . 8. To create additional software versions. Choose ( Copy ). 2. ( Add New Service ). To assign the software version to the service: 1. Under Model Name . SAP NetWeaver SAP Gateway OData Channel Development with IW_BEP Registration . For example. press F4 and select the relevant software version for example /IWPGW/BPM or /IWPGW/BWF. the corresponding SAP system will be called by default. 12. In the System Aliases section. 4. 9. enter the technical name you obtained in the previous step (To activate the service) followed by _0001_BE . press F4 and select the system alias you created in the procedure above. In the SAP Gateway system. double-click /IWPGW/TASKPROCESSING. enter the package to which you want to assign the service. In the Service Catalog table. choose ( Add System Alias ). The Change View “Assign SAP System Aliases to OData Service”: Overview page is displayed. open transaction SPRO. Connecting the service to the SAP Business Suite backend system where you want to have the SAP Gateway information displayed: Add additional system aliases. Select SAP Customizing Implementation Guide SAP NetWeaver SAP Gateway OData Channel Development with IW_BEP Registration . RFC Destination . In the Package field. select (Adaptation) Data Provider from the drop-down list. enter the new system alias. To activate the service: 1. If the checkbox is selected. 7. 6. 10. open transaction SPRO. The Change View “Assign Data Provider to Data Model”: Overview page is displayed. Choose SAP Reference IMG . The Change View “Manage SAP System Aliases”: Overview page is displayed. enter $TMP as the package name and the service will be created locally. The Add Service screen is displayed. Choose New Entries .4. SAP Customizing Implementation Guide SAP NetWeaver SAP Gateway 4. Local SAP GW . Note If your system is based on SAP NetWeaver 7. 9.3. If you do not want the service to be transported. . enter the system alias. RFC Destination . Choose Add New Service . 5. In the System Alias field. 12. for example. PUBLIC © 2014 SAP SE or an SAP affiliate company. In the ICF Nodes section. 8. Choose SAP Reference IMG . Choose SAP Reference IMG . Choose the checkmark. 3. All rights reserved. For Local App . you must maintain the authorization object S_SERVICE with the object types IWSG and IWSV. Note If you want to create a system alias for an SAP Business Process Management (BPM) system. Select SAP NetWeaver SAP Gateway Service Enablement Content Task Gateway Service Registration Open the Provider Implementation activity and follow the instructions described in the activity's documentation. Select the Activate and Maintain Services activity. Copy (or make note of) the name that is displayed in the Technical Model Name field. 2. Page 55 of 95 . 6. 1. start transaction SPRO.4. Choose SAP Customizing Implementation Guide SAP NetWeaver Gateway OData Channel Configuration Connection Settings Gateway to SAP System . Press Enter . The Add Service screen is displayed. ensure the ODATA node status is set to Active .40 or higher. enter a description for the system alias. such as Business Workflow and BPM. Under Under Under Under SAP Description .Note For the role template /IWPGW/RT_WF_USR. choose OData Channel Administration General Settings . proceed as follows: 1. 11. set WS Provider Systems (enter the logical port you maintained in SOAMANAGER) and leave the RFC destination empty. In the Manage SAP System Aliases table. Choose Save . Choose SAP Reference IMG . 1. use input help ( F4 ) and select the relevant data provider (software version). enter the trusted RFC destination to the SAP system. 4. 10. Once your service is activated you can navigate to the Task collection to get all your inbox tasks from the implemented providers. BEP. For more information. you must add it manually. The Change View "Manage SAP System Aliases" Overview screen is displayed. Select the Manage SAP System Aliases activity. For example: http://<Server>:<Port>/sap/opu/odata/IWPGW/TASKPROCESSING. In your SAP Gateway system. 7. If you require an additional provider. In the System Aliases section. use input help ( F4 ) and select the system alias you have created.3. ensure that this checkbox is not selected. The Add Service table is populated. 13. 2. enter the following: Under SAP System Alias . open transaction SPRO. seeRoles in the SAP Gateway Landscape.1. Note To create additional system aliases for other providers such as SAP Business Workflow Management (BWF) or SAP Business Process Management (BPM). The Activate and Maintain Service screen is displayed. section Assignment of Authorization Objects. 5. enter the package to which you want to assign the service for transportation from one system to another. 7. 3. In the SAP Gateway system. 4. for example. Choose SAP Customizing Implementation Guide SAP NetWeaver Gateway OData Channel Administration General Settings . 6.3. 3.2 Activating Task Gateway Service To activate the Task Gateway service. and one for BPM.1 Creating a System Alias To create a system alias for the Task Gateway service. In the Technical Service Name column.1. You need this to assign the software version to the service. ensure that the correct system alias is displayed. double-click /IWPGW/TASKPROCESSING.mo/TaskCollection Adding New Providers Task SAP Gateway service has two providers out-of-the-box: a provider for SAP Business Workflow. 2. To add a new provider: 1. select the checkbox. proceed as follows: 1. start transaction SPRO. In the SAP Gateway system. /IWPGW/BWF for an SAP Business Worfklow (BWF) system or /IWPGW/BPM for an SAP Business Process Management system.3. In the Package field. repeat steps 5-7. Under Software Version . enter the technical model name defined when you activated the service followed by _0001_BE . choose OData Channel Administration General Settings . Different backend systems are supported. Under Model Name . <model identifier name>_0001_BE .3. Choose Save .40 or higher. Note To create additional software versions.1. Create a new system alias. Choose SAP Reference IMG . Note If your system is based on SAP NetWeaver 7. see Assigning SAP System Alias to OData Service . use input help ( F4 ) and select the System Alias you have created.1. 7. Choose Enter . Select the Assign Data Provider to Data Model activity. 2. 10. In the SAP Gateway system.v=<version>/TaskCollection 1. All rights reserved. By adding additional system aliases and assigning these to the service. if you specify corresponding roles/host names and system aliases. Example http://<Server>:<Port>/sap/opu/odata/IWPGW/TASKPROCESSING. 2. /IWPGW/BWF or /IWPGW/BPM. open transaction SPRO. start transaction SPRO. In the SAP Gateway system. In the SAP System Alias field. Select an existing SAP system alias and choose Copy .3.mo. Choose SAP Reference IMG . SAP Customizing Implementation Guide SAP NetWeaver SAP Gateway 5. If you leave the User Role or the Host Name field empty. The SAP system alias can have a specific role or a specific host name associated to itself. In the System Aliases section.4 Adding Additional System Aliases You can add additional SAP system aliases and assign these to the TASKPROCESSING OData service. you will need to repeat these steps to ensure that the relevant software version is assigned. 1. Note If your system is based on SAP NetWeaver 7.Result After you have activated the service. 3. For example. proceed as follows: 1. 11. the checkbox does not need to be selected. In the Default System field. enter a description for the data model. To add additional system aliases. choose OData Channel Administration General Settings . data requests from an SAP Gateway consumer can be routed to the corresponding backend system. the corresponding SAP system is called by default. Select the Activate and Maintain Services activity. 6. SAP Customizing Implementation Guide SAP NetWeaver SAP Gateway 4. 4.4.4. 9. proceed as follows: 1. More Information For information about how to activate a service. Page 56 of 95 . select (Adaption) Data Provider from the drop-down list. you can navigate to the Task collection to get all your inbox tasks from the implemented providers such as SAP Business Workflow and SAP Business Process Management (BPM).3. the setting is valid for all roles/host names.3 Assigning a Software Version to Service To assign a software version to the service. The roles are only for user grouping and do not need to have any special authorization. Under Class/Interface . see Activating a Service. for example. 5. The Change View "Assign Data Provider to Data Model: Overview" screen is displayed. In the Service Catalog table. enter /IWFND/CL_MGW_RUNT_RCLNT_PRXY. enter the technical name specified when you activated the service. repeat steps 5 to 7. For more information. The Change View "Assign SAP System Aliases to OData Service" Overview screen is displayed. 3. enter the following: Under Model Identifier . The Activate and Maintain Service screen is displayed. Under Software Version . 12. PUBLIC © 2014 SAP SE or an SAP affiliate company. so that you can specify different roles or host names for the same system alias. In the Assign Data Provider to Data Model table. 8. Under Type . The software version dictates the provider that is to be called. 6. Choose Save . Choose SAP Customizing Implementation Guide SAP NetWeaver Gateway OData Channel Administration General Settings . Under Description . If the checkbox is selected. search for TASKPROCESSING in the External Service Name column and select the entire row. choose Add System Alias . For each system in your system landscape that is to be used with Task Gateway. 7. Choose New Entries . use input help ( F4 ) and select the relevant software version.40 or higher. Choose SAP Customizing Implementation Guide SAP NetWeaver Gateway OData Channel Administration General Settings .3. 3. you can choose between embedded deployment or central hub deployment. for example. you should enable the user list function. choose Gateway Service . it is necessary to enter the specific name for substitutes. Select the Provider Implementation activity.3. Choose SAP Reference IMG .4 Former Development In this section. the user list is disabled and consequently no input help containing user names is available for Task Gateway. you must add it manually. Select the Is User List Enabled column. proceed as follows: 1. Page 57 of 95 . 1.4. To enable the user list for selection purposes for Task Gateway. 1. you are strongly recommended to use the Service Builder (transaction SEGW) for your OData design-time development .1. you can decide whether or not to enable the user list in the Task Gateway Service Settings section of the SAP Customizing Implementation Guide (transaction SPRO).5 Adding New Providers The Task Gateway service has two providers out-of-the-box. If the Is User List Enabled column is not selected. 3. the user list is enabled and consequently a list of all users in the SAP Gateway system is available for selection in the input help for Task Gateway. start transaction SPRO. . for example. Recommendation We strongly recommend using the OData Channel (ODC) programming paradigm for all SAP Gateway development. 5.4. Choose SAP NetWeaver SAP Gateway Service Enablement Content Task Gateway Service Registration 4. In the SAP Customizing Implementation Guide. In your SAP Gateway system. 7. you can find information about former development and programming paradigms. As of SAP Gateway 2. see SAP Gateway Service Builder. Follow the instructions provided in the activity's documentation.3. 1. 4. All rights reserved. Consequently. see Creating a System Alias. This section comprises the following information: OData Channel without IW_BEP Configurations for ERP on SAP Gateway Code List SOA Management Configurations on SAP ERP System SOA Management Configurations on the SAP Gateway Syste Generic Channel Generic Channel Configuration Code List Configuration Settings for Generic Channel Scenarios PUBLIC © 2014 SAP SE or an SAP affiliate company.4. Depending on whether you want to develop SAP Gateway content in an SAP Business Suite backend system or in an SAP Gateway hub system.0 Support Package 05.3. Choose SAP Reference IMG . see Embedded Versus Hub Deployment and Deployment Options.3.More Information For information about how to create a new system alias. SAP NetWeaver SAP Gateway Service Enablement Content Task Gateway Task Result If the Is User List Enabled column is selected.1. 2. proceed as follows: 1. start transaction SPRO. Choose Edit . If you want a list of existing users in the SAP Gateway system to be provided as an input help to facilitate the selection of appropriate users to whom tasks can be forwarded or you can define as substitutes. 2. If you require an additional task provider. For more information. In your SAP Gateway system. Choose Save .6 Enabling User List for Task Gateway Service When you set up the Task Gateway Service. Open the Task Gateway Service Settings activity. 6. one for SAP Business Workflow and one for SAP NetWeaver Business Process Management. For more information. To add a new provider. SAP ERP Scenarios Configuration Settings Employee Configurations on SAP Gateway for SAP Following BAPIs are used: ERP BAPI_EMPLOYEE_GETDATA Types of Services used BAPI_HELPVALUES_GET BAPI_ADDRESSEMPGETDETAILED LIST Material Configurations on SAP Gateway for SAP Following BAPIs are used: ERP BAPI_MATERIAL_GETLIST Supported Releases SAP ERP 2004 and higher Note The software requirements for few of the Employee functions supported differ. See Employee for more information. All rights reserved.1. Page 58 of 95 .4. SAP ERP 2004 and higher BAPI_MATERIAL_GET_ALL BAPI_HELPVALUES_GET Bill Of Material (BOM) Configurations on SAP Gateway for SAP Following BAPIs are used: ERP CSEP_MAT_BOM_SELECT SAP ERP 2004 and higher BAPI_MATERIAL_GETLIST C1L3_READ_T416 BAPI_HELPVALUES_GET CSEP_MAT_BOM_READ ERP Document Configurations on SAP Gateway for SAP Following BAPIs are used: ERP BAPI_DOCUMENT_GETLIST SAP ERP 2004 and higher BAPI_HELPVALUES_GET BAPI_DOCUMENT_GETDETAIL2 CVAPI_DOC_CHECKIN Sales Documents (Inquiry and Configurations on SAP Gateway for SAP The following BAPIs are used: Quotation) ERP BAPI_SALESORDER_GETLIST BAPISDORDER_GETDETAILEDLIS T ERP Customer Configurations on SAP Gateway for SAP The following BAPIs are used ERP BAPI_CUSTOMER_FIND BAPI_CUSTOMER_GETLIST BAPI_ADDRESSORG_GETDETAIL BAPI_ADDRESSORG_CHANGE SAP ERP 2004 and higher Note See ERP Sales Document for supported operations and the versions SAP ERP 2004 and higher Note See ERP Customer for supported operations and the versions BAPI_CUSTOMER_GETDETAIL2 BAPI_BUSPARTNEREMPLOYE_GET LIST The following ESA Services are used: CustomerERPBasicDataByIDQu eryResponse_In_V2 CustomerBasicDataChangeReq uestConfirmation_In CustomerERPBankDetailsByID QueryResponse_In CustomerERPBankDetailsUpda teRequestConfirmation_In CustomerERPRelationshipCon tactPersonByIDAndContactPe rsonInternalIDQueryRespons e_In) CustomerERPRelationshipCon tactPersonCreateRequestCon firmation_In CustomerERPRelationshipCon tactPersonUpdateRequestCon firmation_In_V1 CustomerERPRelationshipCon tactPersonCancelRequestCon firmation_In Time Management Configurations for Time Management The following ESA services are used: SAP ERP 2004 and higher EmployeeTimeForEmployeeTim eSheetByElementsQueryRespo nse_In EmployeeTimeSheetChangeReq uestConfirmation_In PUBLIC © 2014 SAP SE or an SAP affiliate company.4.1 Configurations for ERP on SAP Gateway This section provides an overview of the SAP ERP scenarios with the services used and the supported releases. Open transaction pfcg in the SAP Gateway system. 2.1. All rights reserved. proceed as follows: 1.1 Role Templates for ERP Scenarios Creating Role Templates You must create roles for SAP ERP scenarios and assign these roles to the ERP GSDO group. If there is only one SAP ERP system and all the users on SAP Gateway should be able to access ERP functionality on this SAP ERP system then role creation and assigning of roles to GSDO groups is optional but this is not recommended. 7. Page 59 of 95 . 8. You must be an SAP Gateway administrator or have an SAP user administrator to create the roles. 3. Choose Generate to create a new role. Enter a name for the role in the Role field. 3. For this: 1. Choose the template mentioned in the Role Templates section. 2. see Changing Standard Roles. Choose the Authorization tab. 3. 6. Choose Change Authorization . To create roles. The SAP Gateway ERP users should be assigned to these roles so that they can use SAP Gateway services. For information on changing roles. 2.4.4. 5. 4. Choose Single Role . For each of these systems. Create system alias for each of these systems. Identify the list of SAP ERP systems on which the functionality should be accessible by SAP Gateway. The roles must be defined/created on the SAP Gateway server. define a role for which the administrator should assign the list of users (who has access to execute the functionality) Note 1.EmployeeTimeSheetAllowedWo rkBreakDownStructureElemen tByEmployeeQueryResponse_I n EmployeeTimeSheetAllowedRe ceivingCostCentreByEmploye eQueryResponse_In EmployeeTimeSheetAllowedOr derByEmployeeQueryResponse _In EmployeeTimeSheetAllowedRe sourceClassByEmployeeQuery Response_In WorkAgreementSimpleByEleme ntsQueryResponse_In 1. Save the Role . Role Templates Use the predefined role templates mentioned in the table below to create user roles for SAP ERP scenarios: Template Name Template For /IWCNT/RT_USER_EMP Employee /IWCNT/RT_USER_MTL Material /IWCNT/RT_USER_BOM Bill of Material /IWCNT/RT_USER_DOC ERP Document /IWCNT/RT_USER_QUOT Sales Document (Inquiry and Quotation) /IWCNT/RT_USER_CUST ERP Customer /IWCNT/RT_USER_TIMA Time Management Authorizations The user must have the following authorizations to access SAP Gateway system for SAP ERP scenarios: SAP ERP Scenario Service Employee /IWCNT/SG_EMPLOYEE_0001 Authorization Object S_SERVICE Authorization Values SRV_NAME— 754650500996EDE0D42ED48806D730 SRV_TYPE — HT Material /IWCNT/SG_MATERIAL_0001 S_CODE TCD — SICF S_SERVICE SRV_NAMEDB44022B5B569F5B9219500599D4E7 SRV_TYPE-HT PUBLIC © 2014 SAP SE or an SAP affiliate company. BUS1001 and BUS1001006/ACTVT=16 Bill of Material (BOM) S_RFC RFC_TYPE=FUGR/RFC_NAME=SU_ USER.CVAPI01 and BAPT/ACTVT=16 S_TCODE TCD = CV02N and CV03N TCD = CV01N and CV02N Sales Documents (Inquiry and Quotation) S_RFC ERP Customer S_RFC RFC_TYPE=FUGR/RFC_NAME=203 2/ACTVT=16 RFC_TYPE=FUGR/RFC_NAME=LC0 1/ACTVT=16 RFC_TYPE=FUGR/RFC_NAME=SZA K/ACTVT=16 RFC_TYPE=FUGR/RFC_NAME=BAP T/ACTVT=16 RFC_TYPE=FUGR/RFC_NAME=101 1/ACTVT=16 RFC_TYPE=FUGR/RFC_NAME=SZA M/ACTVT=16 RFC_TYPE=FUGR/RFC_NAME=SZA L/ACTVT=16 PUBLIC © 2014 SAP SE or an SAP affiliate company. 56B1795EE40F0F7302DE059E7586FA SRV_TYPE-HT S_CODE TCD-SICF While creating role template in the SAP ERP system. include the authorizations provided in the table below. Page 60 of 95 .BUS1001 and C1L6/ACTVT=16 ERP Document S_RFC RFC_TYPE=FUGR/RFC_NAME=CVB API and CVAPI01/ACTVT=16 RFC_TYPE=FUGR/RFC_NAME=CVB API and BAPT/ACTVT=16 RFC_TYPE=FUGR/RFC_NAME=CVB API.CSEP.Bill of Material (BOM) /IWCNT/SG_BOM_0001 S_CODE TCD-SICF S_SERVICE SRV_NAMEF235FE5EF7ED50DAE3B3F23CC1CA0E SRV_TYPE-HT ERP Document /IWCNT/SG_DOCUMENT_0001 S_CODE TCD-SICF S_SERVICE SRV_NAMEC2A96D9A6E6802A945D6E8904E190A SRV_TYPE-HT Sales Document (Inquiry and Quotation) /IWCNT/SG_ERPSALES_0001 S_CODE TCD-SICF S_SERVICE SRV NAME — E216D44A584CA3D8B8A6313AD0A6B0 SRV_TYPE-HT ERP Customer /IWCNT/SG_CUSTOMER_0001 S_CODE TCD-SICF S_SERVICE SRV NAME-0C3ED4D55DD9C87D1290E95581DA8D SRV_TYPE-HT Time Management /IWCNT/EMPLOYEETIMESHEET_0001 S_CODE TCD-SICF S_SERVICE SRV_NAME– 15DA80503D25C5D856CB6072DC9598. The user must have these authorizations to access SAP ERP system for SAP ERP scenarios: SAP ERP Scenario Employee Service Authorization Object S_RFC Authorization Values RFC_TYPE=FUGR/RFC_NAME=RH6 5/ ACTVT=16 RFC_TYPE=FUGR/RFC_NAME=BFH V/ ACTVT=16 RFC_TYPE=FUGR/RFC_NAME=PAD _ESA_SERVICES/ ACTVT=16 RFC_TYPE=FUGR/RFC_NAME=HRW PC_EMPLOYEEPROFILE_45FF/ ACTVT=16 Material S_RFC RFC_TYPE=FUGR/RFC_NAME=BFH V. All rights reserved. In transaction SPRO open the SAP Reference IMG and navigate to: Connection Settings SAP Gateway to SAP System 2. Description RFC Destination Enter a name for the RFC destination.1. All rights reserved. BKDCNT200 . Manage RFC Destinations 1. Creating Role Templates See the section Role Templates for ERP Scenarios for information on creating role templates for all the SAP ERP scenarios supported by SAP Gateway. Software Version Enter Default . BKDCNT200 Connection type Choose the option. RFC Destination Specify the RFC destination defined for your SAP system. Save your settings. Former Development OData Channel and click the Activity icon. Local SAP GW Leave unchecked if the SAP ERP system is not on the same system as the SAP Gateway system. Description SAP System Alias Name of the system alias. Page 61 of 95 . WS Provider Leave it blank. Description Descriptive text for the system alias. Enter the following details for the system alias: SAP NetWeaver Manage SAP System Aliases Field SAP Gateway OData Channel Configuration and click the Activity icon. for example. Assign SAP System Aliases to OData Service 1. Example.ESA (EhP4 and above) RFC_TYPE=FUGR/RFC_NAME=203 2/ACTVT=16 ECC_CUSTBASICDATABYIDQR_V2 SRV Name — S_SERVICE 228A5E185E0CFF7B36C96C854BD1C7 SRV Type — HS Time Management ECC_WORKAGSIMPLERELEMENTSQR S_TCODE TCD=XD03 S_SERVICE SRV Name– 583824D652C5AF040CDB5E6A3938C8 SRV Type — HS ECC_EMPTIMFEMPTIMSHEETELEQR SRV Name — S_SERVICE C0972E83D4383710F9FD8B8FB78280 SRV Type – HS ECC_EMPTIMSHEETCHGRC SRV Name — S_SERVICE E564B11456D8E712E179A6EF4CBFC4 SRV Type — HS Continue with Managing RFC Destinations 1. 4.4. 3 (Connection to ABAP System) Description RFC destination for SAP system Manage SAP System Aliases 1. In transaction SPRO open the SAP Reference IMG and navigate to: Connection Settings SAP Gateway to SAP System 2.4. 3. In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver SAP Gateway Development without IW_BEP Registration Assign SAP System Aliases to OData Service 2. Choose the option with service document identifier (check the table below) and select Copy as: SAP ERP Element Service Document Identifier Employee /IWCNT/SG_EMPLOYEE_0001 Material /IWCNT/SG_MATERIAL_0001 Bill of Material (BOM) /IWCNT/SG_BOM_0001 ERP Document /IWCNT/SG_DOCUMENT_0001 Sales Documents /IWCNT/SG_ERPSALES_0001 PUBLIC © 2014 SAP SE or an SAP affiliate company.2 Configurations on SAP Gateway for SAP ERP This section provides information on the general configurations to be carried out on the SAP Gateway system. Choose Create and enter the following values: SAP NetWeaver Manage RFC Destinations Field SAP Gateway OData Channel Configuration and click the Activity icon. Choose New Entries . Example.OData Channel Configurations on the SAP ERP System (Provider System) for Time Management . under Virtual Host/Services section. Prerequisites Configurations for Time Management Configurations on SAP Gateway . select the last node and right click. Server) Description RFC destination for SAP system Manage SAP System Aliases 1. Choose Execute . SAP ERP SAP ERP Central Component (Open the documentation) Resources Choose Personnel Time Management . 2.4.OData Channel Time Management application enables you to perform time recording functions while away from your desk in any device or platform.1. BKDCNT200. Choose New Entries . In the Service Name field. see SAP Library for SAP ERP on SAP Help Portal at http://help. In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver SAP Gateway OData Channel Connection Settings SAP Gateway to SAP System Manage SAP System Aliases and click the Activity icon. Expand SAP ERP Central Component Expand Human 1.3. Go to transaction SICF.4.1 Configurations on the SAP Gateway for Time Management .4. Local SAP GW Leave unchecked if the SAP ERP system is not on the same system as the SAP Gateway system. 2. Description Descriptive text for the system alias.1. All rights reserved. Choose the option Activate Service . 3.OData Channel Reference For more information. Description RFC Destination Enter a name for the RFC destination. In SAP Portal. enter: SAP ERP Element Service Name Employee Employee Material Material Bill of Material (BOM) Billofmaterial ERP Document Document Sales Documents ERPSALES Customer CUSTOMER 3. In transaction SPRO open the SAP Reference IMG and navigate to: Connection Settings SAP Gateway to SAP System 2. RFC Destination Specify the RFC destination defined for your SAP system. for example. Choose Create and enter the following values: Field SAP NetWeaver Manage RFC Destinations SAP Gateway OData Channel Configuration and click the Activity icon. 4.com/erp. Page 62 of 95 .OData Channel Manage RFC Destinations 1. 5. CONNECT_ TO_BACKEND Connection type G (HTTP Connection to Ext.3 Settings for Time Management Application .Customer /IWCNT/SG_CUSTOMER_0001 Activating the Service 1. 1.sap.4.OData Channel Configurations on the SAP Gateway System (Consumer System) for Time Management . Enter the following details for the system alias: Field Configuration Description SAP System Alias Name of the system alias. In the Maintain service window. PUBLIC © 2014 SAP SE or an SAP affiliate company. In the Direct selection section. and System user name (0001) in the STy (Subtype) field.OData Channel 1. under Virtuelle Hosts/Services section. When you are configuring the Consumer system for the first time (either for Leave Management. Configurations on the SAP ERP System (Provider System) for Time Management .OData Channel 1. This is the WSIL URL. Obtaining WSIL URL 1. Open transaction PA30. Activating the Service 1. Continue with. once you configure the Consumer system for any one of the applications (either Leave Management. enter EMPLOYEETIME . Verifying the endpoints created 4. Time Management or Codelist) you must perform all the steps provided in the procedure below. Choose the Personnel number . 4. Time Management. 2. Choose the option with service document identifier /IWCNT/SG_TIME_RECORDING_ODC_0001 and select Copy as. You have now assigned the SAP User ID to a Personnel number. Choose the option Activate Service . Assign SAP System Aliases to OData Service 1. 2. Choose Execute .4. But.OData Channel Note SAP ERP system is also called as Provider system in this section. In the Maintain service window. select the last node and right click. 5. 6. 4. Enter WSIL for the Service Name . 3. In the Service Name field. open transaction sicf. Obtaining the external key of the provider system. Choose WSIL folder and right click and select Test Service . To configure the provider system: 1. Choose Execute . 2. Software Version Enter Default . Importing a profile using an XML template or Creating a profile 2. You can either import a profile using an XML template or create a profile. choose Communication (0105) in the Infotype field.4. In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver SAP Gateway Former Development OData Channel Development without IW_BEP Registration Assign SAP System Aliases to OData Service and click the Activity icon.. 5. Configurations on the SAP Gateway System (Consumer System) for Time Management . copy the URL from this browser. Page 63 of 95 . In the Communication section.WS Provider Leave it blank.4. All rights reserved. Import endpoints using a Business Scenario Configuration XML or Creating endpoints using a Business Scenario 3. Click the Change icon or press F6 from the key board to view the Change Communication page. Logon to the provider system. A browser window opens. 3.3 Configurations on the SAP Gateway System (Consumer System) for Leave Management Note SAP Gateway system is also called as Consumer system in this section.. enter the SAP user ID in the ID/number field.4. Enter SERVICE for the Hierarchy Type . Note The WSIL (Web Service Inspection Language) service lists the configuration of all web services exposed by the system. Assigning personnel number for an employee: To assign an SAP User ID to a Personnel Number proceed as follows: 1. 4.3. 5. 6. 4. 3.2 Configurations on the SAP ERP System (Provider System) for Time Management . Go to transaction SICF.3. Save your settings.1. 6. 2. or Codelist) you can ignore the following steps when configuring the system for the rest of the applications: Importing a profile file Creating a system connection to the Provider system User account management Assigning system aliases PUBLIC © 2014 SAP SE or an SAP affiliate company. 5.1. On the Provider system. Continue with. Importing a Profile file — Import the Profile created in the Provider system. Select the System Alias and click Assign User Roles: User Roles can be defined here.4. Select the GSDO Type and click Assign SAP System Alias : User Role: A specific User Role can be maintained which is checked to link to the designated system. 1. 8. All rights reserved.OData Channel The ERP Customer service assists you to view the details of the Customer. 5. Generic and click the Activity icon. Note Only RFC destinations of connection type 3 (Connection to ABAP System) can be used. SAP NetWeaver SAP Gateway Former Development Channel Configuration Connection Settings SAP Gateway to SAP System Manage RFC Destinations Create a New RFC connection by specifying the RFC Destination and Connection Type . In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver SAP Gateway Former Development Generic Channel Administration General Settings Manage GSDO Groups and click the Activity icon. SAP System Alias: Add the Provider System's name. Execute the Manage System Aliases IMG Activity. 3. User account management 4. like the address of the customer and their communication and bank details.4 Configurations for ERP Customer. Importing a business scenario Configuration XML or Configuring service groups using business scenarios/ — You can either manually configure service groups using a business scenario or import a business scenario configuration XML. 1. Note You must import the same profile created in the provider system. 5. Creating a system connection to the Provider system 3. Assigning system aliases: 1. Choose Assign GSDOs . Page 64 of 95 . 2.1. the following configurations should be completed: Configurations for ERP Customer on the SAP Gateway Sys Configurations for ERP Customer on the SAP ERP System (Provider) Configurations for ERP Customer on the SAP Gateway System— OData Channel This section provides the configuration steps to be completed in the SAP Gateway system before using the Customer service. Enter the Provider system's name for the system alias.Configuring destination finder Configurations on the consumer system include: 1. In transaction SPRO. Create a new System Alias by selecting the New Entries button. Blank: Refers to All Roles . Managing RFC Destinations 1. CONNECT_ TO_BACKEND Connection type G (HTTP Connection to Ext. 4. 6. Prerequisites Before using the Customer service. 7. 3. Provide the created RFC connection. Field Description RFC Destination Enter a name for the RFC destination. In transaction SPRO open the SAP Reference IMG and navigate to: 2. 4. Save the settings. Verifying logical ports 6. 7. Example. openthe SAP Reference IMG and navigate to: Connection Settings SAP Gateway to SAP System 2. Choose Create and enter the following values: SAP NetWeaver Manage RFC Destinations SAP Gateway OData Channel Configuration and click the Activity icon. 2. the added GSDO will be present in the list. This activity allows you to define RFC destinations that point to relevant SAP business systems.4. Save the new RFC connection. 9. Configuring Destination Finder: The Provider systems configured from SOA Manager have to be entered in the configuration of the Destination Finder so that during runtime. else mass configuration of web service proxies in the service groups is not possible. If an RFC destination points to an SAP system alias that system alias points to the corresponding SAP business system. Go back to the SAP Gateway to SAP System activity. Server) Description RFC destination for SAP system Managing SAP System Aliases PUBLIC © 2014 SAP SE or an SAP affiliate company. SAP Gateway can select the right provider system for a given system alias. 0 to ECC6. Choose New Entries . Activating the Service 1. 5. Select the SAP Gateway OData Group /IWCNT/SG_CUSTOMER_0001 from the Service Doc Identifier list. open the SAP Reference IMG and navigate to: SAP NetWeaver SAP Gateway Former Development OData Channel Development without IW_BEP Registration Assign SAP System Aliases to OData Service and click the Activity icon. You have now assigned the SAP User ID to a Personnel number. Description SAP System Alias Name of the system alias.sap. Enter SERVICE for the Hierarchy Type . WS Provider Give the Provider system name that is created in the SAP Gateway SOA Manager configurations. Choose Execute . enter CUSTOMER . 2. for example. and System user name (0001) in the STy (Subtype) field.1. 2. Go to transaction SICF. Enter WSIL for the Service Name . Save your settings.com . Assigning SAP System Aliases to OData Service To assign SAP System Aliases to OData Service. select the last node and right click it. Verifying the endpoints created 4. Continue with instructions provided in the Configurations for ERP Customer on the SAP ERP System (Provider) section. Navigate to: SAP NetWeaver SAP Gateway SAP Gateway 2.4. In the Maintain service window. 6. Choose the option Activate Service . Software Version Verify the Software Version to set for your Data Model in the following path: In transaction SPRO. You can either import a profile using an XML template or create a profile. Refer the SOA Manager Configurations documentation at http://help. 5. Choose New Entries 3. On the Provider system. 3. Assigning personnel number for an employee: To assign an SAP User ID to a Personnel Number proceed as follows: 1. In the Service Name field. Logon to the provider system. Obtaining WSIL URL 1. 3. Import endpoints using a Business Scenario Configuration XML or Creating endpoints using a Business Scenario 3. Page 65 of 95 . 3. Description Descriptive text for the system alias. open the SAP Reference IMG and navigate to SAP NetWeaver SAP Gateway OData Channel OData Channel Development without IW_BEP Registration Assign Data Provider to Data Model : and click the Activity icon. 4. 1.0 EhP2 ECC_604 for ERP versions from ECC6. In transaction SPRO. PUBLIC © 2014 SAP SE or an SAP affiliate company. 4. Click the Change icon or press F6 from the key board to view the Change Communication page. Enter the role name created above ZBUSIPARTROLE in the User Role column. Choose the Personnel number . 2. Enter the following details for the System Alias: SAP NetWeaver Manage SAP System Aliases Fields SAP Gateway OData Channel Configuration and click the Activity icon. RFC Destination Specify the RFC destination defined for your SAP system.0 EhP3 4. 3. In transaction SPRO.4. 4. All rights reserved. open transaction sicf. Select your Data Model and verify the Software Version: DEFAULT is for ERP version between ECC 5. 5. choose Communication (0105) in the Infotype field. In the Direct selection section.0 Library SAP Gateway Configuration Guide Configuration Settings for SAP Gateway Supported Applications SOA Management Configurations on the SAP Gateway System Creating a System Connection to Provider System . BKDCNT200.4. 5. Local SAP GW Leave unchecked if the SAP ERP system is not on the same system as the SAP Gateway system.1. under Virtual Hosts/Services section. Save your settings. proceed as follows: 1.2 Configurations for ERP Customer on the SAP ERP System (Provider System) — OData Channel To configure the provider system: 1. 6. 2. enter the SAP user ID in the ID/number field. Importing a profile using a XML template or Creating a profile 2. open the SAP Reference IMG and navigate to: Connection Settings SAP Gateway to SAP System 2. Press F4 to select a system alias in the SAP System Alias column. Open transaction PA30. In the Communication section. Importing a business scenario Configuration XML or Configuring service groups using business scenarios/ — You can either manually configure service groups using a business scenario or import a business scenario configuration XML.1. Creating a system connection to the Provider system 3. System alias for ERP Sales PUBLIC © 2014 SAP SE or an SAP affiliate company. 3. 6. Execute the Manage System Aliases IMG Activity. SAP NetWeaver SAP Gateway OData Channel Configuration Connection Settings SAP Gateway to SAP System Manage RFC Destinations and click the Activity icon. Server) Description RFC destination for SAP system Managing SAP System Aliases 1. that system alias will point to the corresponding SAP business system. Save the new RFC connection. 6.3 Configurations for ERP Customer on the SAP Gateway System (Consumer System)— OData Channel Configurations on the consumer system include: 1. SAP Gateway can select the right provider system for a given system alias. Note You must import the same profile created in the provider system. else mass configuration of web service proxies in the service groups is not possible. Choose WSIL folder and right click and select Test Service .5 Configurations for ERP Sales Documents on the SAP Gateway System— OData Channel This section provides the configuration steps to be completed in the SAP Gateway system before using the Customer service. Configurations for ERP Customer on the SAP Gateway Sys 1. 2. 5. 7. Page 66 of 95 . All rights reserved. 4. Description Descriptive text for the system alias. Save the settings. Enter the Provider system's name for the system alias.4.4. In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver SAP Gateway OData Channel Connection Settings SAP Gateway to SAP System Manage RFC Destinations and click on the Activity icon. Create a New RFC connection by specifying the RFC Destination and Connection Type . 2. Note The WSIL (Web Service Inspection Language) service lists the configuration of all web services exposed by the system.1.4. If an RFC destination points to an SAP system alias. 5. This is the WSIL URL. For example. Go back to the SAP Gateway to SAP System activity.4. 1. Choose Create and enter the following values: Configuration Field Description RFC Destination Enter a name for the RFC destination. User account management 4. copy the URL from this browser. In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver Connection Settings SAP Gateway to SAP System Manage SAP System Aliases 2. A browser window opens. Configuring Destination Finder: The Provider systems configured from SOA Manager have to be entered in the configuration of the Destination Finder so that during runtime. This activity allows you to define RFC destinations that point to relevant SAP business systems. 6. 1. Choose Execute . Configuration Description SAP System Alias Name of the system alias. Note Only RFC destinations of connection type 3 (Connection to ABAP System) can be used. Create a new System Alias by selecting the New Entries button. 3. Choose New Entries . Example. 5. Importing a Profile file — Import the Profile created in the Provider system.4. 9. Verifying logical ports 6. Obtaining the external key of the provider system. In transaction SPRO open the SAP Reference IMG and navigate to: 2. Managing RFC Destinations 1. Provide the created RFC connection. 8. Enter the following details for the System Alias: Fields SAP Gateway OData Channel and click on the Activity icon. Continue with. CONNECT_ TO_BACKEND Connection type G (HTTP Connection to Ext.4. The table below lists the SAP Note details for Time Management. 6. WS Provider Give the Provider system name that is created in the SAP Gateway SOA Manager configurations.zip File Name —profile_IWCNT_1 . More Information Working with the SOA Manager 1. Select the SAP Gateway OData Group /IWCNT/SG_INQUIRY_0001 for ERP Inquiry and /IWCNT/SG_QUOTATION_0001 for ERP Quotation from the Service Doc Identifier list.xml Leave Management 1588250 Folder Name — Leave. Enter the role name created above ZBUSIPARTROLE in the User Role column.0 EhP3 4. enter CUSTOMER .4.2 SOA Management Configurations on SAP ERP System Note SAP ERP System is also called as the Provider System in this section. 3.xml ERP Customer 0001670653 Folder Name —Customer. Save you settings. Assigning SAP System Aliases to OData Service To assign SAP System Aliases to OData Service proceed as follows: 1.zip File Name — profile_IWCNT_1 .4.com .0 to ECC6. 4. 5.2. Page 67 of 95 . select the last node and right click on it.4. Navigate to: SAP NetWeaver SAP Gateway SAP Gateway 2. RFC Destination Specify the RFC destination defined for your SAP system. 4.xml Code List 1588117 Folder Name — Code_List. Leave Management and Code List: Application SAP Note Number Time Management 1584236 File Details Folder Name — Time. Press F4 to select a system alias in the SAP System Alias column.1 Importing a Profile using a XML Template A template file for a Profile is attached to a SAP Note.xml PUBLIC © 2014 SAP SE or an SAP affiliate company. Go to transaction SICF.4. All rights reserved. Choose Execute . Choose New Entries 3. In the Service Name field. 1. This section guides you to import the template file for a Profile.zip File Name — profile_IWCNT_CODELIST_1+.Document Local SAP GW Leave unchecked if the SAP ERP system is not on the same system as the SAP Gateway system.sap.0 EhP2 ECC_604 for ERP versions from ECC6. Refer the SOA Manager Configurations documentation at http://help. for example. 2. Choose the option Activate Service . In the Maintain service window. SOA Management configurations mentioned in this sectionhave to performed in the Provider system. Select your Data Model and verify the Software Version: DEFAULT is for ERP version between ECC 5. 2. Software Version Verify the Software Version to set for your Data Model in the following path: In transaction SPRO open the SAP Reference IMG and navigate to SAP NetWeaver SAP Gateway OData Channel OData Channel Development without IW_BEP Registration Assign Data Provider to Data Model : and click on the Activity icon. Continue with instructions provided in the Configurations for ERP Customer on the SAP ERP System (Providersection. BKDCNT200. In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver SAP Gateway Former Development OData Channel Development without IW_BEP Registration Assign SAP System Aliases to OData Service and click on the Activity icon. Activating the Service 1. under Virtual Hosts/Services section. 5. Save your settings.zip File Name — profile_IWCNT_1.0 Library SAP Gateway Configuration Guide Configuration Settings for SAP Gateway Supported Applications SOA Management Configurations on the SAP Gateway System Creating a System Connection to Provider System . 3. Select the new profile you have created. and choose Export to export it as an XML file.zip 0001670653 File Name —profile_IWCNT_1 . See Importing a Profile using an XML Template section for more information. For web service communications. 4. open transaction SOAMANAGER. On the Provider system. Configure the Security details as follows: Select the SAP Logon Ticket check box Select the Secure Communication Only check box to enable SSL. Activate the Profile. In the SOA Management window. Note After creation of profile you need to logout and logon again into the SOA Management for the new profile to be visible for assignment. Choose New Profile to create a new profile. Enter a Name and Version for the Profile. Note The selected authentication method must support single sign-on. 10. Choose Import . Navigate to Technical Administration tab Profile Management . and then used to configure each web service on the provider and consumer system.4. 4. This may also require trust to be configured between the SAP Gateway and the SAP systems. Navigate to Technical Administration tab Profile Management . 8. Log on to all SAP ERP systems in the landscape. navigate to the SAP Note Assistant to download the template file using the SAP note number provided above. The Profile Activate confirmation window displays.OData Channel 1. 12. Choose Import to complete the import process. Ensure that the Transport binding properties has the following values: Property Value PUBLIC © 2014 SAP SE or an SAP affiliate company. Click Save to save the profile. On the Provider system.ERP Contact Folder Name —Contact. 6. 3. encryption and other settings that are offered by the provider system. go to transaction soamanager. Click Yes to activate the profile. SAP NetWeaver 711 (SAP NetWeaver 710 EHP1) and Higher Releases To create and distribute a new profile proceed as follows: 1. 5. 2. 7. 5. and import this XML file using the Import function. 2. Browse and select the downloaded template file. 4. Enter a Name and Description for the Profile. 5. open transaction SOAMANAGER. More Information Configurations on the SAP Gateway system (Provider system) for: OData Channel Scenarios: Time Management ERP Customer Generic Channel Scenarios: Time Management Leave Management Code List Configurations for ERP Customer. Download the XML file and save it.4. the provider and the consumer uses the same profile so that the consumer system uses the exact authentication. 2.2 Profile Management Profiles are created as part of the general configuration for security and transport aspects. 9. 9. Exit SOA Management and logon again. Creating and Distributing a Profile in SAP NetWeaver 701 (SAP NetWeaver 700 EHP1). 8. Page 68 of 95 . Specify settings for Messaging . 3. Creating and Distributing a Profile in SAP NetWeaver 700 and 710 To create and distribute a new profile proceed as follows: 1. Choose Create to create a new profile. 7. Transport Settings as needed for your company and the landscape. 11. All rights reserved.2. A profile is created once and distributed to all relevant servers in a landscape. Navigate to Technical Configuration tab Profile Management . On the Provider system. Browse for the file in the SOA Management window and Import .xml 1. Open transaction SOAMANAGER. Specify a location to save the file in the Save As window. 6. Code List and ERP Customer: Applications SAP Note Number Time Management 1584236 Leave Management 1588250 File Name Folder Name — Time. 13.xml Folder Name — Leave. 4. Page 69 of 95 . The Profile Activate confirmation window displays. 12.xml ERP Contact 0001670653 Folder Name — Contact. 9.zip File Name — scenario_IWCNT_KNA1.OData Channel 1.zip File Name — scenario_IWCNT_KNA1. Browse and select the downloaded template file. Choose Import to complete the import process.xml ERP Customer 0001670653 Folder Name — Customer. you must create a new version of it.zip File Name — scenario_IWCNT_TIMA_BSC. On the Provider system. Download the XML file and save it. 3.3 Importing Endpoints Template using Business Scenario Configuration This section guides you to import the template file for endpoints using the Business Scenario Configuration function in the SOA Management: 1.4 Creating Endpoints using a Business Scenario PUBLIC © 2014 SAP SE or an SAP affiliate company.zip File Name — scenario_IWCNT_LEMA_BSC.4. 11.ProxyHost proxy ProxyPort 8080 Note If you want to change a profile. This has to be done in all systems in the landscape after the distribution of the new profile version More Information Configurations on the SAP Gateway system (Provider system) for: OData Channel Scenarios: Time Management ERP Customer Generic Channel Scenarios: Time Management Leave Management Code List Configurations for ERP Customer.2. Choose the Provider tab and select all the services. The table below lists the SAP Note details for Time Management. and click Assign to Service . 5. Select the profile that you have created already. All rights reserved. Choose Assign . navigate to the SAP Note Assistant to download the template file using the provided SAP Note number. 14.4. 6. The list of Profiles in your system is displayed below.zip File Name — scenario_CodeList. 10. You must go to the configuration of each provider system and configure it to use the new version of the profile. Choose Save . Open transaction SOAMANAGER. By activating a new version. You are redirected to SOA Configuration Request Queue Management screen. Navigate to Service Administration tab Business Scenario Configuration . 8. the provider systems and all other pieces of configuration that use the profile still use an old version. The Configuration Scenario Details screen displays at the bottom of the screen.4. 7. Choose Import .xml Code List 1588117 Folder Name — Code_List.xml 2. In the SOA Management window. More Information Configurations on the SAP Gateway system (Provider system) for: OData Channel Scenarios: Time Management ERP Customer Generic Channel Scenarios: Time Management Leave Management Code List Configurations for ERP Customer.2.OData Channel 1. You must also activate all dependent objects if required. Leave Management. Click Yes to activate the profile.4. Choose Start request Queue processing to start endpoint creation. If required. which is needed to implement the service. Select Activation Requests Management link Choose Check for Updates button. Response_In The Consumer side has to be configured in the second step.1. 5. ERP Customer ERP Contact EmployeeTimeForEmployeeT EmployeeLeaveRequestCanc QueryCodeList IWCNT/CO_BPC_CUSTOM_CHG_ IWCNT/CO_BPC_CONT_BYID_Q imeSheetByElementsQueryR elRequestConfirmation_In RC_OB R_OB esponse_In WorkAgreementSimpleByEle EmployeeLeaveRequestByID - IWCNT/CO_BPC_CUSTD_BYID_ IWCNT/CO_BPC_CONT_CNC_RC mentsQueryResponse_In QR_OB QueryResponse_In _OB EmployeeTimeSheetChangeR WorkAgreementSimpleByEle - /IWCNT/CO_KNA1_BANK_CHG_ IWCNT/CO_BPC_CONT_CRT_RC equestConfirmation_In RC_OB mentsQueryResponse_In _OB EmployeeTimeSheetAllowed EmployeeLeaveRequestUpda - /IWCNT/CO_KNA1_BANK_READ IWCNT/CO_BPC_CONT_CHG_RC OrderByEmployeeQueryResp teRequestConfirmation_In _QR_OB _OB onse_In EmployeeTimeSheetAllowed EmployeeLeaveRequestByPa WorkBreakDownStructureEl rticipantQueryResponse_I ementByEmployeeQueryResp n onse_In EmployeeTimeSheetAllowed EmployeeLeaveRequestCrea ResourceClassByEmployeeQ teRequestConfirmation_In ueryResponse_In EmployeeTimeSheetAllowed EmployeeLeaveRequestConf ReceivingCostCentreByEmp igurationByEmployeeQuery loyeeQueryResponse_In 7. More Information Configurations on the SAP Gateway system (Provider system) for: OData Channel Scenarios: Time Management ERP Customer Generic Channel Scenarios: Time Management Leave Management Code List Configurations for ERP Customer. Page 70 of 95 . These web services are exposed to the Consumer system by Endpoints . 4. 10. To configure a service provider. Navigate to Service Administration tab Business Scenario Configuration Choose New . The Details of the Service Definition displays at the bottom of the screen. 5.2. Click Next to configure the Provider side . Select the service from the list and click Apply Selection . the endpoints have to be created using a Business Scenario Configuration.4. Click Add to search for each service that is consumed by SAP Gateway. To expose the service for consumption by Consumer system proceed as follows: 1. 2. 3. All endpoints and services are listed here.OData Channel 1. you can log on to other SAP systems and click Export to export the business scenario. 9. All rights reserved. On the Provider system. 6.2. 3.4. PUBLIC © 2014 SAP SE or an SAP affiliate company.4 Creating Endpoints using a Business Scenario The web services called by Consumer system have to be connected using the profile created in the Profile Management section. you need to create and configure an endpoint. On the Provider system.4. 2.4. Navigate to the Configurations tab. Click Back . Choose Check Processing State to trigger and monitor the creation and activation of endpoints. and the Creation Type field is set to Created based on profile. Click Save . To enable mass configuration on the Consumer system. 12. The following services should be added: Time Management Leave Management Codelist . Enter a Name and Description for the Business Scenario. Navigate to Service Administration tab Single Service Configuration . 8. open transaction SOAMANAGER. Search for a service that has been previously added to the Business Scenario.5 Verifying the Endpoints Created To check the endpoints created proceed as follows: 1. The endpoint contains a runtime configuration. 13. open transaction SOAMANAGER. Click Start Activation to activate endpoints. 11. 4. Endpoints are displayed here with a GUID as ID. Activate the Business Scenario. Enter any unique ID.4. See section Verifying the logical ports. To see the WSDL for the endpoint: 1. Select a binding. The actual system that will be used is determined at run time through the destination finder. Choose Show WSDL Options for the selected binding. The table below lists the SAP Note details for Time Management. 2. the applications have proxies that are shipped with the provider system.OData Channel 1. you cannot use mass configuration on the consumer side for the services of that system. Each service group can be configured to point to one or many SAP systems. 3. These proxies are grouped into service groups. Choose Display to view the configurations. Choose Overview .4. Applications running on the consumer system use web services to call the provider systems. Create the logical ports manually. 3.2.6 Obtaining the External Key of the Provider System While creating the Provider system in the Consumer system. This section guides you to import the template file for Profile. 3.4. open transaction SOAMANAGER. All rights reserved. On the Provider system. More Information Configurations on the SAP Gateway system (Provider system) for: OData Channel Scenarios: Time Management ERP Customer Generic Channel Scenarios: Time Management Leave Management Code List Configurations for ERP Customer.3.1 Importing a Profile File When calling a Provider system. Proceed as follows: 1. If this is the case. More Information Working with the SOA Manager 1. Follow the steps listed in this section to obtain the SLD Identifier of the SAP system and make a note of this to provide it when required: 1.4. Therefore. In previous systems this GUID was not available. The activation of the scenario fails. a profile has to be specified. Leave Management and Code List: PUBLIC © 2014 SAP SE or an SAP affiliate company. An external identifier is now generated. and choose Save .4. Proceed with the configuration of the business scenario.6. you have to provide/select the SLD Identifier of the SAP system. This chapter outlines the following SOA Management configuration steps to be performed in the consumer system.3 SOA Management Configurations on the SAP Gateway System Note SAP Gateway system is also called as consumer system in this section. enter an organization name and business system. Page 71 of 95 . More Information Configurations on the SAP Gateway system (Provider system) for: OData Channel Scenarios: Time Management ERP Customer Generic Channel Scenarios: Time Management Leave Management Code List Configurations for ERP Customer.4.OData Channel 1. 2. Use the profile created and distributed in the Creating a Profile section. 2. Navigate to Technical Administration tab Global System Settings . A template file for Profile is attached to an SAP Note. If no external identifier is displayed. More Information Configurations on the SAP Gateway system (Consumer system) for: OData Channel Scenarios: Time Management ERP Consumer Generic Channel Scenarios: Time Management Leave Management Code List Configurations for ERP Customer. If your Provider system is not in the list. 4.6. On the Consumer system. Select your Provider system listed in the SLD Identifier field.xml ERP Contact Folder Name —Contact. If the profile used in SAP Gateway system is not present in an SAP ERP system.4. 3. navigate to the SAP Note Assistant to download the template file using the provided SAP Note number.2. More Information Configurations on the SAP Gateway system (Consumer system) for: OData Channel Scenarios: Time Management ERP Consumer Generic Channel Scenarios: Time Management Leave Management Code List Configurations for ERP Customer. a profile has to be specified. 3.xml Folder Name —Customer.zip File Name — profile_IWCNT_CODELIST_1+. Open transaction SOAMANAGER.zip 0001670653 File Name —profile_IWCNT_1 . See section Obtaining WSIL URL of the Provider System in Configurations on the SAP ERP System (Provider System) to obtain WSIL URL of the Provider System Enter all required credentials.2 User Account Management PUBLIC © 2014 SAP SE or an SAP affiliate company.1. mass configuration of the Web service proxies in service group is not possible. 2. 4. 6. You can create logical ports manually (see section Checking the Logical Ports you have created below).4. Enter the name of the WSIL URL of your SAP ERP system. Enter a name and description for the Provider system. Page 72 of 95 . On the Consumer system. 10. Profile Management . open transaction SOAMANAGER.OData Channel 1. An external key is required that identifies the Provider system. each Web service proxy can be configured one by one. In the next steps. Navigate to Technical Administration tab 5.zip File Name — profile_IWCNT_1 .1. Note After importing the profile you need to logout and logon again into the SOA Management for the new profile to be visible for assignment. enter a name for your Provider system that uniquely identifies it. Choose Import . 2. perform the steps described in the section Obtaining the external key of the Provider system. Browse and select the downloaded template file for assignment.xml Folder Name — Code_List.2 Creating a System Connection to Provider System When calling a provider system. Use the profile created and distributed in the Creating a Profile section. Choose New to create a new Provider system. Download the XML file and save it. In this case. 9.xml 1. Choose Next .Application SAP Note Number Time Management 1584236 File Details Folder Name — Time. 7.OData Channel 1.zip File Name — profile_IWCNT_1.zip File Name —profile_IWCNT_1 . All rights reserved. 5.xml Leave Management 1588250 Code List 1588117 ERP Customer 0001670653 Folder Name —Leave. 6. and choose the right profile name. choose a configuration that suits your company's requirements and landscape setup. 8. Choose Next . To create a System Connection to the Provider system in the Consumer system proceed as follows: 1. Create a business application named Default .3. Navigate to Technical Administration tab System Connections .4. To get the external key of the Provider system.4. In the SOA Management window. In the next step. Log on to the SAP system where the SAP Gateway is installed. Service User: The SAP system is called with a predefined service user. Activate the account.User accounts have to be configured with the type of user authentication that takes place when the Consumer system calls the web services on the Provider system. Navigate to Service Administration User Account Management To create a new user account. All rights reserved.xml 2. Choose Import to complete the import process.zip File Name — scenario_IWCNT_CODELIST. only the Business User option is required. Download the XML file and save it. More Information PUBLIC © 2014 SAP SE or an SAP affiliate company. Leave Management and Code List: Application SAP Note Number Time Management 1584236 File Name Folder Name — Time. Note A dialogue box appears prompting you to activate the business scenario. On the Consumer system. 9. 13. 3. In the Business Application field. 2. select Business User . Anonymous user: The SAP system is called with an anonymous user. 8.xml Folder Name — Customer. The table below lists the SAP Note details for Time Management. Click New to create a new interface assignment. choose New . 6.zip File Name — scenario_IWCNT_C_KNA1. 6.4. press F4 and select the Provider system you created in the Creating a System Connection to Provider System. 12. Navigate to Service Administration tab Business Scenario Configuration . More Information Configurations on the SAP Gateway system (Consumer system) for: OData Channel Scenarios: Time Management ERP Consumer Generic Channel Scenarios: Time Management Leave Management Code List Configurations for ERP Customer. Browse and select the downloaded template file. navigate to the SAP Note Assistant to download the template file using the provided SAP Note number. Business User: The user logged on to the SAP Gateway also logs on the SAP system using their own user and credentials. The following three options are offered.zip File Name — scenario_IWCNT_C_KNA1. 5.xml ERP Contact 0001670653 Folder Name — Contact.zip File Name — scenario_IWCNT_LEMA_BS. 7. 5. Go to the Account Assignment tab. 4. 3. 11.4. Click Finish . 4. 8. Configuring User Accounts Proceed as follows to configure User accounts: 1. Page 73 of 95 . select the account you have just created. Open transaction SOAMANAGER.zip File Name — scenario_IWCNT_TIMA_BS. For setting up the communication from the Consumer systems to the Provider systems.4 Importing a Business Scenario Configuration XML To Import a Business Scenario Configuration XML proceed as follows: 1. In the SOA Management window. Choose Import . 7. Open transaction SOAMANAGER. Enter a name for the user account. Click Save . From the Account drop-down list.xml Code List 1588117 ERP Customer 0001670653 Folder Name — Code_List.OData Channel 1. You are then redirected to SOA Configuration Request Queue Management screen where you need to click Start request Queue processing to start logical port creation. 14. Choose Next .xml Leave Management 1588250 Folder Name — Leave. Select Assign to all services within this business application. 10.3. Choose New . 6. Choose Start request Queue processing to trigger the creation of Logical Ports for each Web service consumer proxy and provider system More Information Configurations on the SAP Gateway system (Consumer system) for: OData Channel Scenarios: Time Management ERP Consumer Generic Channel Scenarios: Time Management Leave Management Code List Configurations for ERP Customer. For example. Search for the service group that has been configured previously. the proxies are listed 6. Add the service group. see section Verifying the Endpoints Created. 10. Perform the following steps for each provider system. Activate the Business Scenario. select it and click Apply Selection .4.Configurations on the SAP Gateway system (Consumer system) for: OData Channel Scenarios: Time Management ERP Consumer Generic Channel Scenarios: Time Management Leave Management Code List Configurations for ERP Customer. 5. click the arrow next to the label to open up the tree. 2.OData Channel 1. This section guides you to verify the logical ports created while Configuring Service Groups. All rights reserved. 7. A logical port that has the Creation Type value set to Created based on profile is listed. On the first hierarchy level. More Information Configurations on the SAP Gateway system (Consumer system) for: OData Channel Scenarios: Time Management ERP Consumer PUBLIC © 2014 SAP SE or an SAP affiliate company. Page 74 of 95 . 3. you can manually create a logical port. 1. Choose Ping web service to check the configuration. 1. To see the details of a proxy. 2.4. Open transaction SOAMANAGER. 9. Enter the URL to a WSDL or select a file. 4. Go to the Configurations tab. If no logical port is listed. Select the Business scenario that was created when creating the provider system. 5. all configured provider systems are listed. One service group (that is. Navigate to Service Administration tab Single Service Configuration . 11. 3.OData Channel 1. 8. Logon to the Consumer system. Open transaction SOAMANAGER. 7. Choose Assign Business Application .5 Configuring Service Groups using a Business Scenario Service groups allow you to configure multiple consumer proxies at the same time. Chose a Name and Description .4. To see the details for a service group.3.4. To configure Service Groups using Business Scenario proceed as follows: 1. Navigate to Service Administration tab Business Scenario Configuration . Enter a Name and Description for the Business Scenario. Choose Create Logical Port .3. one set of Web service consumer proxies) may point to many Provider systems. Choose Check Processing State to monitor pending activities. Choose Add to add the service groups for the following applications: /IWCNT/SG_TIME_MGMT service group to the work list for Time Management /IWCNT/SG_LEAVE_MANAGEMENT for Leave Management /IWCNT/CODELIST_SERVICE_GROUP for Code List 8. On the second hierarchy level. they allow multiple consumer proxies to be used to access different services offered by the same Provider system. or it is not possible to create logical ports via the business scenario. 2. To obtain the URL of a WSDL.6 Verifying Logical Ports A logical port is a reference to runtime configuration on the consumer system to access the provider's endpoint. Choose Next and skip the Provider side configuration. Logon to the Consumer system. 4. 4.0 Support Package 05.Generic Channel Scenarios: Time Management Leave Management Code List Configurations for ERP Customer. For more information.4 Generic Channel Configuration Recommendation We strongly recommend using the OData Channel (ODC) programming paradigm for all SAP Gateway development. you can choose between embedded deployment or central hub deployment. you are strongly recommended to use the Service Builder (transaction SEGW) for your OData design-time development . In the SAP Reference IMG navigate to SAP NetWeaver SAP Gateway Former Development Generic Channel .OData Channel 1. see Embedded Versus Hub Deployment and Deployment Options. The structure is as follows: Configuration User Settings Define Role for SAP Gateway User Define Role for SAP Gateway Administrator Enhance Role for SAP Gateway SAP System User Connection Settings Connect SAP Gateway to SLD SAP Gateway to Consumer (includes additional activities) SAP Gateway to SAP System (includes additional activities) Activate or Deactivate SAP Gateway Consumer Settings Assign Roles to Consumers Synchronize Roles to Consumers Specify File for Mapping Users Configure LDAP Server for Mapping Users Select User Mapping Type Map SAP User Names to Consumer Activate or Deactivate Consumers Administration Subscription Settings Maintain Subscription Settings for GSDO Maintain Subscription Routing Maintain RFC Destination to Connectivity Provider Configure Guaranteed Delivery of Notifications (includes additional activities) General Settings Manage GSDO Groups Check GSDO Groups Assign SAP System Aliases to OData Service Define Virus Scan Profiles Logging Settings Set Log Level for All Users Set Log Level for Specific Users Set Display of Sensitive Information Cache Settings Clean Up Cache and Persistency Create Cleanup Jobs Manage Cleanup Jobs Define QRC Caching Behavior Metadata (includes additional activities) Notification Store (includes additional activities) Support Utilities Error Log Traces Application Log Apart from basic configuration settings the Generic Channel configuration activities for the SAP Business Suite backend system are listed in the Implementation Guide (IMG) in the backend system where software component IW_BEP is deployed. As of SAP Gateway 2. The structure is as follows: Connection Settings to SAP Gateway Create RFC Destination for Outbound Queues SAP Gateway Settings Create bgRFC Supervisor Destination PUBLIC © 2014 SAP SE or an SAP affiliate company. Apart from basic configuration settings the Generic Channel configuration activities are listed in the Implementation Guide (IMG) in the system where software component IW_FND is deployed. For more information. In the SAP Reference IMG navigate to SAP NetWeaver SAP Gateway Service Enablement Generic Channel .4. see SAP Gateway Service Builder. All rights reserved. Page 75 of 95 . Depending on whether you want to develop SAP Gateway content in an SAP Business Suite backend system or in an SAP Gateway hub system. enter RFC Destination for WSIL Service . 1.1 Defining Settings for Idempotent Services Idempotency guarantees delivery of synchronous messages exactly once. proceed as follows: 1. 4. 7. 3. 9. 2.4.Monitor bcRFC Queues Backend Event Publisher Administration Event Definition Event Type Linkages Logging Settings Set Log Level for All Users Set Log Level for Specific Users Clear Application Log Customizing of the SAP Gateway CCMS Context Support Utilities Application Log Clear Cache More Information Basic Configuration Settings OData Channel Configuration 1. Proceed as follows: 1. enter the path of the local WSIL service. To define settings for idempotent services. To check that you have successfully created an RFC destination for the WSIL. Log on to the SAP system you specified as a provider. A message displays confirming that the job has been scheduled. Define Settings for Idempotent Services SAP Gateway Former Development Generic Channel and click on the Activity icon. Enter the following default values: For Period Hours in Document the value is 6 . Enter WSIL for the Service Name and choose Execute . enter the HTTP port. 3. enter H . In transaction SM37 enter SAP_BC_IDP_WS_SWITCH* as the Job name and * as the User name . 1.4. In the Service No. 5. 8. and enter transaction SICF. 4. To check that you have successfully defined the idempotent services settings. for example. You configure idempotent services by scheduling a background job that ensures that request messages in SAP Gateway only occur once. The /SAP/BC/SRT/WSIL service must have been activated in transaction SICF. The test result displayed on the Test Result tab should contain Status HTTP Response 200. On the Configuration of RFC Connections page choose Create .4. To obtain the WSIL URL. Save your settings.4.4. A list with all scheduled jobs SAP_BC_IDP_WS_SWITCH_BD and SAP_BC_IDP_WS_SWITCH_BDID is displayed. Note The WSIL service lists the configuration of all Web Services exposed by the system. In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver Configuration Connection Settings SAP Gateway to Consumer 2.4. All rights reserved. carry out the following steps: 1. Choose Enter . Choose Schedule . Page 76 of 95 .4. 3. enter IWFND_WSIL_LOCAL_DEST .4.4. Choose Execute .2 Creating an RFC Destination for the WSIL Service You create an RFC destination for the Web Service Inspection Language (WSIL) service on the SAP Gateway server. The WSIL service is now displayed in the HTTP service tree. In the RFC Destination field. In the Path Prefix field. For Period Hours in Document ID the value is 12 . field. Double-click on the WSIL entry to obtain its URL.3 Assigning the System Alias Pointing to the SAP System PUBLIC © 2014 SAP SE or an SAP affiliate company. Choose Continue . The path for the WSIL service is displayed: /default_host/sap/bc/srt/ The default value for the URL is: http://<host name:port>/sap/bc/srt/wsil 10. In the Connection Type field. 6. Create RFC Destination for WSIL Service. SAP Gateway Former Development Generic Channel and click on the Activity icon. In the Description 1 field. 2. select Connection Test . /sap/bc/srt/wsil . On tab Technical Settings enter the SAP Gateway host in the Target Host field. In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver Configuration Connection Settings SAP Gateway to Consumer 2. carry out the following steps: 1. In the Dialog Structure section. proceed as follows: In transaction SPRO open the SAP Reference IMG and navigate to: Configuration Connection Settings SAP NetWeaver SAP Gateway to SAP System SAP Gateway Check SAP System Aliases Former Development Generic Channel and click on the Activity icon. the source of valid values is different depending on the software version. Currently the code list functionality supports value helps fetched from domains with fixed values. value helps for BAPI parameters as well as value helps fetched from the QueryCode List ESA service. Save your settings. it is also possible for the source of the possible DocumentTypes to be different in each of these scenarios. the list of valid document types for an ERP document may come from an ESA service.You have to specify which content is being enabled by assigning a SAP system alias. For example. You can also activate framework services such as metadata. select the entry for your scenario.4. proceed as follows: 1. Choose New Entries .4. Why do you need this Function In real time business scenarios. RFC test Checks if the assigned RFC destinations are functional. 2. 5. i.5 Subscription Settings To enable the push scenario you need to carry out the following configuration settings: Maintain Subscription Settings for GSDO Maintain Subscription Routing Maintain RFC Destination to Connectivity Provider Configure Guaranteed Delivery of Notifications You can find all these activities in the SAP Gateway Implementation Guide (IMG) which is available in the system: In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver SAP Gateway Former Development Generic Channel Configuration Subscription Settings . All rights reserved. while creating a document in CRM. while the list of valid DocumentTypes for a CRM document may come from a domain. http://<server>:<port>/sap/opu/odata/IWFND/MetaDataProcessing/ServicedocumentCollection/?$format=xml 1. More Information Creating the System Alias for Applications 1.4. Double-click Manage SAP System Aliases and ensure that the Active checkbox is selected for the SAP Gateway GSDO group you created for your content scenario. As a result you can fetch a list of all Service Documents. 3. In transaction SPRO open the SAP Reference IMG and navigate to: 2. to have a different set of valid values based on the context. 7. A status report of the listed checked items displays. the list of possible values for DocumentType is different from the list of valid DocumentTypes while creating a document in ERP. including the following: Activity Check Assigned RFC Checks if a system alias has an RFC destination assigned to it. Assigned Web Service provider system Checks if a system alias has a Web Service provider system assigned to it. 8. In the SAP System Alias column. SAP NetWeaver SAP Gateway Former Development Generic Channel Administration General Settings Manage GSDO Groups and click on the Activity icon.4 Checking SAP System Aliases The Check SAP System Aliases activity verifies the various connections you have configured. In the User Role column. Page 77 of 95 . use the value help to select the system alias that points to the SAP system on which the service is to be executed. double-click Assign SAP System Aliases . In this case assign LOCAL. To check the configuration for aliases for a SAP system.4.4.4. 1.4. If you want to consume metadata information. Leave this column empty if all user roles need access. In addition to this. Use built-in SAP Gateway services: the GSDO group is called IWF_FW_SERVICES and it already contains the required GSDO. 4.e. 6. Code List has been developed to cater to these scenarios. you only need to maintain the SAP system alias.5 Code List Overview Code List feature enables the content developers to easily create value helps for various fields. Create an RFC destination and an Alias for LOCAL which points to the SAP Gateway system itself. PUBLIC © 2014 SAP SE or an SAP affiliate company. For example.4. it is possible for field. enter a role that contains users who need to use the content scenario in the system of the SAP system alias. for example. Code values can also come from different sources like fixed values associated with domain from the QueryCodeList ESA service. or from the value helps defined for BAPI parameters. Code Values can come from different backend systems or from a single backend system. 1. Therefore. From the Manage SAP Gateway GSDO Groups table. All rights reserved.What does this function do? For a user to enter a partner role and wants to fetch the list of valid partner roles. then the following four public static variables need to be set: MV_SOURCE_NAME = 'ESA' MV_ESA_CODE_NAME = ESA Code Name MV_ESA_CODE_TYPE = ESA Code Type MV_ESA_URI_NAMESPACE = ESA URI Namespace Example For Partner Roles. the following values need to be set in the SET_VALUE_HELP_SOURCE method of the class. the content developers can easily create value helps for various fields. Create the associated SAP Gateway Consumption Model and then fetch the list of Partner Roles using this Service. to fetch the list of valid partner roles for a consumer when they want to enter a partner role.4. The content developer needs to create an Entity Provider class to specify the technical details of the source of the value helps. For example. See Creating Entity Data Provider Class for more information. By using Code List function the target system can be determined based on the configuration entries maintained while registering the OData service for a specific code.5. the content developer needs to first identify the source of the list of valid partner roles. Create a User-Centric SAP Gateway Data Model for Partner Roles. the content developer needs to do the following: . and then by using the Code List feature fetch them for the consumer. MV_VALUE_HELP_SOURCE_CATEGORY = '02' MV_DOMAIN_NAME = ‘/SAPTRX/EV_PARROL’ Example PUBLIC © 2014 SAP SE or an SAP affiliate company. See Creating a SAP Gateway Data Model based on the Code List PS model for more information.4. For this. If the value help is fetched from the fixed values of a domain then the following two public static variables need to be set: MV_SOURCE_NAME = ‘DOMAIN’ MV_DOMAIN_NAME = Name of the domain If the value help is fetched for a BAPI Parameter then the following eight public static variable of the class need to be set: MV_SOURCE_NAME = BAPI MV_BAPI_OBJ_TYPE = BAPI Object Type MV_BAPI_OBJ_NAME = BAPI Object Name MV_BAPI_METHOD_NAME = BAPI Method Name MV_BAPI_PARAM_NAME = BAPI Parameter Name MV_BAPI_FIELD_NAME = BAPI Field Name MV_BAPI_CODE_DESC_TABLE = BAPI Code description table MV_BAPI_CODE_DESC_FIELD = BAPI Code description table field If the value help is fetched from QueryCodeList ESA service. Currently the Code List feature supports: Value helps fetched from Domains with fixed values Value helps for BAPI parameters Value helps for fetched from the QueryCodeList ESA service for codes modeled in ESR Creating Entity Data Provider Class Once the source of the value help is identified the content developer should create an Entity Data Provider Class that inherits the abstract Code List Entity Provider class: /IWCNT/CL_CLST_EPRRQ_ABS This class registers the appropriate BOPs based on the source of the value help. See Creating a SAP Gateway Consumption Model based on the SAP Gateway Data Model for more information. Page 78 of 95 . See Creating a SAP Gateway Data Model based on the Code List PS model and Creating a SAP Gateway Consumption Model based on the SAP Gateway Data Model for more information 1.1 Code List Usage Using the Code List feature. Example Value Help Source is Domain In order to fetch the list of valid values for Partner Roles. The content developer need to override the SET_VALUE_HELP_SOURCE method of the Entity Provider class in order to specify the technical details of the source of the value help. the Entity Provider Class can be named as: IWCNT/CL_CLST_EPRRQ_PROLES The mv_domain_name variable of this class can be set to: /SAPTRX/EV_PARROL And the mv_value_help_source_category variable can be set to: 02 This indicates that the domain with fixed values will be used to fetch the code list in the: SET_VALUE_HELP_SOURCE method of the class This domain name would be used in order to fetch the value help for Partner Roles. ls_mapping_specialist_attr-bop_type = /iwfnd/if_mgw_bec_bop=>gc_bop_type_custom. DATA: ls_mapping_specialist_attr TYPE LINE OF gtyt_map_specialist_attributes.Value Help Source is BAPI Parameter In order to fetch the list of values for title codes from the value help defined for a BAPI Parameter. 2. Syntax 01. Syntax 01. Implement the following code to register the Backend Connectivity API for fetching Code List from a BAPI parameter in the REGISTER_MAPPING_SPECIALISTS method of the entity provider class. MV_VALUE_HELP_SOURCE_CATEGORY = '01' MV_BAPI_OBJTYP = 'BUS1006' MV_BAPI_OBJECT_NAME = 'GETCENTRALDETAIL' MV_BAPI_METHOD = 'GETADDRESSDETAIL' MV_BAPI_PARAM = 'CENTRALDATA' MV_BAPI_FIELD = 'TITLE_KEY' MV_CODE_DESC_TABLE = 'TSAD3T' MV_CODE_DESC_FIELD = 'TITLE_MEDI' Example Value Help Source is from QueryCodeList. All rights reserved. DATA: ls_processed_be_data LIKE LINE OF it_processed_be_data.com/xi/APPL' Registering Code List Backend Connectivity Custom BOP Code List offers two backend connectivity APIs in order to fetch Code List from a domain with fixed values and from a BAPI parameter respectively: /iwcnt/cl_clst_bec_dom /iwcnt/cl_clst_bec_bapi The content developer needs to register instances of these APIs as customer BOPs in the REGISTER_MAPPING_SPECIALISTS method of the Entity Provider Class of the entity for which the Code List needs to be fetched. Registering Backend Connectivity API for fetching Code List from a BAPI Parameter. ls_mapping_specialist_attr-be_api_ref ?= lo_clst_bec_dom. lt_gender_codes TYPE /iwcnt/t_clst_attr. FIELD-SYMBOLS:<ls_processed_be_value> Type any. DATA: ls_mapping_specialist_attr TYPE LINE OF gtyt_map_specialist_attributes. Once registered. the Code List can be accessed via the IT_PROCESSED_BE_DATA parameter in the respective mapping specialists. Example 1. IF sy-subrc = 0. the Code List fetched by the backend connectivity API will be available in IT_PROCESSED_BE_DATA parameter of the mapping specialist classes. PUBLIC © 2014 SAP SE or an SAP affiliate company. lt_gender_codes[] = <ls_processed_be_value> ENDIF. APPEND ls_mapping_specialist_attr TO et_mapping_specialist_attr. Once the backend API has been registered. ASSIGN ls_processed_be_data-value->* TO <ls_processed_be_value>. The internal tablelt_gender_codes [][] will now contain the gender codes fetched from the fixed values associated with the domain AD_SEX. the following values need to be set in the SET_VALUE_HELP_SOURCE method of the class. READ TABLE it_processed_be_data INTO ls_processed_be_data WITH KEY name = 'Gender'. ls_mapping_specialist_attr-execution_mode = /iwcnt/if_common_c=>gc_execution_mode_q ls_mapping_specialist_attr-bop_type = /iwfnd/if_mgw_bec_bop=>gc_bop_type_custom. Registering Backend Connectivity API for fetching Code List for Gender from a Domain with fixed values Implement the following code in the Entity Provider Class: Syntax 01.ESA service MV_VALUE_HELP_SOURCE_CATEGORY = '03' MV_ESA_NAME = 'CountryCode' MV_ESA_TYPE = 'CountryCode' MV_ESA_NAMESPACE = 'http://sap. Page 79 of 95 . DATA: lo_clst_bec_dom TYPE REF TO /iwcnt/cl_clst_bec_dom. DATA: lo_clst_bec_bapi TYPE REF TO /iwcnt/cl_clst_bec_bapi. ls_mapping_specialist_attr-execution_mode = /iwcnt/if_common_c=>gc_execution_mode_q. CREATE OBJECT lo_clst_bec_dom EXPORTING iv_code_name = 'Gender' iv_domain_name = 'AD_SEX'. ASSIGN ls_processed_be_data-value->* TO <ls_processed_be_value>. APPEND ls_mapping_specialist_attr TO et_mapping_specialist_attr. Once the backend API are registered. Choose Existing Data Model in the Create From pane. Code List can be accessed via the IT_PROCESSED_BE_DATA parameter in the respective mapping specialists. IF sy-subrc = 0. 4. The internal table lt_title_codes[] will now contain the Title codes fetched from the value help associated with the BAPI parameter. Logon to the SAP Gateway system. Click Display and choose Yes in the Create Data Model window. 7. See Customizing the SAP Gateway System for more information. All rights reserved. Registration The Entity Provider Class /IWCNT/CL_CLST_EPRRQ_PROLES and the SAP Gateway Consumption model /IWCNT/PARTNER_ROLES_0001_UC is then registered in the transaction: SPRO SAP Customizing Implementation Guide Assign Data Provider to the Data Model . 3. the content developer should create a SAP Gateway UC data model based on /IWCNT/MGW_CODE LIST _0001_PS Example A UC model for Partner roles can be named /IWCNT/PARTNER_ROLES_0001_UC and this model would be created with reference to /IWCNT/MGW_CODE LIST _0001_PS. Choose SAP GW Data Model from the drop-down list. 6. READ TABLE it_processed_be_data INTO ls_processed_be_data WITH KEY name = 'TitleCode'. Enter the following information for the model: Name as/IWCNT/MGW_CODE LIST Type as PS Version as 0001 8. FIELD-SYMBOLS:<ls_processed_be_value> Type any. The property Code is marked as the key of the model and is also the only filterable property of the model. lt_title_codes[] = <ls_processed_be_value> ENDIF. 2. Page 80 of 95 . Syntax 01. Creating SAP Gateway Data Model based on the Code List PS Model To create a Data Model based on the Code List PS Model proceed as follows: 1. descriptions for the fields in the SAP Gateway Data Model. Set labels. The PS model created for Code List is: /IWCNT/MGW_CODE LIST _0001_PS Once the source of the value help has been specified in the Entity Provider class. SAP NetWeaver SAP Gateway OData Channel Development without IW_BEP Registration Additional customizing in order to assign the system alias and the GSDO group would also need to be done. The SAP GW Data Model name should follow the convention “<namespace><name>_<version>_UC” The version must be 4 characters long with leading zeros. Example /IWCNT/PARTNER_ROLES_0001_UC 5. Open Object Navigator (transaction se80). DATA: ls_processed_be_data LIKE LINE OF it_processed_be_data. Creating Code List Model The Code List PS model is a very simple model that has two properties namely Code and Text. PUBLIC © 2014 SAP SE or an SAP affiliate company. lt_gender_codes TYPE /iwcnt/t_clst_attr. Enter a name for the SAP GW Data Model. external names.CREATE OBJECT lo_clst_bec_bapi EXPORTING iv_code_name = 'TitleCode' iv_bapi_obj_type = 'BUS4001' iv_bapi_obj_name ='ADDRESSORG' iv_bapi_method = 'FindDetail' iv_bapi_param = 'BAPIAD1VL' iv_code_desc_field = 'TITLE_MEDI' iv_code_desc_table = 'TSAD3T' iv_bapi_field = 'TITLE' ls_mapping_specialist_attr-be_api_ref ?= lo_clst_bec_bapi. Note All the screenshots shown below are samples only. In the SPRO transaction SAP Customizing Implementation Guide SAP NetWeaver SAP Gateway Development without IW_BEP Registration Assign SAP System Aliases to OData Service .4. To configure the SAP Gateway systems for Code List: 1. The screenshots below are based on the examples mentioned in the Usage of Code List section. 3. In the SPRO transaction SAP Customizing Implementation Guide SAP NetWeaver Development without IW_BEP Registration Assign Data Provider to the Data Model SAP Gateway . Choose SAP GW Consumption Model from the drop down list. Right click the SAP Gateway Consumption Model and choose Add SAP GW Data Model. Enter the name of an existing SAP Gateway Consumption Model. Page 81 of 95 . 4. Former Development OData Channel Assigning SAP System Aliases to OData Service Note The above image is just a sample.2 Customizing the SAP Gateway System for Code List In order to maintain the configuration entries for Code List the Entity Provider class. 5. 1. Former Development OData Channel Example For Partner Roles Code List.4. Logon to the SAP Gateway system. the SAP Gateway Data Model and the SAP Gateway Consumption model should be created. Now the Code List collection for the specific code will be added to the existing SAP Gateway Consumption model Note The above steps should be performed for each code. All rights reserved. Assigning Data Provider to Data Model 2. Configure the existing SAP Gateway Consumption model (as explained under Adding the Code List SAP Gateway Data Model to an existing SAP Gateway Consumption Modelin the Code List Usagechapter. the Model Identifier should be set to/IWCNT/PARTNER_ROLES_0001_UC and the Class/Interface should be set to /IWCNT/CL_CLST_EPRRQ_PROLES.5. 1.4.3 Code List Cache Cleanup Functional Overview PUBLIC © 2014 SAP SE or an SAP affiliate company. Specify the SAP Gateway Data Model created in the Creating SAP Gateway Data Model based on the Code List PS model. Refer to Usage of Code List for more details. the SAP Gateway Consumption Model and the GSDO group that will be created by the content developer for a Code List implementation. 6.Adding the Code List SAP Gateway Data Model to an existing SAP Gateway Consumption Model To create SAP Gateway Consumption Model based on the SAP Gateway Data Model: 1.5.4. 2. Open Object Navigator (transaction se80). The actual customizing entries will depend on the SAP Gateway Data Model. expand SAP Customizing Implementation Guide SAP NetWeaver Cache Settings Cleanup Cache and Persistency 2.1 Settings for Customer Relationship Management on SAP Gateway SAP Gateway Customer Relationship Management (CRM) application is a comprehensive solution for managing your customer relationships from any device or platform. define a role for which the administrator should assign the list of users (who has access to execute the functionality) Note 1. see Changing Standard Roles. Choose the Authorization tab. The cached data can be deleted based on the created by user(s) and time restrictions. 3. This functionality can be used by the administrator to clear the cache data either periodically or whenever required by refreshing the cache data. Following are the SAP Gateway Generic Channel supported scenarios: Generic Channel Scenarios Configuration Settings Customer Relationship Management (CRM) Settings for Customer Relationship Management on SAP Gateway Reporting Management Settings for Reporting Management on SAP Gateway Human Capital Management Settings for Human Capital Management on SAP Gateway Code List Settings for Code List on the SAP Gateway System 1. 3. Choose Single Role . The CRM SAP Gateway users should be assigned to these roles so that they can use SAP Gateway services. 2. see Deployment Options. To delete the code list cache for the OData Channel proceed as follows: 1.4. Execute. For information on changing roles. All rights reserved. 5. Choose Change Authorization . 6. 3. 4. 7. Depending on your use case.4. either use backend OData Channel or hub OData Channel with software component IW_BEP.6. The roles must be defined/created on the SAP Gateway server. For each of these systems. 4. For this: 1. Choose the template mentioned in the Role Templates section. 2. Specify the time restriction if needed.4. Create system alias for each of these systems. For more information. Role Template Use the predefined role templates mentioned in the table below to create user roles for SAP Gateway CRM: PUBLIC © 2014 SAP SE or an SAP affiliate company. SAP Gateway OData Channel Administration Note Uncheck the Execute in Test Mode checkbox in order to delete the cached value helps from the Codelist Cache tables. In the SPRO transaction. If you want to use OData Channel. 8. Enter a name for the role in the Role field. You must be an SAP Gateway administrator or have an SAP user administrator to create the roles.The cache cleanup functionality cleans the code list cache tables for the OData channel which are maintained in the SAP Gateway system. To create roles. 5. Specify the cleanup scenario as /IWCNT/CL_CODELIST_CLEANUP_MGW. Choose Generate to create a new role. proceed as follows: 1.4. Open transaction pfcg in the SAP Gateway system. Specify User(s) if you want to delete the entries cached by a specific user or users. Save the Role . either use embedded deployment or central hub deployment. Identify the list of SAP CRM systems on which the functionality should be accessible by SAP Gateway. then role creation and assigning of roles to GSDO groups is optional but this is not recommended. Creating Roles You must create roles for SAP CRM and assign these roles to the CRM GSDO group. Page 82 of 95 .6 Configuration Settings for Generic Channel Scenarios Recommendation We strongly recommend using the OData Channel (ODC) programming paradigm for all SAP Gateway development. 3. If there is only one SAP CRM system and all the users on SAP Gateway should be able to access CRM functionality on this SAP CRM system. 1. 2. All rights reserved. Page 83 of 95 .Template Name Template For /IWCNT/RT_USER_ACT SAP Gateway CRM Activity Management /IWCNT/RT_USER_ACCNT SAP Gateway CRM Accounts /IWCNT/RT_USER_CONT SAP Gateway CRM Contacts Authorization The user must have the following authorizations to access SAP Gateway system to use the CRM Scenarios: Service Authorization Object /IWCNT/SG_ACTIVITY_0001 Authorization Values SRV Name – A3CB8ED503F16F11D97BEA06BB41E0 S_SERVICE SRV Type – HT TCD – SICF S_TCODE /IWCNT/BP_ACCOUNT_0001 SRV NameA8172704E2C058CDF94DD331FDB141 S_SERVICE SRV Type-HT TCD – SICF S_TCODE /IWCNT/BP_CONTACT_0001 SRV Name F3B52FB30DB35EC0A377ADD15084C9 SRV Type-HT S_SERVICE TCD – SICF S_TCODE While creating role templates in the SAP CRM system. include the following authorization objects: CRM Service CRM Activity Authorization Object S_RFC Field Field Value RFC_TYPE FUGR RFC_NAME BAPT CRM_ACTIVITYCRM_BAPI CRM_BUSPROCESSND_BAPI CRM_OSP_HELPER_TOOLS COM_BUPA_USER_REGISTRATION CRM Business Partner (Accounts and Contacts) S_RFC ACTVT 16(Execute) RFC_TYPE FUGR RFC_NAME CRM_BSP_BP_PRINT COM_BUPA_USER_REGISTRATION BUPA_TAX_BAPI BUPA_INTERFACE_LONGTEXTS BUPA_HOURS_BAPI BUBA_3 BFHV BAPT S_SERVICE CRM Attachments S_RFC ACTVT 16 SRV_NAME CF56155FF3F9AEB85ED804FEEFE180 SRV_TYPE HS RFC_TYPE FUGR RFC_NAME SKWF_UTIL CRM_KW_DOCUMENTS SKWF_IO ACTVT 16 The user must have the following authorizations in the SAP Gateway system to access SAP Gateway services for CRM: CRM Service CRM Activity Authorization Object S_SERVICE CRM Accounts S_SERVICE CRM Contacts S_SERVICE Field Field Value SRV_NAME A3CB8ED503F16F11D97BEA06BB41E0 SRV_TYPE HT SRV_NAME A8172704E2C058CDF94DD331FDB141 SRV_TYPE HT SRV_NAME F3B52FB30DB35EC0A377ADD15084C9 SRV_TYPE HT Settings in the SAP Gateway System PUBLIC © 2014 SAP SE or an SAP affiliate company. ZRole . Choose a provider system if you are using ESA services. The following configurations have to be done on SAP CRM system and SAP Gateway system: SOA Management configurations on the SAP CRM system PUBLIC © 2014 SAP SE or an SAP affiliate company. as they belong to the same deployment unit. Applications running on the GSDO use web services to call the SAP systems. Check it if the CRM system is on the same system as the SAP Gateway system. from the Manage GSDO Groups list. Assigning Roles to a GSDO Group Proceed as follows: 1. Assigning SAP System Aliases to a GSDO Group Proceed as follows: 1. A granularity of the service groups has been chosen that matches the entities offered by the GSDO and the deployment units of web services of the SAP systems. Press F4 to select a system alias in the SAP System Alias column. from the Manage GSDO Groups list. Choose Assign User Roles on the dialog structure.0. accounts and contacts. 4. Local SAP GW Leave unchecked if the CRM system is not on the same system as the SAP Gateway system. Page 84 of 95 .1 Configuring GSDO to Connect to the SAP CRM System This section provides the basic configurations required to connect the SAP Gateway to the SAP CRM 6. For information on configuring a provider system.4.0 or CRM_7. If you are using SAP CRM 6. if an SAP system offers the web service Get Employee. 3. Save your settings.You need to perform the following customizing settings in the SAP Gateway system: Creating SAP system aliases Assigning roles to a GSDO group Assigning SAP system aliases to a GSDO group Note The configurations mentioned below must be carried out for CRM activity. WS Provider System If you are using SAP CRM 7. leave the field blank.1. Therefore. In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver SAP Gateway Former Development Generic Channel Administration General Settings Manage GSDO Groups and click the Activity icon. For example. see Configuring a GSDO to Connect to the SAP CRM system. For example.0. Choose New Entries . Software Version Enter CRM_6. 3. 4. Choose New Entries . Enter the following details for the system alias: Field SAP Gateway Former Development Manage SAP System Aliases Generic Channel and click the Activity icon. Choose Assign SAP System Aliases on the dialog structure. 6. 6. BKDCNT200 . the applications have proxies that are shipped with the GSDO. Select the GSDO Group ( IWACT for CRM Activity and IWBPC for CRM Accounts and Contacts). Enter the role name in the Assign User Roles column. 4. The actual system that is used is determined at runtime via the destination finder. 1. This way it is possible to easily configure all web services that belong to the entity Employee as a unit (mass configuration) instead of configuring each proxy one by one. for example. it also offers the web service Create Employee . Save your settings. In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver SAP Gateway Former Development Generic Channel Administration General Settings Manage GSDO Groups and click the Activity icon. 2. 2.6. Save your settings. Leave the field blank if you are using BAPI based connection (We recommend you to use BAPI based connection). 5. Each service group can be configured to point to one or many SAP systems. Select the GSDO Group ( IWACT for CRM Activity and IWBPC for CRM Accounts and Contacts). Enter the role name created above ZRole in the User Role column. 7. Choose New Entries .4. RFC Destination Specify the RFC destination defined for your SAP system. 3. In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver Configuration Connection Settings SAP Gateway to SAP System 2.0 system. Creating System Alias for Applications Proceed as follows: 1. These proxies are grouped in service groups. you can: 1. Description SAP System Alias Name of the system alias. Description Descriptive text for the system alias. Applications bundle proxies to service groups in a granularity that matches the way the web services are offered by the SAP systems. All rights reserved.0 according to the CRM version you are using. 5. 2. You must go to the configuration of each provider system and configure it to use the new version of the profile. In such case. This has to be done in all systems in the landscape after the distribution of the new profile version. the provider and the consumer have to use the same profile so that the calling system uses the exact authentication.6. 8.1 SOA Management Configurations on SAP CRM System The configurations to be carried out in the SAP CRM system via the transaction SOAMANAGER is detailed in this section. Choose Create . you need to manually create logical ports. Enter a profile name in the Profile Name field under the Profile Properties section.6. Check for the settings for reliable messaging. encryption. Note If you have the option to import the Mass Configuration/Business Scenario XML file.4. choose Both Names from the Field and click Go . 3.1. and import the profile.4. 6. choose Business Administration Mass Configuration . 7. 2.1. To enable mass configuration on the consumer side. Choose Create . Page 85 of 95 . Save and activate the configuration scenario. proceed as follows: 1. and then used for the configuration of each web service on the provider and consumer side.1. 1. you need to create logical ports manually on the consumer system. SOA Management configurations on the provider system include: Creating a New Profile in the Provider System — A profile that contains general configuration on security and transport systems for the entire landscape. 1. enter configuration scenario name and description.4. Choose a profile from the Profiles sections and click Assign to Service .4. 4.1. Note If you are using SAP Basis release 700. Log on to all relevant systems in the landscape.1. Creating and Distributing a New Profile 1. and choose Export to export it to a file.1. Choose the Provide tab and choose Add 4. Web services are exposed via endpoints.4. choose Technical Configuration Profile Management . 5. By activating a new version. Choose the provider added and click Assign . the endpoints have to be created using a Business Scenario . The selected authentication method must support single sign-on. This may also require trust to be configured between the GSDO and the SAP systems.1.1.SOA Management configurations on the SAP Gateway system 1. Note If you do not have the option to export the files. PUBLIC © 2014 SAP SE or an SAP affiliate company. it is not possible to use Mass Configuration for the services of that system. the provider system and all other pieces of configuration that use the profile still use an old version. Configuring Provider Systems — Provider systems.6. and other settings that are offered by the provider system. A profile is created once. Creating Endpoints using a Business Scenario For creating endpoints using a business scenario. see SAP Note 1585723 files. Save and activate the profile. you must create a new version of it. Web services called by the GSDO have to be exposed using the profile created. Note SAP CRM system is also referred to as provider system here. 5. For web service communications.2 Configuring Provider Systems A provider system is the SAP CRM system being used. Note If you want to change a profile. transport binding and authentication that fulfill the needs of your company and landscape. All rights reserved. 7. Choose the service from the list and click Add to Worklist . for the procedure to import the XML 6. In the SAP CRM system go to transaction SOAMANAGER. Select the new profile you have created.1 Creating a New Profile in the Provider System A profile is general configuration of security and transport aspects. go to transaction SOAMANAGER. In the SAP CRM system go to transaction SOAMANAGER. This can be compared with RFC destinations. Enter CRM_BPBASICDATABYNAMEADDRQR in the Search Pattern field. distributed to all relevant servers in a landscape. 2.4. 3. to indicate which SAP systems are called. You must also reactivate all dependent objects as required. The default value for the URL is http://<host:port>/sap/bc/srt/wsil? sap-client=<client> . else enter a name for your SAP system that uniquely identifies it. and the Creation Type field is set to Created based on the profile. For obtaining a URL to configure WSIL. proceed as follows: 1. 5. proceed as follows: 1. Choose Next . 4. In this case. 3. Enter WSIL for Service Name . 4. You can also obtain a URL.4. Choose Open WSDL document for selected binding . 5. Use the profile created and distributed in the Creating a New Profile in the Provider System section. You can create logical ports manually. WSDL for the Endpoints To see the WSDL for the endpoint. Endpoints are displayed here with a GUID as ID. Choose Start Activation for creating end points.1 Creating a Provider System in the Consumer System When calling a provider system.4.4. follow the procedure below. 2. 11. 2. The WSIL service lists the configuration of all web services exposed by the system. 2. Choose the Configurations tab. Note SAP Gateway system is also referred to as consumer system here. 6. In the SAP Gateway system go to transaction SOAMANAGER choose Technical Administration System Connections . PUBLIC © 2014 SAP SE or an SAP affiliate company. see Creating a Fallback Configuration. Creating a Provider System 1.1. 2. If the profile used in the GSDO is not present in a provider system.2. Choose Check for Updates . 10. User Account Management — User Account Management. Choose the profile you created as mentioned in the section Creating a New Profile in the Provider System. Go to transaction SICF.2 SOA Management Configurations on SAP Gateway System This section provides the configurations to be carried out in the SAP Gateway system via the transaction SOAMANAGER. Choose Overview tab.4. Logical ports can be created using SOAMANAGER automatic configuration. 3. choose Business Administration Web Service Administration . Click Back and go to Activation Request Management. Search for the service that has been previously added to the business scenario. 1. 5. select it. All endpoints and services are listed here. Choose Display to see its configuration. 2.9.6. 4. 3.1. 1. Note 1.1. each web service proxy can be configured one by one.1. mass configuration of the web service proxies in service groups is not possible. for authentication settings when calling an SAP system. Choose Execute . SOA Management configurations on the consumer system include: Creating a Provider System in the Consumer System — The service groups. Choose New . In the SAP CRM system go to transaction SOAMANAGER. to determine which SAP systems may be called per service group from the GSDO (acting as the consumer). Select the service from the list and choose Apply Selection. 3. Page 86 of 95 . Enter the URL for WSIL (Web Service Inspection Language) of your SAP system. which either uses Service registry (If configured) or WSIL to retrieve WSDL and corresponding endpoints. Enter SERVICE for the Type Hierarchy . proceed as follows: 1. Enter a name and description for the provider system. If you do not have Service registry in your landscape you must provide WSIL details while configuring the provider system in consumer system SOAMANAGER (in System Connection). a profile has to be specified. Select a binding from the drop-down box. Note The name of the Provider system and the name of the WS Provider System (mentioned in section Creating System Alias for Applications) should be same. Log on to the provider SAP system you created. All rights reserved.6. Checking the Endpoints Created For checking the endpoints created. If your SAP system is listed in the SLD Identifier field. For setting up the communication from the SAP Gateway to the provider systems. 8. The activation of the scenario fails.2. Choose a configuration that suits your requirements and landscape setup like. 6. 3. Perform the steps given below to get an external key. 2. Choose New . An external identifier is now generated. Choose the service group from the list and click Add To Worklist . Choose ServiceGroup in the Search by field. Choose Next. 11. authentication method and secure communication.2 User Account Management User accounts have to be configured with the kind of user authentication that takes place when the GSDO calls web services on the SAP system. 8.4. Choose Next . 9. 6. Perform the following steps for each provider system. 3. password for WSIL and choose Next . In the provider system go to transaction SOAMANAGER choose Technical Administration Global System Settings . Save your settings. Service User: SAP system is called with a predefined service user. select it and click Apply Selection . Choose Assign Business Application . 10. PUBLIC © 2014 SAP SE or an SAP affiliate company. Choose the business application that was created when creating the Provider Systems. Anonymous user: SAP system is called with an anonymous user. 4. Enter any unique ID in the External Key field. 4. Choose New to create a new configuration scenario. 4. Enter a name in the Application Name field and provide a description. select Business User for Account Type . proceed as follows: 1. Enter the user. If this is the case. 9. 1. Choose Ping web service to check the configuration. An external key is required that identifies the provider system. Create the logical ports manually (see section Check the logical ports you have created below).4. Search for the service group that has been configured previously. 8. Select the service group. Choose the business application that was created when creating the Provider Systems. Choose Check for Updates to monitor or trigger the creation of logical ports for each web service consumer proxy and provider system. enter an organization name and business system. 2. In the SAP Gateway system go to transaction SOAMANAGER choose Service Administration Single Service Configuration . see Creating a Fallback Configuration. click Assign To Service Group . To see the details of a proxy.1. 7. Choose the account you created. Choose Add to add a service group to the work list. In the SAP Gateway system go to transaction SOAMANAGER choose 2. only the Business User option is required. choose Both Names from the Field and click Go . 3. 7. 6. Choose Account Assignment tab. 9. in the Systems Connections Wizard .7. Choose New to create a new interface assignment. Choose Next . Choose New . Note For the procedure on creating logical ports manually. To see the details for a service group.6. 2. 10. proceed as follows: 1. all configured provider systems are listed. Page 87 of 95 . 2. choose Service Administration User Account Management . 3. The following three options are offered: Business User: The user logged on to the SAP Gateway logs on the SAP system using their own user and credentials. the proxies are listed. To obtain the external key of a provider system. Go to the Configurations tab. choose Both Names from the Field and click Go . Proceed as follows: 1. enter /IWCNT/SG_BUSINESS_PARTNER in the Search Pattern field. Choose Finish and activate the account. Service Administration Business Scenario Configuration . Proceed with the configuration of the business scenario. On the first hierarchy level. On the second hierarchy level. 5.1. Enter /IWCNT/SG_BUSINESS_PARTNER in the Search Pattern field. you cannot use mass configuration on the consumer side for the services of that system. Choose the check box Assign to all services within this business application . 5. 3. 5. 11. Enter a name and description for the business scenario. In the SAP Gateway system go to transaction SOAMANAGER. Choose Finish and activate the configuration scenario. 2. click the arrow next to the label to open up the tree. If no external identifier is displayed. 3. Configuring User Accounts To configure user accounts. Checking the Logical Ports Created 1. enter a name and description for the user account. This skips the step to configure the provider side. 10. Note For releases lower than SAP Basis 701 this GUID is not available. One service group (one set of web service consumer proxies) may point to many provider systems. A logical port is listed that has the Creation Type value set to Created based on profile 7. Configuring the Consumption Model using the Business Scenario 1. All rights reserved. 1. Choose Finish . Open transaction pfcg in the SAP Gateway system. 3. define a role for which the administrator should assign the list of users (who has access to execute the functionality). Configuring the Destination Finder The provider systems configured from the transaction SOAMANAGER have to be entered in the configuration of the Destination Finder so that during runtime. Creating system alias for each of these systems. To obtain the URL of a WSDL. Identify the list of SAP ERP and BI systems (for Reporting Management) on which the functionality should be accessible by SAP Gateway. Save the Role . you can manually create a logical port as mentioned below: Choose Create Logical Port . The roles must be defined/created on the SAP Gateway server. 7. Enter a name for the role in the Role field. proceed as follows: 1.6. Choose the Authorization tab. 3. /IWCNT/RT_ADMIN_REP /IWCNT/RT_USER_REP Authorization The user must have the following authorizations in the SAP Gateway system to access SAP Gateway services for Reporting Management: Authorization Object S_SERVICE S_RFC Field Field Values SRV_NAME 4268DA7530FAD3798A64BA7232FC0D SRV_TYPE HT RFC Name /IWCNT/RFC_REPORT_RESULT_SET RFC Type - FUGR. 3.4. which should be the same as Provider System created in the consumer system. For each of these systems.If no logical port is listed. Enter the URL to a WSDL or select a file. Choose a name and description. 4.2 Settings for Reporting Management The following settings must be performed for Reporting Management: Settings for Reporting on SAP Gateway Configuring Subscriptions for Report Results Settings for Reporting Administration 1. In the transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver SAP Gateway Former Development Generic Channel Configuration Connection Settings SAP Gateway to SAP System Manage SAP System Aliases 2. Enter a WS provider system in the WS Provider System field. The Reporting Management users should be assigned to these roles so that they can receive report templates and can execute the reports. or it is not possible to create logical ports via the business scenario. Choose Change Authorization .1 Settings for Reporting Management on SAP Gateway SAP Gateway Reporting Management application is a comprehensive solution for accessing SAP NetWeaver BI (Business Intelligence) and SAP ERP reports from any device or platform.4. All rights reserved. You must be an SAP Gateway administrator or have an SAP user administrator to create the roles. 2. For information on changing roles. If there is only one SAP ERP or BI system and all the users on SAP Gateway should be able to access Reporting Management functionality on this system then role creation and assigning of roles to GSDO groups is optional but this is not recommended. 1. FUNC ACTVT 16 S_TCODE TCD-SICF PUBLIC © 2014 SAP SE or an SAP affiliate company. 6.4.6. 2.2. 8. 1. For this: 1. 2. Note 1. the GSDO can select the right provider system for a given system alias. To create roles. Creating Roles You must create roles for Reporting Management and assign these roles to the Reporting Management GSDO group. see Checking the created endpoints section in Creating a New Profile in the Provider System. 5. see Changing Standard Roles. Role Templates Use the predefined role templates mentioned below to create user roles for SAP Gateway Reporting Management.4. Page 88 of 95 . Choose Generate to create a new role. Choose the template mentioned in the Role Templates section. Choose Single Role . Choose Assign User Roles on the dialog structure. Description PUBLIC © 2014 SAP SE or an SAP affiliate company. 6. 1. In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver SAP Gateway Former Development Generic Channel Former Development Generic Channel Administration General Settings Manage GSDO Groups and click the Activity icon. Enter the role name in the Assign User Roles column. WS Provider System Leave it blank. 3. IW_SD_REPT or IWRPMD ). Proceed as follows: 1.2 Configuring Subscriptions for Report Results Subscription is required to get the report results upon execution of a Report. . In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver SAP Gateway Administration General Settings Manage GSDO Groups and click the Activity icon. Local SAP GW Leave unchecked if the Reporting Management system is not on the same system as the SAP Gateway system. 5. 7. Select the GSDO Group ( IWREPT . In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver Configuration Connection Settings SAP Gateway to SAP System 2. Save your settings. For example.While creating role template in the SAP ERP/BW system. from the Manage GSDO Groups list. 6. 2. In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver Configuration Subscription Settings Maintain Subscription Settings for GSDO 2. Description Descriptive text for the system alias. Software Version ERP . For example. Assigning Roles to a GSDO Group Proceed as follows: 1. BKDCNT200 . Choose Assign SAP System Aliases on the dialog structure. 2. from the Manage GSDO Groups list. Save your settings. Page 89 of 95 . You need to configure subscription settings for GSDO. Save your settings. RFC Destination Specify the RFC destination defined for your SAP system. IW_SD_REPT or IWRPMD ). All rights reserved. 3. Description SAP System Alias Name of the system alias. 4. 3. Choose New Entries .6. Choose New Entries . include the authorizations provided in the table below. BW or DEFAULT depending on the Reporting system you are using.4. Enter the following details for the system alias: Field SAP Gateway Manage SAP System Aliases Former Development Generic Channel and click the Activity icon. 3. Choose New Entries . The user must have these authorizations in the SAP Reporting Management systems (ERP/BW) to access SAP Gateway services for Reporting Management: Reporting Management System SAP ERP system SAP BI system Authorization Object Field S_RFC S_RFC Field Value RFC_TYPE FUGR RFC_NAME /OSP/R3_REPORT ACTVT 16 RFC_TYPE FUGR RFC_NAME /OSP/BW_REPORT ACTVT 16 Settings in the SAP Gateway System You need to perform the following customizing settings in the SAP Gateway system: Creating SAP system aliases Assigning roles to a GSDO group Assigning SAP system aliases to a GSDO group Creating SAP System Aliases 1. 4. Leave it checked it if the Reporting Management system is on the same system as the SAP Gateway system. 4. Choose New Entries . for example. Press F4 to select a system alias in the SAP System Alias column. Select the GSDO Group ( IWREPT . 5. Enter the role name created above ZMANAGER in the User Role column. Enter the following details in the Maintain Subscription Settings for GSDO screen: Field SAP Gateway Former Development Generic Channel and click the Activity icon. Assigning SAP System Aliases to a GSDO Group Proceed as follows: 1. ZMANAGER .4.2. 4. proceed as follows: 1. You can also configure a new report. The page displays the source systems for reports that have been defined. Default Select this checkbox to specify the format as the default format for the report type. Requirements Other important configurations like system alias. Field SAP Gateway Content Reporting Administration and click the Activity icon.4. The source systems. Maintaining Source Systems. Description Report Delivery Format Enter the format in which the report should be delivered. 7.2. 1. 3.6. types.4.2. Choose New Entries to define a new report type. Save your settings. source system. report types and formats you maintain here are displayed in the customizing activity Manage Reports and their Properties. Choose New Entries to specify a new format. 3. proceed as follows: 1.6.6. Select a report source type and double-click Manage Report Types . 8.3 Settings for Reporting Administration The following configurations must be performed on the Reporting Administrator IMG to retrieve the data requested by the users: Manage Source Systems. 6. File Type Delivery Format Description Enter a description for the delivery format. Report Types and Report Formats To maintain source systems.3. 5. The page lists all report formats that have been defined for the report type. Report Types and Formats 2. 4. Report Types and Formats and click the Activity icon. and context variables must be defined. select a row and double-click Manage Formats . In the Manage Report Types view. Enter a name and description for the report type.2 Managing Reports and their Properties You can manage a report assigned to the SAP Gateway. report types and report formats. The formats you have configured in the Delivery Formats view is displayed here.2. SAP NetWeaver SAP Gateway Content Reporting Administration Peripheral Settings Manage Source Systems. Report Types and Formats Manage Reports and their Properties Manage Categories Manage Context Variables Configure System Time points Manage System Time points and Data Change Events 1. categories. edit its properties. Choose New Entries to define a new format. The page displays the report types that have been configured for the source system. All rights reserved.4. In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver Peripheral Settings Manage Source Systems. Save your settings. Save your settings.1 Managing Source Systems. Page 90 of 95 . Maintaining Report Delivery Formats To maintain report delivery formats. Select a report delivery format from the Delivery Formats section and double-click Manage Source Systems . Event Group ID REPORT_RESULT_NOTIF Description Event for Report Result Set XNotification Type IWCNT~OM_REPORT_PUSH_NOTIF No Backend Check this option.GSDO Type IWCNT~OM_REPORT_RESULT_SET SAP System Alias Name of the SAP Gateway system alias. and delivery formats. The reports configured here must already PUBLIC © 2014 SAP SE or an SAP affiliate company. Report Types and Formats activity allows you to maintain report source systems. 1. Report Types and Formats Manage Source Systems. Field Description Report Delivery Format Select a delivery format here.4.3.4. In transaction SPRO open the SAP Reference IMG and navigate to: 2. Delivery Format Description Enter a description for the delivery format. Save your settings.4. the Based on user-defined scheduling checkbox is also selected. If this checkbox is selected. Category Select the category of the report. the user is allowed to schedule when the report should be run. (Data change events refer to events that can trigger a report run when certain conditions are met and data in the SAP system are changed.2. the Based on user-defined scheduling checkbox is also selected. If this checkbox is not selected. the user is allowed to run the report based on data change events. This checkbox is enabled only if at least one data change event is configured. Query Name Press F4 in one of these fields and select a value. proceed as follows: 1. 5. enter the following values: Field SAP System Alias Description Select the source system from which the report is derived.2.4. Page 91 of 95 . Choose New Entries to create a new report. specify the following values: Field Description Immediately If this checkbox is selected. ALV Layout Variant Select a layout for the report. Work Area.4. This checkbox is available only if at least one role is maintained for the report.6. Forward Report Template Not applicable. then If there are report settings created with free scheduling for the master template. PUBLIC © 2014 SAP SE or an SAP affiliate company.exist in the RFC destination. In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver SAP Gateway Content Reporting Administration Report Settings Manage Reports and their Properties and click the Activity icon. 6. Based on time points If this checkbox is selected.) If this checkbox is selected. All rights reserved. 2. select one of the following options: Field Description Existing documentation Select this option to display the existing report documentation to users. In the Report Source and Type section. Data change events are configured in the Report Scheduling view. Report Type Choose the report type. Configuring a New Report Configuring Report Parameters Configuring Multiple Values for a Parameter Configuring Delivery Formats for a Report Specifying Roles for a Report Report Scheduling 1. The other two fields are automatically populated with their corresponding values. Note This is specific to SAP ERP query. All reports that have been configured are listed. the user can run the report any time. Report Title Enter a title for the report. those along with the corresponding jobs on the backend gets deleted. Note Choose the source system based on the type of report (ERP or BW). the user is allowed to run the report based on time points. In the Report Properties section.) Note This option is available only for BW reports. 3. Note This checkbox is enabled only if at least one time point is maintained. 4. User Group. In the Allow Users to Run the Report section. Report Description Enter a description for the report.3.1 Configuring a New Report To configure a new report. specify the following values: Field Description Technical Name Enter the technical name of the report. Active Select the checkbox to make the report available to the users. Custom documentation Select this option if you would like to create a new documentation for the report. In the Display Documentation to End users section. Based on user-defined scheduling If this checkbox is selected. It is executed immediately and is delivered to the user’s client when ready. Based on data change events If this checkbox is selected. (Time points are specified in the Report Scheduling view. in the Report Parameters and Values view. Page 92 of 95 .4.6.2. This option only specifies the default display. which has the lowest parameter order is displayed and this cannot be modified. Radio Buttons Group Name If you want to group certain parameters together and display them as a series of radio buttons. the report considers these dates when run.2. All reports that have been configured are listed. and the group name Country for parameters One country and Several countries . Double-click Report Parameters and Values in the dialog structure on the left. Save your settings. Note In case a particular parameter has multiple parameter values then the value.3 Configuring Multiple Values for a Parameter To configure multiple values for a parameter. Double-click Report Parameters and Values in the dialog structure on the left. 1. Save your settings. 3. In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver SAP Gateway Content Reporting Administration Report Settings Manage Reports and their Properties and click the Activity icon. 1. All reports that have been configured are listed. The user can still select other conditions for the value.6. Enter the following values for the editable fields: Field Description Order For each parameter. For example. 3. The page lists all values that have been configured for the parameter. Mandatory Select the checkbox if it is mandatory for the users to enter a value for the parameter. Parameter Name Change the name of the parameter. All rights reserved. it indicates that the F4 option is available. PUBLIC © 2014 SAP SE or an SAP affiliate company. click the Check icon (or press CTRL F7 ) to check if all configurations for the report are correct. 4. Default Low/From Value Enter the default starting value to be displayed for parameters that require a range of values. proceed as follows: 1. Choose a report from the Manage Reports and their Properties view list.2. Sign Select Inclusive here to query reports that are within the values specified in the parameter.6. Default High/To Value Enter the default ending value to be displayed for parameters that require. You cannot edit this option. Choose a parameter for which multiple values can be configured. the checks are carried out for all displayed reports. 7. For example.4. In transaction SPRO open the SAP Reference IMG and navigate to: 2. Default Condition Select the default condition to be displayed for the parameter. 6.3. SAP NetWeaver SAP Gateway Content Reporting Administration Report Settings Manage Reports and their Properties and click the Activity icon. Choose New Entries to define a new value. enter group names for each set of radio buttons. Save your settings. This runs the report /IWCNT/R_REPORT_CONFIG_CHECKS . enter a number to represent the order in which it should be displayed to the user. All reports that have been configured are listed.None Select this option to not display any report documentation to users.4. Tomorrow and Specify Date . 5. if the parameter dates specify August 01 to August 30. F4 Availability If this option is enabled. The parameters of the report are listed. In transaction SPRO open the SAP Reference IMG and navigate to: Report Settings Manage Reports and their Properties SAP NetWeaver SAP Gateway Content Reporting Administration and click the Activity icon. Choose a report from the Manage Reports and their Properties view list. 2. Enter the default conditions for the new parameter value. and whether it should be editable if displayed. 1. you could enter the group name Date for parameters Today . If you run this report from the main Manage Reports and their Properties view where all the reports are listed.4.2.4. Double-click Define Multiple Values in the dialog structure on the left.3. 4.2 Configuring Report Parameters To configure report parameters. After you have configured the report. proceed as follows: 1. proceed as follows: 1. Display Specify whether the parameter should be displayed to users or not.4.4 Configuring Delivery Formats for a Report To configure delivery formats for reports.2.2. The parameters of the report are listed. Context Variable Enter the context variable for the parameter.3. Context Group Specify the context group for the parameter. 1. Save your settings.4. 3. 3. Choose a report from the Manage Reports and their Properties view list. Save your settings. Context variables can be assigned to a context group and a data type can be specified for each group.6. select a report and double-click Report Formats for Report Type in the dialog structure on the left. 4. Save your settings. 2. Enter a name and description for the category.4.2.2. All rights reserved. The page lists all delivery formats that have been specified for the report. 4. Double-click Report Scheduling in the dialog structure on the left.6. 3. In the Manage Reports and their Properties view.6. Context variables make entering parameter values easy for users. 1.4. proceed as follows: 1.2.6 Report Scheduling To define scheduling for a report.3 Managing Categories Each report configured can have a category assigned to it. For example. 4. Event Description Enter a description for the time point or data change event. In the Role field.2.3. Double-click Report Roles in the dialog structure on the left. The parameters of the report are listed. Configure the following values for a format: Field Description Format Select the report format.3. You can add.4.4 Managing Context Variables You can define context variables for various tasks.4. press F4 and choose a role. Only categories that are defined here are displayed in the activity Manage Reports and their Properties.4. 3. 5. modify and delete report categories. Display Choose whether running a report based on this schedule should be allowed or not allowed. Choose a report from the Manage Reports and their Properties view list. You can also specify whether the format should be the default format if allowed.2.6. 2.4. You can also specify whether the schedule should be the default schedule if allowed. 2. The page lists all scheduling options that have been defined for the report. You can modify these and also create new ones. All reports that have been configured are listed. proceed as follows: 1. instead of having to select exact dates from a displayed calendar.Report Settings Manage Reports and their Properties and click the Activity icon. 1. Choose New Entries to define a new category. Standard Settings Five context variables are predelivered in the system. Event Name Enter the name of the time point or data change event. 2. tomorrow and this year . proceed as follows: 1. To create a new category.4. Page 93 of 95 . All reports that have been configured are listed. Deletion of a category is not allowed unless all the report templates under the category are moved to a different category or deleted. Choose a report from the Manage Reports and their Properties view list. Double-click Report Formats in the dialog structure on the left. In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver SAP Gateway Content Report Administration Report Settings Manage Categories and click onthe Activity icon. In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver SAP Gateway Content Reporting Administration Report Settings Manage Reports and their Properties and click the Activity icon.2. In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver SAP Gateway Content Reporting Administration Report Settings Manage Reports and their Properties and click the Activity icon. Display Select whether the format should be allowed or not allowed. Maintaining Context Groups Proceed as follows: PUBLIC © 2014 SAP SE or an SAP affiliate company. Save your settings.3. Configure the following values for a scheduling option: Field Description Type Choose if the report should be run based on a time point or a data change event. you can create context variables for dates such as today . Choose New Entries . Users can select such relative values when running a report. The page lists all roles that can access the report. All reports that have been configured are listed. 1.3. 5.5 Specifying Roles for a Report To specify roles for a report. choose Save . For example. and Exec. To define the schedule using background jobs. Choose New Entries to define a new context group Field Description Context Group Enter a name for the context group. 2. Maintaining Context Variables Proceed as follows 1. In the Manage Context Groups view.6. Value Type Select the data type for the context group.1. enter the following names to create two steps for the job with the following: RSRD_BROADCAST_FOR_TIMEPOINT /OSP/IW_TIMEPOINT_PROCESS 10. 5. In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver SAP Gateway Content Reporting Administration Report Settings Manage Context Variables and click the Activity icon. 4. 8. 2.6 Managing System Time points and Data Change Events PUBLIC © 2014 SAP SE or an SAP affiliate company. Context Group Description Enter the name of the time point or data change event. Choose New Entries to create a new variable. Enter a name for the new background job in the Job Name field. 6. In the Manage Context Variables view. Save your settings. Choose Save .2. 3.2.4. Choose Date/Time . a date range). Save your settings. Define and subscribe the system time points for a report. Choose Periodic Values .4. and save your settings. The page lists all context variables that have been defined for the group. select a context variable and double-click Enable Context Variables on the dialog structure in the left menu. The page lists the SAP System Alias that the context variable has been mapped to. Control Type Select Parameter if the variable refers to specific values (for example. and enter the values. Field Description Context Variable Specify the technical name for the context variable to map it to an RFC destination. Save your settings. Context Variable Description Enter a description for the context variable.5 Configuring System Time Points You must configure a system time point for a report. The Create Step 1 dialog box displays. You define scheduling for the system time points by creating a background job for it.4.4. 9. Target. 3. Choose the schedule you want. you must define a schedule for them. Check Periodic Job . 2.3. Choose Start condition . TP_BROADCASTING_ERPReport001. 4. The Start Time dialog box displays.6. select a context group and double-click Manage Context Variables on the dialog structure in the left menu. 3. 4. 3. Create a background job and define a schedule for it. Class Select the class name. Status. a date). 2. Before you define the system time points for a report. Choose New Entries to define a new system. In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver SAP Gateway Content Reporting Administration Report Settings Manage Context Variables and click the Activity icon. Select Select-Options if the variable refers to relative values (for example. Note Do not change the default values for Job class. Choose Step from Define Background Job screen. All rights reserved.3. Field Description SAP System Alias Select the SAP System Alias of the system to locate the class. 1. and from Job in the Define Background Job menu bar. Go to transaction SM36. Page 94 of 95 . 7. In Program name under ABAP program. In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver SAP Gateway Content Reporting Administration Report Settings Manage Context Variables and click the Activity icon. 1. Maintaining Context Variables Mappings Proceed as follows 1. proceed as follows: 1. In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver SAP Gateway Content Reporting Administration Report Settings Manage System Time Points and Data Change Events and click the Activity icon. Choose Date/Time to schedule date and time. Enter a name for the process chain and choose Continue . 15. Save your settings. and then the Activate and Schedule icon. Click the Process Types icon to load all available process types. Click the Create icon to create a new event and give it a name and a description. weekly. Choose Period Values. Click the Execute icon with ‘P_ONLINE’ checked. The Status column shows the status of items that have been updated or deleted. You can test whether the event data change is functional. Choose Create to create a new process chain. and activating it. Under Load Process and Post Processing . The Insert a Start Process dialog is displayed. 5. every hour. Go to transaction RSPC. so that they can be used by reports and run at such frequencies. Time points refer to frequencies (for example. 7. Choose Start Process and move the pointer over the event data change. proceed as follows: 1. every 2 days. Click the Activate icon. 2. proceed as follows: 1. Events data changes are associated with a process chain. You can create time points there.Note You must manage events data change only for Business Intelligence (BI) reports. All rights reserved. 3. Testing involves modifying data from an Info cube. 13. 4. 9. 2. 8. 11. defining a schedule. other periods). Select the name of the Info cube for which you have defined the event data change. select Trigger Event Data change (for broadcaster) to insert the variant of the process chain. This inserts the newly created event data change in the process chain. proceed as follows: 1. The Info cube (Info provider) for which you created the event data change is displayed. 16. Choose Change Selections . Choose Create and enter a name and description for the variant. 3. Page 95 of 95 . 14. and define the schedule. which is a sequence of processes waiting in the background for an event. every Saturday) that are defined and used by various jobs and schedulers. 6. Go to transaction RSRD_START. Check the Active checkbox for time points and data change events that should be used to configure reports. Click Refresh to retrieve the latest list of system time points and data change events. Defining Time Points and Data Change Events To check whether the event data change is functional. daily. 12. These time points and events are now available in the activity Manage Reports and their Properties . 3. Save your settings. 2. monthly. PUBLIC © 2014 SAP SE or an SAP affiliate company. Select the schedule you want to use (hourly. 10. An event signals that a particular situation has occurred in the system and specific background processing that is waiting for this event must be activated accordingly. Create a process variant as the start process of the chain. Press F4 to select the Info cube (Info provider). Choose Periodic Job . Select the relevant application server to activate and schedule. You configure events data change by creating a variant of process chain. To define time points and data change events. Creating Variant for a Process Chain and Define Schedule To create a variant for a process chain.