SAP Gateway

SAP Gateway PDF download from SAP Help Portal: http://help.sap.com/saphelp_gateway20sp11/helpdata/en/71/376ab03f824ea5bfd0a0e3a307205b/frameset.htm Created on January 09, 2016

The documentation may have changed since you downloaded the PDF. You can always find the latest information on SAP Help Portal.

Note This PDF document contains the selected topic and its subtopics (max. 150) in the selected structure. Subtopics from other structures are not included. The selected structure has more than 150 subtopics. This download contains only the first 150 subtopics. You can manually download the missing subtopics.

© 2016 SAP SE or an SAP affiliate company. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP SE. The information contained herein may be changed without prior notice. Some software products marketed by SAP SE and its distributors contain proprietary software components of other software vendors. National product specifications may vary. These materials are provided by SAP SE and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty. SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP SE in Germany and other countries. Please see www.sap.com/corporate-en/legal/copyright/index.epx#trademark for additional trademark information and notices.

Table of content

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

Page 1 of 95

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

1.4.4.5.1 Code List Usage 1.4.4.5.2 Customizing the SAP Gateway System for Code List 1.4.4.5.3 Code List Cache Cleanup 1.4.4.6 Configuration Settings for Generic Channel Scenarios 1.4.4.6.1 Settings for Customer Relationship Management on SAP Gateway 1.4.4.6.1.1 Configuring GSDO to Connect to the SAP CRM System 1.4.4.6.1.1.1 SOA Management Configurations on SAP CRM System 1.4.4.6.1.1.1.1 Creating a New Profile in the Provider System 1.4.4.6.1.1.1.2 Configuring Provider Systems 1.4.4.6.1.1.2 SOA Management Configurations on SAP Gateway System 1.4.4.6.1.1.2.1 Creating a Provider System in the Consumer System 1.4.4.6.1.1.2.2 User Account Management 1.4.4.6.2 Settings for Reporting Management 1.4.4.6.2.1 Settings for Reporting Management on SAP Gateway 1.4.4.6.2.2 Configuring Subscriptions for Report Results 1.4.4.6.2.3 Settings for Reporting Administration 1.4.4.6.2.3.1 Managing Source Systems, Report Types and Formats 1.4.4.6.2.3.2 Managing Reports and their Properties 1.4.4.6.2.3.2.1 Configuring a New Report 1.4.4.6.2.3.2.2 Configuring Report Parameters 1.4.4.6.2.3.2.3 Configuring Multiple Values for a Parameter 1.4.4.6.2.3.2.4 Configuring Delivery Formats for a Report 1.4.4.6.2.3.2.5 Specifying Roles for a Report 1.4.4.6.2.3.2.6 Report Scheduling 1.4.4.6.2.3.3 Managing Categories 1.4.4.6.2.3.4 Managing Context Variables 1.4.4.6.2.3.5 Configuring System Time Points 1.4.4.6.2.3.6 Managing System Time points and Data Change Events

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

Page 4 of 95

1 SAP Gateway Product Information Product

SAP Gateway

Release

2.0

Documentation Published

August 2015

Use SAP Gateway is a development framework, which is available as an SAP NetWeaver Application Server ABAP (AS ABAP) add-on, which you can install on top of your existing SAP Business Suite or application platform. SAP Gateway offers development and generation tools to create OData services to a variety of client development tools. Put simply, it establishes a connection between SAP Business Suite data and target clients, platforms, and programming framework. SAP Gateway provides the following functionality: Runtime environment for SAP solutions that integrates desktop programs with SAP systems Runtime features, including user interface, secure data access, database connectivity, and network communications for managing applications running on top of the framework Infrastructure and tools for developing applications to run on the framework or to enhance SAP solutions that integrate desktop programs with SAP systems Connection to multiple SAP systems regardless of their versions

SAP Gateway

The software offers service generation tools that allow you to reuse existing data sources in creating the models and by that, speed up development time. The tools enable you to generate models based on existing: Business objects that can be selected from the Business Object Repository (BOR) Remote function modules Dynpro screens The tools do not require coding and allow not only to reuse exiting business objects or screens but also allow no-code based data adaptation capabilities. Data coming from multiple objects can be aggregated, filtered and adapted based on the client application requirements. The software also offers a tool to develop models. This tool is based on the ABAP Workbench (SE80) and requires ABAP coding skills.

Documentation Structure The SAP Gateway documentation consists of the following sections: What's New in SAP Gateway 2.0 SPS 10 SAP Gateway Master Guide SAP Gateway Installation Guide SAP Gateway Configuration Guide

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

Page 5 of 95

SAP SAP SAP SAP

Gateway Technical Operations Guide Gateway Security Guide Gateway Developer Guide Gateway Content Guide

Disclaimer Features of the standard mode, introduced with Support Package 03 for SAP Gateway 2.0, are intended to be in accordance with the standards outlined in the Open Data Protocol Specification v2.0 (see http://odata.org ). Therefore, any deviation from this standard is not intentional and is subject to change. Consequently, all client implementations shall be validated against the Open Data Protocol Specification. Do not use objects in the /IWCOR namespace. Only use official APIs.

Recommendation We strongly recommend using the OData Channel (ODC) programming paradigm for all SAP Gateway development. As of SAP Gateway 2.0 Support Package 05, you are strongly recommended to use the Service Builder (transaction SEGW) for your OData design-time development . For more information, see SAP Gateway Service Builder. Depending on whether you want to develop SAP Gateway content in an SAP Business Suite backend system or in an SAP Gateway hub system, you can choose between embedded deployment or central hub deployment. For more information, see Embedded Versus Hub Deployment and Deployment Options.

SAP Gateway uses the open source jQuery JavaScript Library v1.6.2: http://jquery.com/ Copyright 2011, John Resig Dual licensed under the MIT or GPL Version 2 licenses. http://jquery.org/license Includes Sizzle.js http://sizzlejs.com/ Copyright 2011, The Dojo Foundation Released under the MIT, BSD, and GPL Licenses.

References You can find additional information about SAP Gateway in SAP Note 1560585 Further release constraints are listed in SAP Note 1574568

.

.

Sizing information for SAP Gateway is available on the SAP Service Marketplace in the Quick Sizer Tool under http://service.sap.com/sizing Sizer Tool . You can use the Quick Sizer Tool for your hardware calculations for your system landscape.

and Quick

The SAP Community Network (SCN) offers additional information, such as community discussions, blogs, forums, etc. under http://scn.sap.com/community/gateway

.

1.1 What's New in SAP Gateway 2.0 SPS 11 This part of the SAP Gateway Library gives you an overview of what is new in SAP Gateway 2.0 Support Package Stack 11. This information is provided as Release Notes. Area

Details

Framework, runtime and metadata

What's New in the SAP Gateway Framework

1.1.1 What's New in the Framework Technical Data Product Version

SAP Gateway 2.0 SPS 11

Area

Technology & Innovation Platform

Country Relevance

Valid for all countries

The SAP Gateway framework and runtime offer a variety of new and enhanced functions in the latest support package.

New Name SAP NetWeaver Gateway is rebranded to a new name SAP Gateway. This new name, SAP Gateway, is reflected in UIs for all the software components and also in the documentation.

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

Page 6 of 95

Service Context Facade For application development and monitoring the framework offers a service context façade. For more information, see Service Context Facade.

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

Vocabulary-Based Annotations It is possible to define vocabulary-based annotations in a way that simple values of type STRING can be language-dependent, that is, have different values depending on the language defined in the client’s request. For more information, see Vocabulary-Based Annotations.

$filter on Navigation $filter is supported on navigation properties. For more information, see System Query Option APIs.

Message Text Enhancements Message target enhancements are provided with regard to the path relatively to the resource path in the URL. For more information, see /IWBEP/IF_MGW_CONV_SRV_RUNTIME.

Metadata Filter Value List You can use filter options for value lists. For more information, see Metadata Filtering Value List.

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

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

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

Metadata Texts You can bind data elements for text reference usage in properties. For more information, see method BIND_DATA_ELEMENT_FOR_TEXT of interface /IWBEP/IF_MGW_ODATA_PROPERTY.

Routing A mapping of system ID to system alias via the HTTP response header is provided. For more information, see Catalog Service.

1.2 SAP Gateway Master Guide The SAP Gateway Master Guide provides you with a starting point for implementation and provides an overview of the required SAP components. The Master Guide comprises the following: General Overview SAP Gateway and OData Development Overview SAP Gateway Service Builder Deployment Options Embedded Versus Hub Deployment Glossary

Documentation Structure For more information, the documentation for SAP Gateway also includes the following guides:

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

Page 7 of 95

SAP SAP SAP SAP SAP SAP

Gateway Gateway Gateway Gateway Gateway Gateway

Installation Guide Configuration Guide Technical Operations Guide Security Guide Developer Guide Content Guide (including Workflow)

1.2.1 General Overview SAP Gateway facilitates easier provisioning and consumption of business logic and content of SAP backend systems for mobile and Web applications. It aims to reduce the complexity and the skill set required to access SAP data, thereby removing deployment barriers. Simple interfaces also help to shorten development times. SAP Gateway enables people-centric applications to consume SAP Business Suite data through popular platforms and devices (such as the iPad and Blackberry) in an easy and standards-based manner. It is a framework that connects business users to SAP systems using consumer technologies, groupware, and mobile devices and is based on open standards (such as the Atom Publishing Protocol and OData) that offer simple services based on the REST principle. Depending on your development requirements and where you want to develop SAP Gateway content, you can install SAP in either an SAP Business Suite backend system (embedded deployment) or in an SAP Gateway hub system (central hub deployment). For more information about the deployment options and available software components, see Deployment Options. SAP Gateway uses OData protocol. OData is based on industry standards and offers database-like access to business data using REST-based architecture. For its consumption outside of SAP, no knowledge of SAP structures is required and it supports object navigation. Dynamic binding takes place at runtime. OData can be easily consumed by various platforms and it offers flexibility (filtering, query options). OData for SAP comprises OData plus SAP annotations.

Note While SAP Gateway uses OData, the OData implementation in place is not a full implementation according to the official OData specification at www.odata.org

. This restriction applies to all OData versions.

OData for SAP

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

More Information For more information see OData Channel.

1.2.2 SAP Gateway and OData By exposing SAP Business Suite functionality as REST-based OData (Open Data Protocol) services, SAP Gateway enables SAP applications to share data with a wide range of devices, technologies, and platforms in a way that is easy to understand and consume. Using REST services provides the following advantages: Obtain human readable results; you can use your browser to see what data you will get. Use stateless applications Receive related pieces of information, one leading to another. Use standard GET, PUT, POST, DELETE, and QUERY. If you know where to GET data, you know where to PUT it, and you can use the same format.

What Is OData and Why Do we Use It? OData is a Web protocol for querying and updating data, applying and building on Web technologies such as HTTP, Atom Publishing Protocol (AtomPub), and RSS (Really Simple Syndication) to provide access to information from a variety of applications. It is easy to understand and extensible, and provides consumers with a predictable interface for querying a variety of data sources. AtomPub is the standard for treating groups of similar information snippets as it is simple, extensible, and allows anything textual in its content. However, as so much textual enterprise data is structured, there is also a requirement to express what structure to expect in a certain kind of information snippet. As these snippets can come in large quantities, they must be trimmed down to manageable chunks, sorted according to ad-hoc user preferences, and the result set must be stepped through page by page. OData provides all of the above as well as additional features, such as feed customization that allows mapping part of the structured content into the standard Atom elements, and the ability to link data entities within an OData service (via “…related…” links) and beyond (via media link entries). This facilitates support

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

Page 8 of 95

of a wide range of clients with different capabilities: Purely Atom, simply paging through data. Hypermedia-driven, navigating through the data web. Aware of query options, tailoring the OData services to their needs. OData is also extensible, like the underlying AtomPub, and thereby allows the addition of features that are required when building easy-to-use applications, both mobile and browser-based.

OData for SAP Products SAP Gateway uses OData for SAP Products, which contains SAP-specific metadata that helps the developer to consume SAP business data, such as descriptions of fields that can be retrieved from the SAP ABAP Dictionary. The following are examples of OData for SAP applications: Human-readable, language-dependent labels for all properties (required for building user interfaces). Free-text search, within collections of similar entities, and across collections using OpenSearch. OpenSearch can use the Atom Syndication Format for its search results, so the OData entities that are returned by the search fit in, and OpenSearch can be integrated into AtomPub service documents via links with rel=”search”, per collection as well as on the top level. The OpenSearch description specifies the URL template to use for searching, and for collections it simply points to the OData entity set, using a custom query option with the name of “search”. Semantic annotations, which are required for applications running on mobile devices to provide seamless integration into contacts, calendar, and telephony. The client needs to know which OData properties contain a phone number, a part of a name or address, or something related to a calendar event. Not all entities and entity sets will support the full spectrum of possible interactions defined by the uniform interface, so capability discovery will help clients avoiding requests that the server cannot fulfill. The metadata document will tell whether an entity set is searchable, which properties may be used in filter expressions, and which properties of an entity will always be managed by the server. Most of the applications for “light-weight consumption” follow an interaction pattern called “view-inspect-act”, “alert-analyze-act”, or “explore & act”, meaning that you somehow navigate (or are led) to an entity that interests you, and then you have to choose what to do. The chosen action eventually results in changes to this entity, or entities related to it, but it may be tricky to express it in terms of an Update operation, so the available actions are advertised to the client as special atom links (with an optional embedded simplified “form” in case the action needs parameters) and the action is triggered by POSTing to the target URI of the link.

Note While SAP Gateway uses OData, the OData implementation in place is not a full implementation according to the official OData specification at www.odata.org

. This restriction applies to all OData versions.

1.2.3 Development Overview The creation of data models is an integral part of the development process for SAP Gateway. You can create, edit, and display the data models on which you base an OData service for SAP Gateway either in the Service Builder (transaction SEGW) or in the ABAP Workbench (transaction SE80). The Service Builder not only enables you to define data models, but rather create and maintain complete OData services for SAP Gateway. The Service Builder is a dedicated design-time transaction, which provides a toolset for creating services easily and efficiently and it supports the entire service development lifecycle. The Service Builder succinctly blends new and existing ABAP development tools in an OData-compliant modeling transaction. The Service Builder supports the following development phases for OData services: 1. Data Model Definition 2. Service Implementation 3. Service Maintenance

More Information For more information about the new Service Builder, see SAP Gateway Service Builder. For more information, see SAP Gateway Developer Guide.

1.2.4 SAP Gateway Service Builder The Service Builder (transaction SEGW) provides an easy-to-use set of tools for creating OData services. It supports developers throughout the entire development and modeling process.

Prerequisites To use SAP Gateway Service Builder, you must install the Add-On IW_BEP. Depending on your system landscape, you can install this Add-On either in an SAP Gateway system or in an SAP Business Suite system. If your system is based on SAP NetWeaver 7.40 or higher, you do not need to install IW_BEP since the core SAP Gateway component SAP_GWFND 740 is installed as standard and includes the functional scope of IW_BEP. For more information, see Deployment Options.

Project-Based Service Development The Service Builder introduces a new service development concept, which is organized around projects. Projects are used to store the artifacts developers need to create a service and a data model together in one place. Since projects consolidate all related data, developers can easily work on multiple projects in parallel and reuse data between projects before generating and activating the actual service.

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

Page 9 of 95

More Information For more information about the Service Builder, see SAP Gateway Service Builder. For detailed information about the end-to-end service development process, see the Service Builder cookbook, Getting Started with the Service Builder.

1.2.5 Deployment Options Depending on your preferred system landscape, different deployment options are available for SAP Gateway. Central hub deployment: service development in the SAP Business Suite backend system Central hub deployment: service development in SAP Gateway hub system Embedded deployment: service development in the SAP Business Suite system This section describes the two deployment options available for SAP Gateway: Central hub deployment of SAP Gateway core components IW_FND and GW_CORE in an SAP Gateway hub system. As of SAP NetWeaver 7.40, the core software component for SAP Gateway is SAP_GWFND, which contains the composite functional scope of IW_FND, GW_CORE, IW_BEP, and IW_HDB. Embedded deployment of SAP Gateway core components IW_FND and GW_CORE in an SAP Business Suite backend system. As of SAP NetWeaver 7.40, the core software component for SAP Gateway is SAP_GWFND, which contains the composite functional scope of IW_FND, GW_CORE, IW_BEP, and IW_HDB. For more information about the SAP Gateway components, see Installing SAP Gateway Components and the SAP Note 1569624 All SAP Gateway 2.0 components are non-modifying components. For more information, see SAP Note 1569624

.

.

Embedded or Central Hub Deployment? You can install SAP Gateway independent of consumer technologies, however the software components installed for the consumer technologies must also be installed on one SAP Gateway server. You can connect multiple consumer technologies to one SAP Gateway instance. Deployment options: Central hub deployment: The SAP Gateway core components can be deployed in a standalone system, either behind or in front of the firewall. In addition, you can install the optional components for central hub deployment in your standalone system. For SAP NetWeaver 7.02, 7.03, and 7.31 you can install the component IW_BEP either in this hub system and/or in the backend system. For SAP NetWeaver 7.40 and higher, the core component SAP_GWFND is installed as standard and includes the functional scope of IW_BEP. Embedded deployment: The core components for SAP Gateway and any optional backend components are deployed together in the SAP Business Suite backend system. For this deployment option, you need a backend system only, and not a dedicated SAP Gateway central hub system. For information about how to choose the most suitable deployment option for your system landscape, see Embedded Versus Hub Deployment.

Central Hub Deployment Central hub deployment of SAP Gateway has the following advantages: Routing and composition of multiple systems is supported. Dedicated SAP Gateway content is available. Content can be deployed without touching the SAP Business Suite backend system. Decoupled lifecycle of consumer applications from the SAP Business Suite backend system. Central management of routing and connectivity with SAP Business Suite backend systems. SAP Gateway capabilities need to be deployed only once within the landscape. Better security, as a request is validated at the dedicated box and consequently attacks on the SAP Gateway system will not automatically affect the SAP Business Suite backend system. A separate SAP Gateway system can be implemented in a demilitarized zone (DMZ) for external access. Independent innovation speed of SAP Gateway and the connected SAP Business Suite backend systems. However, note the following considerations: There will be redundant deployment of metadata or ABAP Dictionary structures. For SAP NetWeaver 7.00, 7.01,7.02, 7.03, and 7.31 you can install the component IW_BEP in each backend system. For SAP NetWeaver 7.40 and higher, the core component SAP_GWFND is installed as standard and includes the functional scope of IW_BEP

Embedded Deployment Deployment embedded in the SAP Business Suite backend system has the following advantages: Direct local access to metadata and business data. Less runtime overhead as one remote call is reduced. No content merge for different applications required. No additional, separate SAP Gateway system required. Lower total cost of ownership as there is one less system to maintain. However, note the following considerations: The innovation speed of SAP Gateway and the SAP Business Suite backend system need to be synchronized. Devices need to be integrated with the SAP Business Suite backend system on a point-to-point basis. Cross-system composition is not advisable. Central SAP Gateway content is not available. Content specific to SAP Business Suite is used in SAP Business Suite system.

Core Components for SAP Gateway

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

Page 10 of 95

The mandatory core components for SAP Gateway are listed in the following table, together with a short description of each component. You can install these components in an SAP Business Suite backend system (embedded deployment) or in an SAP Gateway hub system (central hub deployment). Name

Type

Version

Notes

IW_FND

ABAP

250

Contains core functionality of SAP Gateway as follows: Runtime components Metadata store Shared services, such as monitoring

Note For SAP NetWeaver 7.40 or higher, see SAP_GWFND. GW_CORE

ABAP

200

Contains OData libraries.

Note For SAP NetWeaver 7.40 or higher, see SAP_GWFND. SAP_GWFND

ABAP

740

Available as standard in systems based on SAP NetWeaver 7.40 or higher. This core component contains the functional scope of the core components IW_FND and GW_CORE together with the functional scope of the components IW_BEP and IW_HDB. Since this core component is included as standard in the SAP NetWeaver 7.40 delivery, you do not need to install it explicitly or the components it comprises, namely IW_FND, GW_CORE, IW_BEP, IW_HDB.

Note If you have previously created services for the Generic Channel that are still in use, you must install the component IW_FNDGC 100 in systems based on SAP NetWeaver 7.40 or higher. You only need to install this component if you have existing Generic Channel services.

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

Optional Components for Central Hub Deployment The following optional components are available: Name

Type

Version

Notes

IW_BEP

ABAP

200

Business Enablement Provisioning component. You can install this software component in an SAP Gateway central hub system to enable the implementation of OData resources in the same way as business data in a backend system.

Note If your system is based on SAP NetWeaver 7.40 or higher, you do not need to install IW_BEP since this functional scope is included in the core component SAP_GWFND, which is available as standard in the SAP NetWeaver 7.40 delivery. IW_CNT

ABAP

200

Contains well-defined content, including, for example: Metadata describing data object ABAP code for data mapping Web service consumer and server proxies

IW_CBS

ABAP

200

Contains application basis functionality, such as SAP Gateway enablement of SAP NetWeaver Business Workflow.

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

Page 11 of 95

IW_CBS applications are similar to IW_CNT applications. IW_HDB

ABAP

100

Provides business content adapter for SAP Gateway with SAP HANA that enables OData exposure of SAP HANA views. For SAP NetWeaver 7.02, 7.03, and 7.31, you can install this component in an SAP Gateway system together with IW_BEP. For SAP NetWeaver 7.40 and higher, you do not need to install component IW_HDB because the core component SAP_GWFND already includes the functional scope of IW_HDB (and IW_BEP) as standard.

IW_SPI

ABAP

100

Provides a generic OData adapter for content based on the Service Provider Infrastructure (SPI). For SAP NetWeaver 7.02, 7.03, and 7.31, you can install this component in an SAP Gateway system together with IW_BEP or in an SAP Business Suite system together with IW_BEP. For SAP NetWeaver 7.40 and higher, the core component SAP_GWFND in installed as standard and includes the functional scope of IW_BEP. Consequently you can install component IW_SPI in either an SAP Gateway system or an SAP Business Suite backend system provided the system is based on SAP NetWeaver 7.40 or higher.

IW_PGW

ABAP

100

Content provider that enables exposure for SAP NetWeaver Business Process Management (BPM) and Process Observer Task exposure for BPM and SAP NetWeaver Business Workflow. For SAP NetWeaver 7.02, 7.03, and 7.31, you can install this component in an SAP Gateway system together with IW_BEP or in an SAP Business Suite system together with IW_BEP. For SAP NetWeaver 7.40 and higher, the core component SAP_GWFND in installed as standard and includes the functional scope of IW_BEP. Consequently you can install component IW_PGW in either an SAP Gateway system or an SAP Business Suite backend system provided the system is based on SAP NetWeaver 7.40 or higher.

Optional Components for SAP Business Suite System You can install the following components in an SAP Business Suite system: Name

Type

Version

Notes

IW_BEP

ABAP

200

Business Enablement Provisioning component

Note For SAP NetWeaver 7.40 and higher, the core component SAP_GWFND in installed as standard and includes the functional scope of IW_BEP. IW_SCS

ABAP

200

Component for Screen Scraping generator.

IW_GIL

ABAP

100

Provides a generic OData adapter for content based on the Generic Interaction Layer (GenIL). For SAP NetWeaver 7.01, 7.02, 7.03, and 7.31, you can install this component in an SAP Business Suite system together with IW_BEP. For SAP NetWeaver 7.40 and higher, the core component SAP_GWFND in installed as standard and includes the functional scope of IW_BEP. Consequently you can install component

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

Page 12 of 95

IW_GIL in an SAP Business Suite backend system provided it is based on SAP NetWeaver 7.40 or higher. IW_SPI

ABAP

100

Provides a generic OData adapter for content based on the Service Provider Infrastructure (SPI). For SAP NetWeaver 7.02, 7.03, and 7.31, you can install this component in either an SAP Business Suite system or an SAP Gateway system together with IW_BEP. For SAP NetWeaver 7.40 and higher, the core component SAP_GWFND is in installed as standard and includes the functional scope of IW_BEP. Consequently you can install component IW_SPI in either an SAP Business Suite system or in an SAP Gateway system provided it is based on SAP NetWeaver 7.40 or higher.

IW_PGW

ABAP

100

Content provider that enables exposure for SAP NetWeaver Business Process Management (BPM) and Process Observer Task exposure for BPM and SAP NetWeaver Business Workflow. For SAP NetWeaver 7.00, 7.01, 7.02, 7.03, and 7.31, you can install this component in either an SAP Business Suite system or an SAP Gateway system together with IW_BEP. For SAP NetWeaver 7.40 and higher, the core component SAP_GWFND is in installed as standard and includes the functional scope of IW_BEP. Consequently you can install component IW_PGW in either an SAP Business Suite system or in an SAP Gateway system provided it is based on SAP NetWeaver 7.40 or higher.

More Information For more information about landscape recommendations, see the following presentation on SAP Community Network: https://wiki.sdn.sap.com/wiki/display/SLGB/Landscape+Recommendations

.

1.2.6 Embedded Versus Hub Deployment Depending on whether you want to develop SAP Gateway content in an SAP Business Suite backend system or in an SAP Gateway central hub system, you can choose to implement SAP Gateway in an embedded or central hub deployment scenario: Embedded deployment of core software components IW_FND and GW_CORE in an SAP Business Suite backend system. As of SAP NetWeaver 7.40, the core software component for SAP Gateway is SAP_GWFND, which contains the composite functional scope of IW_FND, GW_CORE, IW_BEP, and IW_HDB. Central hub deployment of core software components IW_FND and GW_CORE in an SAP Gateway hub system. As of SAP NetWeaver 7.40, the core software component for SAP Gateway is SAP_GWFND, which contains the composite functional scope of IW_FND, GW_CORE, IW_BEP, and IW_HDB.

Development System — Deployment Scenarios To help you decide whether embedded or central hub deployment is the most suitable for you, see the following three deployment scenarios. These deployment scenarios have been conceived to provide you with the flexibility to decide which deployment option best meets your individual requirements. Scenario A: Central Hub Deployment — Development in SAP Business Suite Backend System SAP NetWeaver Release

Software Components

Installed in SAP Gateway Hub System

SAP NetWeaver 7.0, 7.01, 7.02, 7.03,

IW_FND

X

GW_CORE

X

7.31

X

IW_BEP SAP NetWeaver 7.40 and higher

SAP_GWFND

Installed in SAP Business Suite Backend System

(X — available as standard as part of

X

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. Considerations for SAP NetWeaver Releases 7.0, 7.01, 7.02, 7.03, and 7.31

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

Page 13 of 95

Minimum requirement for installing the Add-On IW_BEP in the SAP Business Suite backend system is SAP NetWeaver 7.00 Support Package 18. The life cycle of SAP Gateway content is dictated by the frequency of updates in the SAP Business Suite backend system. To enable communication between the SAP Gateway system and the SAP Business Suite backend system, you must install IW_BEP in the backend system. If you want to use the Screen Scraping generator, you must install the Add-On IW_SCS in the SAP Business Suite backend system. Minimum requirement for installation in the backend system is SAP NetWeaver 7.00 Support Package 18. Considerations for SAP NetWeaver Release 7.40 As of SAP NetWeaver 7.40, component SAP_GWFND is already installed as part of the standard SAP NetWeaver delivery. The life cycle of SAP Gateway content is dictated by the frequency of updates in the SAP Business Suite backend system. If you want to use the Screen Scraping generator, you must install the Add-On IW_SCS in the SAP Business Suite backend system. Scenario B: Central Hub Deployment — Development in SAP Gateway System SAP NetWeaver Release

Software Components

Installed in SAP Gateway Hub System

SAP NetWeaver 7.0, 7.01, 7.02, 7.03, 7.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.

SAP NetWeaver 7.40 and higher

(X — available as standard as part of SAP NetWeaver 7.40 and higher)

Advantages: Noninvasive deployment scenario for SAP Business Suite backend system. The life cycle of SAP Gateway content is loosely coupled to the lifecycle of the SAP Business Suite backend system. To enable external access and fulfill security requirements, you can locate the SAP Gateway system in a demilitarized zone (DMZ). You need only a single installation of the SAP Gateway Add-Ons within the system landscape. Considerations The SAP Gateway content implementation cannot use the majority of development objects in the SAP Business Suite backend system. Consequently, you need to create copies of structures and data domains, for example. If you want to use the Screen Scraping generator, you must install the Add-On IW_SCS in the SAP Business Suite backend system. Depending on the setup of the backend system, this might not be permitted. Minimum requirement for installation in the backend system is SAP NetWeaver 7.00 Support Package 18. You must choose this deployment scenario if you cannot install the SAP Gateway Add-Ons in the SAP Business Suite backend system. You might not be able to install Add-Ons in the backend system for reasons of security, stability, or incompatibility (due to system release). Scenario C: Embedded Deployment — Development in SAP Business Suite Backend System SAP NetWeaver Release

Software Components

SAP NetWeaver 7.0, 7.01, 7.02, 7.03, 7.31

IW_FND

X

GW_CORE

X

IW_BEP

X

SAP_GWFND

X

SAP NetWeaver 7.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 can reuse structures from the backend system and access local business logic. Reduced total cost of ownership (TCO) as you do not require a separate SAP Gateway system. Considerations: The life cycle of SAP Gateway content is dictated by the frequency of updates in the SAP Business Suite backend system. You must integrate the consuming application or infrastructure with the SAP Business Suite system on a point-by-point basis. Cross-system composition is not advisable. Central SAP Gateway content is not available. Backend-specific content is used in the SAP Business Suite backend system. For more information about embedded deployment and central hub deployment, see Deployment Options. For more information about release dependencies, see Installing SAP Gateway Components.

1.2.7 Glossary action Prepackaged business logic attached to an entity type.

annotation Metadata attached to a consumption model element.

Business Enablement Provisioning (BEP) Function that handles the OData Channel as well as the events and actions activated in the SAP Business Suite system and publishes these events and actions through SAP Gateway.

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

Page 14 of 95

Backend Operation Proxy (BOP) Encapsulates a single RFC call or a Web service operation call and consists of two or more classes, with a BOP data object (BOP DO) class for each BOP.

backend system SAP Business Suite backend system.

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

collection Resource that contains a set of entries, which are structured according to the entity type definition in the respective data model.

complex type (synonym: ComplexType) Structured types consisting of a list of properties but with no key. Can only exist as a property of a containing entity or as a temporary value.

consumption model Represents an OData service by bundling a set of SAP Gateway data models for a specific consumption use-case. Each data model will be reflected by one or more corresponding entity types or collections in the resulting service. Exposed as service document plus service metadata document in the OData world.

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

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

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

embedded deployment Deployment of core software components IW_FND and GW_CORE on the SAP Business Suite backend system.

entity set (synonym: EntitySet) Entities are grouped in entity sets (for example, customers is a set of customer entity type instances)

entity type (synonym: EntityType) OData-specific. An entity is an instance of an . It has a unique identity, independent existence, and forms the operational unit of consistency. An has a name, a payload consisting of one or more declared properties and a that describes the set of properties whose values uniquely identify an entity within an entity set.

entity data model (EDM) Set of concepts that describe the structure of data regardless of its stored form.

event provider Application-specific component that provides business events. SAP Gateway converts these events in OData for SAP application notifications.

function import (synonym: FunctionImport) Describes a service operation in an entity data model.

Generic Channel Programming paradigm for SAP Gateway. Infrastructure components that enable SAP Gateway content to abstract data from the exposed protocol and the business application implementation. The recommended programming paradigm for SAP Gateway is OData Channel.

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

Page 15 of 95

hub system SAP Gateway system.

metadata document Complete XML representation of an Entity Data Model (1:1 relation).

model provider class (MPC) Provides all metadata of a service to the runtime.

multiple origin composition (MOC) Collection of data from different backend systems that is aggregated in a single service, thereby enabling a service to be made available for more than one system.

navigation property (synonym: NavigationProperty) Property of an entry that represents a link from this entry to one or more related entries. A navigation property is not a structural part of the entry to which it belongs.

OData Channel (ODC) Programming paradigm for SAP Gateway to expose backend functionality. To use the OData Channel, you can install the software component IW_BEP on either an SAP Business Suite backend system or on the SAP Gateway system. You are no longer recommended to use SAP Gateway ODC (using the core software component IW_FND).

OData for SAP Products OData for SAP Products is a set of rules describing how to apply OData in consumption scenarios, plus a set of extensions to OData that simplify the consumption of OData services.

OData service Develop OData services in the Service Builder to extract the data you want, when you want it, and where.

OData Services Consumption and Integration (OSCI) Enables quick consumption of external OData services and converts them to SAP Gateway compliant OData services.

Open Data Protocol (OData) The Open Data Protocol (OData) is a Web protocol for querying and updating data. It applies and builds upon Web technologies such as HTTP, Atom Publishing Protocol (AtomPub), and JSON to provide access to information from a variety of applications.

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

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

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

Screen Scraping Generator for transforming ABAP dynpro screens into SAP Gateway services.

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

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

Page 16 of 95

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

Service Builder Is a dedicated design-time transaction, which provides a toolset for creating OData services easily and efficiently and supports the entire service development life cycle. It blends new and existing ABAP development tools in an OData-compliant modeling transaction and caters for the needs of all developers, regardless of experience and time available for service development.

service call Request sent to the OData service root URI or a resource path extending it.

service document Top-level XML representation of a consumption model (1:1 relation). It contains a list of entity sets. A document that describes the location and capabilities of one or more entity sets.

thing Tangible work object from a user perspective.

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

User Self Service SAP Gateway feature (similar to the User Management capability of Business-to-Consumer (B2C) scenario) using which SAP Business Suite B2C customers can create users and manage their user profiles.

1.3 SAP Gateway Installation Guide SAP Gateway is available as an SAP NetWeaver Application Server ABAP (AS ABAP) add-on that you install on top of your existing SAP Business Suite or application platform. The software packages are available on your DVD and on http://service.sap.com/swdc

.

To ensure that SAP Gateway functions smoothly in an ABAP environment, a number of installation and configuration steps need to be performed. This chapter focuses on all aspects concerning the installation of SAP Gateway: Installation Prerequisites Installing SAP Gateway Components Unicode and Non-Unicode Support

More Information For information about the system landscape and the different installation or deployment options offered by SAP Gateway, see Deployment Options. For information about the software maintenance tools and processes, see Software Maintenance. For information about product availability, see the Product Availability Matrix (PAM) under http://service.sap.com/pam

.

1.3.1 Installation Prerequisites Hardware The minimum hardware requirements for SAP Gateway are as follows: Requirements

Specification

Processor

Dual Core (2 logical CPUs) or higher, 2 GHz or higher

Random Access Memory (RAM)

8 GB or higher

Hard Disk Capacity

80 GB primary, or higher

Software The minimum software requirements for SAP Gateway are as follows: Requirements

Specification

SAP NetWeaver Stack

The latest kernel patch for the corresponding SAP NetWeaver version has to be applied.

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

Page 17 of 95

Core Components

SAP NetWeaver 7.0 SPS25

GW_CORE and IW_FND

SAP NetWeaver 7.01 SPS10 SAP NetWeaver 7.02 SPS07 SAP NetWeaver 7.03 SPS01 SAP NetWeaver 7.31 SPS01

Core Component

SAP NetWeaver 7.40 SPS01

SAP Gateway Foundation SAP_GWFND

Note Comprises functional scope of components IW_FND, GW_CORE, IW_BEP, and IW_HDB. Business Enablement Provisioning Component IW_BEP

SAP NetWeaver 7.0 SPS18 SAP NetWeaver 7.01 SPS03 SAP NetWeaver 7.02 SPS06 SAP NetWeaver 7.03 SPS01 SAP NetWeaver 7.31 SPS01

Content Adapter Components IW_PGW

SAP NetWeaver 7.0 SPS18 SAP NetWeaver 7.01 SPS03 SAP NetWeaver 7.02 SPS06

Screen Scraping Component IW_SCS

SAP NetWeaver 7.03 SPS01 SAP NetWeaver 7.31 SPS01 SAP NetWeaver 7.40 SPS01

Content Adapter Component

SAP NetWeaver 7.02 SPS06

IW_SPI

SAP NetWeaver 7.03 SPS01 SAP NetWeaver 7.31 SPS01 SAP NetWeaver 7.40 SPS01

Content Adapter Component IW_HDB

SAP NetWeaver 7.02 SPS09 SAP NetWeaver 7.03 SPS01 SAP NetWeaver 7.31 SPS01 Minimal requirement of HANA database version: SAP HANA 1.0 SPS02

Content Adapter Component

SAP NetWeaver 7.01 SPS03

IW_GIL

SAP NetWeaver 7.02 SPS06 SAP NetWeaver 7.03 SPS01 SAP NetWeaver 7.31 SPS01 SAP NetWeaver 7.40 SPS01

Content Components

SAP NetWeaver 7.02 SPS07

IW_CNT and IW_CBS

SAP NetWeaver 7.03 SPS01 SAP NetWeaver 7.31 SPS01 SAP NetWeaver 7.40 SPS01

SAP WEB UIF

Core Component Version

SAP WEB UIF 7.01 SP01

IW_FND 250

SAP WEB UIF 7.31 SP00

Optional Core Component

SAP WEB UIF 7.46 SP00

IW_FNDGC (for Generic Channel)

SAP WEB UIF 7.47 SP01

Content Adapter Component

SAP WEB UIF 7.0 SP03

IW_GIL

SAP WEB UIF 7.01 SP00 SAP WEB UIF 7.31 SP00 SAP WEB UIF 7.46 SP00 SAP WEB UIF 7.47 SP01

SAP Backend

SAP Business Suite system

More Information For information about the product availability matrix for SAP Gateway, see http://service.sap.com/pam

and search for SAP Gateway 2.0 .

Consider the security issues described in SAP Gateway Security Guide. In addition, ensure you read and implement the latest version of the SAP Notes that apply to the software requirements listed above. You can find these SAP Notes at: http://service.sap.com/notes

.

1.3.2 Installing SAP Gateway Components Install the SAP Gateway components using the SAP Add-On Installation Tool (SAINT), which lets you import the SAP Gateway installation packages from your DVD or the SAP Service Marketplace into your SAP system landscape. On the SAP Service Marketplace you will find the SAP Gateway download package in the SAP Software Download Center: Go to http://service.sap.com/swdc and navigate to Installations and Upgrades Browse our Download Catalog SAP NetWeaver and complementary products SAP Gateway SAP Gateway 2.0 . Here you can find links to Installation and Upgrade (choose Downloads ), the documentation, and to the Product Availability Matrix (PAM). The following provides you with an overview of the SAP Gateway components available. You must install the core components. All SAP Gateway 2.0 components are non-modifying components. For more information, see SAP Note 1569624

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

.

Page 18 of 95

Core Components SAP NetWeaver 7.0 and 7.01 GW_CORE 190 IW_FND 240 SAP NetWeaver 7.02, 7.03, and 7.31 GW_CORE 200 IW_FND 250 SAP NetWeaver 7.40 and higher SAP_GWFND 740: SAP Gateway Foundation 7.40 This core component is available as standard in systems based on SAP NetWeaver 7.40 higher and provides the core functional scope comprising IW_FND 250, GW_CORE 200, IW_BEP 200, and IW_HDB 100. Consequently, if you have an SAP NetWeaver 7.40 installation, you can use SAP Gateway without having to install any additional software components.

Note If you have an SAP NetWeaver 7.40 installation and you have previously created services for the Generic Channel that are still in use, you must install the software component IW_FNDGC 100. You only need to install this optional component if you have existing Generic Channel services. For more information about the systems in which you can install these core components, see Deployment Options For more information about the system prerequisites for these core components see, Installation Prerequisites Business Enablement Provisioning Component SAP NetWeaver 7.0, 7.01, 7.02, 7.03, and 7.31 IW_BEP 200 Enables OData Channel programming paradigm and is required for SAP Gateway Service Builder to build OData services. While this component is, in theory, optional, you require an installation of it in either your SAP Business Suite backend system or your SAP Gateway system if you want to install the content adapter components. SAP NetWeaver 7.40 and higher SAP_GWFND 740: SAP Gateway Foundation 7.40 This core component is included in SAP NetWeaver 7.40 as standard and it contains the full functional scope of IW_BEP 200. Consequently, you do not need to install IW_BEP 200 in systems based on SAP NetWeaver 7.40 and higher. Content Adapter Components IW_HDB 100 Provides business content adapter for SAP Gateway with SAP HANA that enables OData exposure of SAP HANA views.

Note For systems based on SAP NetWeaver 7.40 and higher, you do not need to install this component since the functional scope is included in the core component SAP_GWFND 740, which is available as standard. IW_SPI 100 Provides a generic OData adapter for content based on the Service Provider Infrastructure (SPI). IW_PGW 100 Enables exposure for SAP NetWeaver Business Process Management (BPM) and Process Observer Task exposure for BPM and SAP NetWeaver Business Workflow. IW_GIL 100 Provides a generic OData adapter for content based on the Generic Interaction Layer (GenIL). For more information about the system prerequisites for the content adapter components see, Installation Prerequisites. For all SAP NetWeaver releases lower than SAP NetWeaver 7.40, the content adapter components IW_HDB 100, IW_SPI 100, IW_PGW 100, and IW_GIL 100 are dependent on an installation of IW_BEP 200. For SAP NetWeaver 7.40 and higher, the content adapter components IW_SPI 100, IW_PGW 100, and IW_GIL 100 are dependent on an installation of SAP_GWFND 740. Content Components Content is provided in predefined groups. Examples of such content are customer, account, and leave request grouped under CRM (Customer Relationship Management). System integrators, other vendors, and other SAP development teams can also provide similar content. The sub components contained in this package are as follows: IW_CNT 200 IW_CBS 200 For SAP NetWeaver 7.02, 7.03, and 7.31, the content components IW_CNT 200 and IW_CBS 200 are dependent on an installation of IW_FND 250. For SAP NetWeaver 7.40 and higher, the content components IW_CNT 200 and IW_CBS 200 are dependent on an installation of IW_FNDGC 100. Screen Scraping Component IW_SCS 200 You must install this component in your SAP Business Suite backend system if you want to create content using the Screen Scraping generator. These installation packages have a compressed format, so first unpack them into your local file system. Next, import them using the installation tool. For detailed information on unpacking the installation packages, see Loading Installation Packages from the Application Server. To install the SAP Gateway components: 1. Log on to the SAP system in which you want to install the SAP Gateway components and enter the transaction SAINT. 2. Import the installation packages. For detailed information on importing the installation packages, see Installing and Upgrading Add-ons.

More Information For a detailed overview of the installation prerequisites that must be fulfilled for each of the components, see Installation Prerequisites. For an overview of software components and where to deploy them, see Deployment Options. For more information about SAINT, see Add-On Installation Tool. For more information about installing SAP Gateway, see SAP Note 1569624

and SAP Note 1707368

1.3.3 Unicode and Non-Unicode Support

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

.

Page 19 of 95

1.3.3 Unicode and Non-Unicode Support If a SAP Gateway system and/or one of the connected backend systems is a non-unicode system certain technical restrictions need to be considered: If the name of an EDM artifact (that is, a name of an artifact of the service’s EDM model, for example, a property name) contains characters that are not in the system code-page, then the following applies: Such characters are converted into the hash character - #. This results in an error during the name validation in the OData library. The origin of such EDM names could, for example, be the Service Builder or OData services generated with SAP Gateway. If the data (for example, HTTP request/response payload) from a unicode system or unicode clients contains characters that are not in the system code page, then the following applies: A conversion into STRING is done which converts characters that are not available in the system code-page into the hash character - #. This does not necessarily result in an error. The origin of such data could, for example, be applications on the basis of the UI development toolkit for HTML5 (SAPUI5) or external OData services in a client scenario. It is highly recommended that both the SAP Gateway as well as all connected backend systems are unicode systems. The above listed issues can be overcome by exclusively using characters that are in the code-pages of all systems. Depending on the support package stack level at least the following SAP Notes have to be applied as well: 1994928 1995054 1995517

1.4 SAP Gateway Configuration Guide Once you have installed the SAP Gateway components, you must configure your system to allow the consumer servers’ applications to retrieve the data requested by users. The SAP Gateway Configuration Guide contains the steps for customizing settings for SAP Gateway and describes system configuration activities. The sequence of mandatory and optional configuration tasks is as follows and depends on your use case. 1. General Configuration Settings (mandatory) 2. OData Channel Configuration 3. Configuration Settings for content scenarios (optional)

Implementation Guide The SAP Gateway specific configuration tasks are included in the SAP Gateway Implementation Guide (IMG) which is available in the system: In your SAP Gateway hub system (IW_FND) go to transaction SPRO, open the SAP Reference IMG and navigate to: SAP NetWeaver SAP Gateway . In your backend system (IW_BEP) go to transaction SPRO, open the SAP Reference IMG and navigate to:

SAP NetWeaver

SAP Gateway Service Enablement

. For all steps in the IMG there is always consumer-independent documentation available. If you want to see more information, select the Display icon before executing each step.

Note If you have software components GW_CORE 190 and IW_FND 240 installed in your system, the IMG tree will only offer the activities for OData Channel. The same applies if you use SAP Gateway in SAP NetWeaver 7.40 (software component SAP_GWFND). For more information, see Deployment Options.

Recommendation We strongly recommend using the OData Channel (ODC) programming paradigm for all SAP Gateway development. As of SAP Gateway 2.0 Support Package 05, you are strongly recommended to use the Service Builder (transaction SEGW) for your OData design-time development . For more information, see SAP Gateway Service Builder. Depending on whether you want to develop SAP Gateway content in an SAP Business Suite backend system or in an SAP Gateway hub system, you can choose between embedded deployment or central hub deployment. For more information, see Embedded Versus Hub Deployment and Deployment Options. As such, several sections in the Implementation Guide (IMG) are merely available for reference and maintenance purposes. In the backend system this is the section in the SAP Reference IMG under SAP NetWeaver SAP Gateway Service Enablement Generic Channel . In the SAP Gateway hub system these are the sections in the SAP Reference IMG under SAP NetWeaver SAP Gateway Former Development .

Additional Software Components Depending on the additional SAP Gateway components you implement, further component-specific configuration steps are required: Screen Scraping (IW_SCS)

For Screen Scraping you only need to configure roles based on certain authorization templates. The templates specify the authorizations for content that can be accessed by the users and activities for developers. For more information, see Setting Up User and Administrator Authorizations.

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

Page 20 of 95

SAP Gateway with HANA (IW_HDB)

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

Workflow

You can find more information about the Workflow-related configuration activities in Configuring Workflow for SAP Gateway. In addition, the relevant IMG activities are available in the Implementation Guide in the backend system: In transaction SPRO open the SAP Reference IMG and navigate to: Service Enablement

Business Process Enablement

Content

SAP NetWeaver

Workflow Settings

SAP Gateway

.

For the special services provided within Business Process Enablement, such as Process Service and Process Context Service, the relevant IMG activities are available in the Implementation Guide in the backend system. In transaction SPRO open the SAP Reference IMG and navigate to: Service Enablement

Content

SAP NetWeaver

Business Process Enablement

SAP Gateway .

Consumer Settings For information on configuration settings which need to be carried out for the different consumer scenarios and applications, see Configuration Settings for SAP Gateway Supported Scenarios.

1.4.1 General Configuration Settings After having installed the SAP Gateway software components you need to carry out several configuration steps. Before starting with the configuration for SAP Gateway itself, you need to collect some information about the SAP Gateway host. Required Information

Description

Fully Qualified Domain Name (FQDN)

Name of the SAP NetWeaver Application Server ABAP server.domain.com

Example

(AS ABAP) system or the load balancing device. 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, you need the following information: System ID, system number Server name HTTP / HTTPS port Administrator credentials

In addition, several settings are important for smooth operations: Profile Parameters ICF Services Initial Logon Language Settings

1.4.1.1 Profile Parameters In both your SAP system and in the SAP Gateway system you need to set the following profile parameters to certain values: Profile Parameter

Value

login/accept_sso2_ticket

1

login/create_sso2_ticket

2

You maintain these profile parameters via transaction RZ10.

More Information For information on profile parameters and profile parameter maintenance, see Profile Parameters for Logon and Password (Login Parameters) and Changing and Switching Profile Parameters.

1.4.1.2 ICF Services Once you have installed the Application Server ABAP (AS ABAP) all Internet Communication Framework (ICF) services are available in an inactive state for security reasons. After the installation you have to decide which services must be activated for the applications you want to use.

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

Page 21 of 95

Caution Activated ICF services represent a security risk because they can be accessed directly by the HTTP protocol from the Internet. You therefore need to use suitable methods for restricting access, for example, only permitting access to the ICF service for users with the appropriate authorizations. Since multiple services can be executed when you call a URL, all service nodes must be activated in the SICF tree. The URL path is mapped in ICF subnodes (services). For example, if you want to activate the services for URL /sap/public/icman, you have to activate the service tree default_host in transaction SICF. Then you have to activate services sap, public and icman separately. You activate an ICF service as follows: 1. Select the required ICF service in the ICF tree in transaction SICF. 2. Activate the ICF service in one of the following ways: Using menu option Service/Host Activate . Using the context menu and choosing Activate Service . You can either activate only a selected service node ( Yes ), or the selected service node including all the subservices maintained for it in SICF ( Yes with tree icon). For SAP Gateway you need to activate the following services: /sap/public/opu Note that /sap/public/opu/resources is needed for loading resources, such as images in the MIME repository. For example, the generic player gets a service document which contains links to images which the player should display for a Sales Order. Then the generic player downloads the image via URL from the MIME Repository; for example, http://.../sap/opu/resources/pic1.png. /sap/opu/odata with its sub-nodes. This is the standard mode for all new applications. When creating a service a new node is created automatically. /sap/opu/sdata with the following sub-nodes: /sap/opu/sdata/iwcnt /sap/opu/sdata/iwfnd /sap/opu/sdata/sap This is the node used for existing applications, it is called Compatibility Mode for SP02 . If you use Web service based scenarios, that is, if content is consumed which is provided via Web services, then you also need to activate the following nodes on your target system: /sap/bc/srt/xip/sap /sap/bc/webdynpro/sap/saml2 /sap/public/bc /sap/public/bc/ur /sap/public/mysssocnt

Note If the default_host node is inactive in transaction SICF, the HTTP requests could result in an ABAP runtime error RAISE_EXCEPTION with the following short text: Exception condition "HOST_INACTIVE" triggered. If a service is inactive in transaction SICF, an error text appears when you try to access the service. You can also activate services from the SAP Implementation Guide (IMG). In transaction SPRO, choose Display SAP Reference IMG . The path in the Implementation Guide for SAP NetWeaver is: in Installation .

Application Server

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.

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

Note The standard mode is the default for all new applications. All new development will be done on this mode. New functions and features will be available for this mode. The request handler for this node is /IWFND/CL_SODATA_HTTP_HANDLER. The following list consists of the differences of the standard mode as opposed to the compatibility mode for SP02: XSRF protection See also Cross-Site Request Forgery Protection Content-Type required for Put/Post request An unsupported media type error is thrown if Content-Type is not set for Put/Post requests. Set parameter: Content-Type=application/xml XSRF Security Token Security Session Id $format parameter $format=xml leads to an error except for service document. Do not use it for all requests except for those to get service document . Null values in Put/Post Request Empty property elements (for example, ) are not allowed anymore. Nullable needs to be set properly, and besides that, if an entry with a null string is to be created set m:null="true", for example, .

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

Page 22 of 95

Null values in the response of a Get/Put request Intial values for date time fields in combination with nullable properties are rendered as . 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. m:null is not allowed. Rendering of key predicates See http://www.odata.org/developers/protocols/overview#AbstractTypeSystem . Key properties Sending properties that are not key fields in an URI is not longer possible. String parameters Quotation marks enclosing string parameters (for example, search string) are now required and removed. Parameters for function imports Parametrize with literals, for example, datetime.... See also http://www.odata.org/developers/protocols/overview#AbstractTypeSystem

.

Inverted commas in URI Inverted commas in URI, for example, $filter=name eq 'Jame''s shop' can now be properly escaped by an inverted comma. OData error response The OData error response has been enhanced. See http://www.odata.org/media/6655/%5Bmc-apdsu%5D%5B1%5D.htm#_Toc246716641 . The code field is now either build from the leading error message of the message container or build from the text id of the exception. The structured inner error section is available showing Extended Passport (EPP) transaction ID. All messages of the message container and the additionally provided error details are shown in a special format (micro format). Things The workspace for Things, element , is no longer available. Service maintenance The service maintenance transaction distinguishes between services of the Standard Mode and of the Compatibility Mode for SP02 .

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

Caution This node is in maintenance mode. The request handler for this node is /IWFND/CL_SDATA_ODATA_APP.

Alias Handling in ICF The ICF standard function of external aliases is also available for SAP Gateway for the Standard Mode , that is, for ICF node /sap/opu/odata. Thus 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.

Note Note that external aliases are not supported for namespaces in SICF. If the handler /IWFND/CL_SODATA_HTTP_HANDLER is not yet registered for your service node, enter the handler name on tab Handler List and activate your service. After the handler has been set, you can define the external alias.

More Information Administration of ICF server functions (authorization assignment): Server Function Administration Administration of ICF client functions (creation of RFC destinations, and so on): Client Function Administration ICF services: Creating and Configuring an ICF Service Authentication: Defining the Logon Procedure

1.4.1.3 Changing Password for Initial Logon Note This section is only relevant if you want to change the password for the initial logon procedure. The logon configurations for SAP Gateway are handled via the ICF layer. For more information, see Defining the Logon Procedure. SAP systems may require some additional (browser) features if the password needs to be changed because of being initial or outdated. Therefore, the ICF nodes can be configured to permit the initial password change and the direct logon. An additional ICF node is offered to allow the change of passwords with a browser.

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

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

Page 23 of 95

You can find this special ICF node in the service tree under /default_host/sap/opu/utils under the name initial_logon. You can access this node as soon as it has been activated via the URL :/sap/opu/utils/initial_logon. The call of the service requires authentication and does allow to change an initial password via a browser application. If the URL is extended by ? redirectURL=/X then the browser is redirected to the URL wherever X points to. A typical use case for such a redirect URL would be to display additional information, so that the new password data could be used in the settings of a mobile application. If needed, a redirect URL can be configured and will take precedence over all basic settings.

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

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

9. Choose Input (Enter) to save your settings.

Caution If you have administrator rights you have the additional option to save your settings as global settings. Do not use Save as Global Settings . 10. Activate your ICF node.

Logoff URL The Internet Communication Framework also offers a default logoff URL on each system. You can define your own logoff pages via

Error Pages

Logoff Page

.

More Information For more information on the generic system logon functionality in ICF, see System Logon.

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

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

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

SAP NetWeaver

SAP Gateway

.

SAP NetWeaver 7.02 and 7.31 The OData Channel configuration activities are listed in the Implementation Guide (IMG) in the system where software component IW_FND is deployed. In the SAP Reference IMG navigate to

SAP NetWeaver

SAP Gateway

OData Channel

.

Apart from basic configuration settings the OData Channel configuration activities for the SAP Business Suite backend system are listed in the Implementation Guide (IMG) in the backend system where software component IW_BEP is deployed. In the SAP Reference IMG navigate to SAP NetWeaver

SAP Gateway Service Enablement

Backend OData Channel

.

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

Page 24 of 95

OData Channel IMG in IW BEP

SAP NetWeaver 7.40 If you use software component SAP_GWFND in SAP NetWeaver 7.40, IMG activities for SAP Gateway Foundation 7.40 are available. In the SAP Reference IMG navigate to SAP NetWeaver OData Channel IMG activities.

SAP Gateway

and

SAP NetWeaver

SAP Gateway Service Enablement

. There you find all the relevant

Settings User, Developer and Administrator Authorizations Connection Settings: SAP Gateway to SAP Systems Activating SAP Gateway Service Development in the Backend System Service Development in the SAP Gateway Hub System Connection Settings to SAP Gateway

More Information Basic Configuration Settings OData Channel

1.4.2.1 User, Developer, and Administrator Roles After you have installed the SAP Gateway components you require, you need to set up an administrator role for SAP Gateway components and assign users to it. Then you set up one or several user roles and assign users to it as well. As you cannot change existing SAP roles, you create your own roles or copy existing roles to your new custom roles. The SAP system includes templates as opposed to actual users, so you must use the available role templates to create the users you require in the SAP Gateway system. If the users you require exist in your SAP Business Suite backend system, 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. If this is not possible, you must create the users manually. 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_. Support colleagues These templates provide display authorizations only and are intended to be used by support colleagues who need to view applications logs. Use the predefined templates to create administrator, developer, user, and support roles for SAP Gateway components. The template names begin with a namespace ID that corresponds to the software components you use.

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. Use the developer role /IWBEP/RT_MGW_DSP for accessing a remote system from the Service Builder (transaction SEGW) at design time. The following templates are available for developers: Template Type

Template Name

Template 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. All rights reserved.

Page 25 of 95

OData Channel

/IWBEP/RT_MGW_DEV

OData Channel Developer

Screen Scraping

/IWSCS/RT_SCR_DEV

SAP Gateway Screen Scraping 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

2. On tab Define Supervisor Dest. choose Create . 3. In the Destination Name field, enter BGRFC_SUPERVISOR . 4. In the User Name field, enter a user name, for example, BgRFC_user . 5. 6. 7. 8.

Select Create User and choose Enter . Choose Save . Select Generate Password and choose Save . On the bgRFC Destination page, select Save .

1.4.2.2.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). In the following sections only the basic configuration activities 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 SAP NetWeaver SAP Gateway

OData Channel

Configuration

Connection Settings

SAP Gateway to SAP System

.

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.4.2.2.2.1 Creating an RFC Destination for SAP Gateway Hub to SAP System For all scenarios, you need to create an RFC destination (type 3) from the SAP Gateway hub to the SAP Business Suite system. RFC destinations of type 3 are for connections to SAP ABAP systems. Create the RFC destination of type 3 as follows 1. 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. 2. Choose Create . 3. In the RFC Destination field, enter the RFC destination name in the following format: CLNT. 4. In the Connection Type field, enter 3 . 5. In the Description 1 field, enter an explanatory text, for example, RFC Destination to SAP Server . 6. 7. 8. 9.

Save your settings. On tab Technical Settings and Load Balancing select the relevant option according to your system’s settings. In the Target Host field, enter the (message) server name of the of the SAP system. In the System Number field, enter the SAP Gateway system number, for example, 00 .

10. On tab Logon & Security enter the SAP system’s client number. 11. Activate Current User . 12. For Trust Relationship activate Yes .

Note Ensure that you have previously created the trusted relationship, as outlined in Defining Trust between the SAP Gateway Host and Your SAP System. 13. Save your settings. To check that you have successfully created the type 3 connection, choose Connection Test . The connect test should pass. If the user ID with which you are logged on to SAP Gateway and your user ID for the SAP system is the same, and this user ID has the object S_RFCACL assigned to it on the SAP system, select Remote Logon . You should not see any error messages in the status. If you have any problems, check SAP Note 128447

for troubleshooting tips.

1.4.2.2.2.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, and the SAP Gateway host to be the trusted system.

Note This RFC destination is used to establish trust between the systems and is not used at runtime. To configure trust, proceed as follows: 1. In the SAP business system, open transaction SM59 and choose Create . 2. In the RFC Destination field, enter the RFC destination name in the following format: CLNT.. 3. In the Connection Type field, enter 3 . 4. In the Description 1 field, enter an explanatory text, for example, RFC Destination to SAP Gateway Server . 5. Save your settings. 6. On tab Technical Settings and Load Balancing select the relevant option according to your system’s settings. 7. In the Target Host field, enter the (message) server name of the SAP Gateway system.

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

Page 29 of 95

8. In the System Number field, enter the SAP Gateway system number, for example, 00 . 9. Save your settings. 10. In transaction SMT1 choose Create . The wizard for creating trusting relationships displays. 11. Proceed with the steps outlined in the wizard. In the RFC Destination field, enter the RFC destination you created. An RFC logon to the SAP Gateway host takes place and the necessary information is exchanged between the systems. 12. Log on to the SAP Gateway host using your administrator user and password. The trusted entry for the SAP Gateway host displays. 13. Save your settings.

Note End users must have authorization object S_RFCACL assigned to them before they can use a trusted connection. For more information, see RFC Trusted/Trusting Systems.

1.4.2.2.2.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. To accept SAP assertion tickets, proceed as follows: 1. Make sure that the profile parameters are set as outlined in Profile Parameters. 2. In your backend system go to transaction SSO2 to run the SSO2 administration wizard.

Note If transaction SSO2 does not work, use STRUSTSSO2 to import the certificates from the SAP Gateway server; you must import them manually. For further information, see Using Transaction STRUSTSSO2 in SAP System >= 4.6C. 3. Enter the Type 3 RFC destination created above (for your SAP Gateway system) or the Host Name and Instance Number for the SAP Gateway system in the appropriate fields. 4. Choose Execute . On the Logon page enter your password. The SSO2 administration report for the designated SAP system displays. 5. Choose Activate (Enter Certificate in ACL and, if Necessary, Certificate List) to configure the SAP system.

1.4.2.2.2.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. Proceed as follows: 1. In your SAP Gateway system make sure that the profile parameters are set as outlined in Profile Parameters. 2. In your SAP Gateway system go to transaction SSO2 to run the SSO2 administration wizard.

Note If transaction SSO2 does not work, use STRUSTSSO2 to import the certificates from the SAP Gateway server; you must import them manually. For further information, see Using Transaction STRUSTSSO2 in SAP System >= 4.6C. 3. Enter the Type 3 RFC destination created above (from your backend system) or the Host Name and Instance Number for the backend system in the appropriate fields. 4. Choose Execute . You may be asked to provide a user name and password. The SSO administration report for the designated SAP system displays. 5. Choose Activate (Enter Certificate in ACL and, if Necessary, Certificate List) to configure the SAP Gateway system. If everything has been configured correctly the traffic lights are green.

1.4.2.2.2.5 Creating an SAP System Alias You need to specify where the SAP system alias should point to. Depending on the SAP Gateway content scenario and your system landscape you thus set up the system alias. The system alias is the result of the routing for an inbound request on SAP Gateway. It can be a remote or a local system. If that system alias is flagged as a Local SAP Gateway instance, 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. 1. In transaction SPRO open the SAP Reference IMG and navigate to: Connection Settings SAP Gateway to SAP System 2. Choose New Entries . 3. Enter the following details for the SAP system alias: Field

SAP NetWeaver

Manage SAP System Aliases

SAP Gateway

OData Channel

Configuration

and click on the Activity icon.

Description

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

Page 30 of 95

SAP System Alias

Name of the system alias.

Description

Descriptive text for the system alias.

Local SAP GW

The system that is responsible for processing (managing and storing) the data of an inbound request is the local SAP Gateway instance itself. This option is typically used for testing scenarios, for example when using the BOR Generator locally. If you activate Local SAP GW for a SAP System Alias called LOCAL the RFC Destination is usually NONE .

For Local App

The system alias is to be used by BEP. For more information, see the F1 help in the system and Hub OData Channel with IW_BEP Installation.

RFC Destination

Specify the RFC destination defined for your SAP system.

Software Version

This setting is specified by the content scenario you are using. Typically it is DEFAULT . In the context of Generic Channel development, check the following to determine the value to set for your GSDOs: In transaction SPRO open the SAP Reference IMG and navigate to: NetWeaver

SAP Gateway

Former Development

SAP

Former Generic

Channel Development Generic Service Data Object (GSDO) GSDO Types & GSDO Contexts & GSI Implementations and click on the Activity icon. Select your GSDO type and choose GSI Implementation . System ID

Name of the SAP target system.

Note When specifying SAP system aliases we recommend always to enter the system ID. The SAP target system, together with the target client, determines the system alias for a remote call to a backend system. Client

Target client.

WS Provider System

Name of the Web service provider business system. Here you only need to enter a setting if you use content scenarios which are configured via Web services.

4. Save your settings.

1.4.2.2.2.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. However, there can be different system aliases for one backend system if you use multiple origin composition. 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. If you also want to create OData requests you might not have information on any SAP Gateway system alias. Therefore, SAP Gateway also supports OData requests with a combination of system ID and client as backend origin. In addition, 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. In this case, instead of the system name you can also use the system ID (SID) together with the corresponding client.

Example Sample syntax for system alias: /sap/opu/odata/IWBEP/TEA_TEST_APPLICATION;o=XYZ_999/Teams Sample syntax for system ID and client: /sap/opu/odata/IWBEP/TEA_TEST_APPLICATION;o=sid(XYZ.999)/Teams The processing is as follows: 1. The SAP Gateway system searches for all existing system aliases for the user and the specified service. 2. The SAP Gateway system checks if one from above system aliases equals sid(XYZ.999). If this is the case, this system will be used. 3. If no such system exists underneath the specified service, then SAP Gateway checks whether one of the above system aliases has defined a system ID XYZ and client 999. 4. If this is the case, this system ID will be used. Otherwise an error message is displayed.

Configuration Steps For each system alias you need to enter also a system ID and a client, if this has not yet been configured already. For more information, see Creating the SAP System Alias for Applications.

1.4.2.3 Activating SAP Gateway Before you can use SAP Gateway functionality you have to activate it globally in your system. You can activate and deactivate SAP Gateway. When you deactivate it, all SAP Gateway OData services stop running, no consumer servers can communicate with it, and an error message is sent to any system that calls for the services. When you have completed the installation and post-installation configuration described in the sections above, you must activate SAP Gateway.

Note Before activating SAP Gateway, ensure that you have first installed and configured the consumer server.

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

Page 31 of 95

Proceed as follows: 1. In transaction SPRO open the SAP Reference IMG and navigate to:

SAP NetWeaver

SAP Gateway

OData Channel

Configuration

Activate

or Deactivate SAP Gateway and click on the Activity icon. A message displays. 2. Choose Activate . A message displays informing you of the current status.

More Information Periodical Tasks

1.4.2.4 Service Development in the Backend System Data is retrieved from an SAP Business Suite (backend) system. Both the application logic and metadata are hosted on the SAP Business Suite system. After the service has been developed, you need to activate (register) the service. To activate the service, 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 Service Enablement Backend OData Channel Service Development for Backend OData Channel and Maintain Services . For more information see Maintaining Models and Services.

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. Note that this activity is read-only. For more information see Display Models and Services. After this registration SAP Gateway can expose the corresponding OData services. Once a service has been defined in the SAP Business Suite system it can be activated on the SAP Gateway system. See Maintain Services. 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. For more information, see OData Channel Generation Tool. In addition, an activity is provided to define parallelization of batch queries. For more information, see Define Parallelization of Batch Queries.

Repository Objects The registration process of OData Channel models and services is unique: In order to allow collecting authorizations per data provider class (DPC) a repository object type is available. This is integrated into transaction SU22. Thus two additional repository object types exist in SAP Gateway. For more information see Roles in the SAP Gateway Landscape. These repository objects have the following impact: Models and services shall only be transported via the transport objects. The external name of a service is derived from the technical name and cannot be freely defined to ensure a GTADIR connection to guarantee unique services. You create service /MYNAMESPACE/MYSERVICE with version 0001 which then results in http://:/sap/opu/odata/mynamespace/MYSERVICE.

Prerequisites The following entities must exist: The data provider class for the service The model provider class for all models

More Information OData Channel

1.4.2.4.1 Maintaining Models and Services To retrieve data from a backend system, you have to define a service in the backend system. First you have to define a model, then define a service, and finally assign the model to the service.

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

.

To maintain models, proceed as follows: 1. Click on the Activity icon. 2. Enter a Technical Model Name , which can include a namespace within /, for example, /MYNAMESPACE/. 3. Enter 0001 as Model Version . 4. Choose Create . You can also display, edit or delete an existing model. 5. Enter the Model Provider Class , which is the name of the class providing metadata for this model.

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

Page 32 of 95

6. Enter an explanatory text as Description . 7. Save your settings.

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

.

To maintain the service, proceed as follows: 1. 2. 3. 4. 5.

Click on the Activity icon. Enter a Technical Service Name , which can include a namespace. Enter 0001 as Version . Choose Create . Enter the Data Provider Class , 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.

6. Enter an explanatory text as Description . 7. Save your settings.

Assign Model to Service To assign your model to a service, proceed as follows: 1. Choose Assign Model . 2. Enter the Technical Model Name and the corresponding Model Version , which you created in Maintain Models . 3. Choose Save .

1.4.2.4.2 Displaying Models and Services In your SAP Business Suite backend system, you can display existing models and the assignment of these models to services. 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

.

This is a read-only activity, which provides an overview of existing configuration settings. If you want to maintain models and services, see Maintaining Models and Services.

1.4.2.4.3 Defining Parallelization of Batch Queries The transaction for defining parallelization of batch queries allows you to optimize the performance of batch request processing. 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

.

In case of serialization the duration of the consecutive queries is the sum of all query processing times. Contrary to this, the total duration in parallel mode is just the maximum duration of these query processing times and a minimal overhead for parallelization. The following parameters are valid for the current SAP client: Activate Parallelization for Batch Queries Mark or unmark this option to enable or disable the parallelization. Maximum Number of Parallel Queries Specify the maximum number to limit the amount of parallel processing queries to save system resources. This number will be ignored if it is greater than the maximum number of dialog work processes available at parallelization time which is based on system settings (transaction RZ11, profile parameters rdisp/rfc*) . Zero (0) means it only depends on current system resources. Default value: 0.

Service-Based Batch Parallelization You can deactivate the parallelization of batch queries for a single service. This means that the service will run sequentially. 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. However, you might want to deactivate this on service level for individual services. You can activate the option for disabling of parallelization as soon as batch parallelization is active globally. 1. Enter the central transaction for Activating and Maintaining Services . 2. In the Service Catalog select your service and select your system alias in System Alias . 3. Choose Service Implementation and then Service Configuration (F6) . The service configuration window is displayed. 4. In section Service Settings you can activate Disable Parallelization of Batch Requests . The default configuration is active for parallelization. This option cannot be activated if parallelization has been switched off globally. 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. 5. Activate parallelization globally in the implementation guide (IMG) as explained above. This option Disable Parallelization of Batch Requests is no longer greyed out on service level.

Note Parallelization of batch requests is not possible in soft state mode. If soft state mode remains activated for the current service, parallelization of batch requests will be deactivated at runtime. Soft state and parallelization do not work together.

1.4.2.5 Service Development in the SAP Gateway Hub System PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.

Page 33 of 95

1.4.2.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.40) or in which core component SAP_GWFND is installed (SAP NetWeaver 7.40 or higher), you need to make some additional configuration settings in the SAP Gateway hub system in which you intend to develop OData services.

Note If your SAP Gateway hub system is based on an SAP NetWeaver release lower than 7.40, you will need to install the core component IW_FND in your hub system. If your SAP Gateway hub system is based on SAP NetWever 7.40 or higher, the core component SAP_GWFND is installed as standard. For more information, see Deployment Options. Assigning SAP System Alias to OData Service Activate and Maintain Services Multiple Origin Composition Dynamic System Alias Calculation Via /IWFND/ES_MGW_DEST_FINDER

1.4.2.5.1 Assigning SAP System Alias to OData Service You can assign SAP system aliases to a service. With this assignment, an OData request from an SAP Gateway consumer can be routed to the corresponding backend system. The system can correctly identify the SAP system that is responsible for processing (managing and storing) the data of an inbound request. Thus, 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. The SAP system alias can have a specific role or a specific host name associated to itself, so that you can specify different roles or host names for the same system alias for a service. If you leave the User Role or the Host Name field empty, the setting is valid for all roles/host names. Different backend systems are supported, if you specify corresponding roles/host names and system aliases. The roles are only for user grouping and do not need to have any special authorization.

Example It is possible to separate the development, the quality and the production landscape via dedicated clients on the SAP Gateway hub system. The user will be directed as follows if he or she does not have special roles: If there is a system alias maintained without any role assignment then it is used for all users. The user will be directed as follows if he or she has two or several roles relative to different system aliases: If a user is assigned to more than one system alias the system alias which is marked as default wins. If more than one system alias is found and either none of the system aliases or more than one of these aliases are flagged as default an error is raised. Ideally you have a system alias without any role assignment for all users without a role assignment and disjunct roles for the system aliases for all other users to the different backend systems (development, quality, productive). The system aliases with role assignment should be marked as default in this case. For this an IMG activity is available in the SAP Gateway Implementation Guide (IMG): in transaction SPRO open the SAP Reference IMG and navigate to SAP Gateway

:

For applications based on backend OData Channel system navigate to OData Channel Administration General Settings Assign SAP System Aliases to OData Service . 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

.

Note In previous support packages OData Channel based content was routed via GSDO groups which are no longer relevant in SAP Gateway 2.0 SP03.

1.4.2.5.2 Multiple Origin Composition Multiple origin composition (MOC) is the ability to collect data from different backend systems, aggregate them in one single service and updating different backend systems while using the same user. Thus a service can be made available for several system aliases. For example, you could have two identical systems, one located in America and one in Europe, and combine them. MOC is also used for CREATE calls and the metadata. At present, CREATE calls cannot be done in all configured backend systems, but only in the default system.

Note This feature is only supported in Standard Mode . This feature is relevant only for entity sets with an annotation of addressable=true. Implementing this feature creates a different version of the service (the SAP_Origin field is added). Proceed as follows to use the MOC: 1. Customize your service to support MOC. 1. From the SAP Gateway system, activate the desired service. For information on how to activate your service, see Register your Service in the SAP Gateway System. 2. Open transaction SPRO and choose SAP Reference IMG .

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

Page 34 of 95

3. Navigate to SAP NetWeaver SAP Gateway OData Channel Administration General Settings Activate and Maintain Services to add the system aliases for the relevant backend systems and define the desired default system. 1. In the Service Catalog list, select the desired service. The service appears in the ICF Nodes section on the lower left corner of the screen. 2. In the ICF Nodes section, select the Standard Mode ICF Node. 3. In the System Aliases section, choose System Alias to add the system alias. 4. Choose New Entries or select an existing entry and choose Copy . 5. In the Service Doc. Identifier field, enter the ID of the service document followed by an underscore and the 4–digit version number (for example, _0001). 6. In the SAP System Alias field, enter the relevant system alias. Only one system is to be defined as the default. 7. Repeat as necessary to add the desired backend systems.

Note The default system is used whenever the service is not called as MOC. If you have defined more than one default system alias, the first system is used as the default. 2. Test the service. 1. On the SAP Gateway system, open the SAP Reference IMG in transaction SPRO and navigate to Channel Administration General Settings Activate and Maintain Services 2. Search for the desired service with the Filter icon. 3. Select the desired service and choose Call Browser under ICF Nodes . An example URL for RMTSAMPLEFLIGHT looks as follows:

SAP NetWeaver

SAP Gateway

OData

.

http://:/sap/opu/odata/iwfnd/RMTSAMPLEFLIGHT;mo/ 4. Make sure that the SAP_Origin field appears in the service's metadata.

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. For this a new IMG activity is available: On the SAP Gateway system, open the SAP Reference IMG in transaction SPRO and navigate to SAP NetWeaver

SAP Gateway

OData Channel

Composition

Define Parallelization for Multiple Origin Composition

.

You can use this parallelization of READ_ENTITYSET to several backend systems to achieve optimized performance. In the IMG activity you can set the following configuration parameters: Minimum Number of Backend Systems can have the following values: 0 : No parallelization n : Parallelization will only be done from n backend systems onwards

The maximum number of parallel backend calls is always based on current resources of the SAP Gateway hub system. Additionally, you can use parameter Maximum Number of Parallel Backend Calls to limit the use of current system resources. The default value zero ( 0 ) means it only depends on current system resources.

Performance Improvement In case of serialization the duration of a READ_ENTITYSET within a hub system is the sum of all backend calls. Contrary to this, the duration in parallel mode is just the maximum duration of all backend calls and means a minimal overhead for parallelization.

Parallelization and Skiptoken If server paging is realized in any backend data providers, then the OData consumer will only receive results up to this backend including a skiptoken. 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.

Changesets In the context of multiple origin composition, changesets are also supported. All changeset operations for one backend are collected and sent to this backend via one RFC. You can find an example in SAP Note 1890049

.

Error Tolerance You can flag READ feed requests of a service in MOC mode error-tolerant. If a feed of a service is called in MOC mode, the service composes the data from all backend systems assigned to it. More precisely, all system aliases assigned for the current user and service are identified. Then the backend system of each of these system aliases is called reading the data from each system. Finally the results of each backend system are composed into one feed that is returned to the client. To call a service in MOC mode the segment parameter ;mo is added to the service name of the request URI.

Syntax Example: 01. /sap/opu/odata/iwfnd/RMTSAMPLEFLIGHT;mo/TravelagencyCollection

Error Behavior The default error behavior is not error-tolerant. If the data retrieval from any of the backend systems causes an error the READ feed request returns that error. If a service is marked to be error-tolerant this behavior changes:

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

Page 35 of 95

An error is returned only if the data retrieval from all backend systems causes an error. Otherwise if only some of the backend systems causes an error a feed is returned to the client. The data retrieved successfully from some of the backend systems is composed into that feed. The data missing form those backend systems that caused an error can be requested again. For that an OData skiptoken is added to that feed.

Syntax Example: 01. For this an IMG activity is available: On the SAP Gateway system, open the SAP Reference IMG in transaction SPRO and navigate to SAP Gateway

OData Channel

Composition

Flag OData Services to be error tolerant in case of MDC

SAP NetWeaver

.

If a service is not listed in this configuration the service is not error-tolerant. You can create an entry for each service that shall be error-tolerant.

Multiple Service Versions Customers might have different timelines in updating their backends. In this context internal policies of customers might prevent the upgrades of certain backends simultaneously. Thus, an enhancement might reach one of a number of backends at a later point of time. When multiple origin composition is used in such a scenario this might lead to issues because of a mismatch in the metadata. The metadata in single backends differs due to inhomogeneous extensibility or maintenance cycles. To remedy this, a service sub-version is available. This sub-version can be used within multiple origin composition to load the metadata of the minimal service sub-version from the cache, in order to work on the basis of this minimal sub-version. In the central transaction for activating and maintaining services the flag Metadata is available for an SAP system alias. For requests in multiple origin composition mode this flag specifies the backend system from which to retrieve the metadata. The processing mode is as follows: 1. The system searches for all system aliases assigned to a service for a user. 2. If more than one system is found, the one system with the Metadata default flag is chosen. 1. If none of the found systems has the Metadata default flag assigned the one with the Default System flag is chosen. 2. If none of the found systems has the Default System flag assigned an error is triggered. In addition, developers can use method SET_SERVICE_SCHEMA_VERSION of interface /IWBEP/IF:MGW_ODATA_MODEL to set the SAP schema version.

More Information Error Log

1.4.2.5.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. You can therefore use this enhancement spot to overwrite or enhance the standard routing for a service. Alternatively, you can use this enhancement spot to control the traffic from the SAP Gateway system to a backend system, so as to limit the load on that backend system. 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. The enhancement sport returns a list of system aliases with the following fields: system_alias of TYPE /iwfnd/defi_system_alias. This has to be defined with the standard implementation guide activity for system aliases. user_role of TYPE /iwfnd/defi_role_name. This field is filled according to the standard routing in the implementation guide which has the role as an optional “filer”. Note that this field can be empty. is_default of TYPE /iwfnd/mgw_inma_default_alias. If the table contains only one entry this can be empty. 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. That system alias is used for multi destination composition requests in case of CREATE, metadata or function imports of multiplicity 1.

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. All rights reserved.

Page 36 of 95

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.

Syntax Sample coding throwing an exception in case of too much load on the backend system: 01.

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

1.4.2.6.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. 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.4.4.4.1 Defining Settings for Idempotent Services HTTP is an inherently unreliable protocol. 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. Idempotency guarantees delivery of synchronous messages exactly once. For idempotent requests (for example GET) the client can simply re-try the request. But for operations that change the server state (for example, 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, as for example two items instead of one item are created. 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, globally unique for all time, identifier for the request. RepeatabilityCreation The date and time at which the request was first created. If specified, the client directs that the request must be repeatable. 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. Response Header: RepeatabilityResult A string describing how the server has handled the requested repeatability. The following values are possible. accepted The request was accepted and the server guarantees that the server state reflects a single execution of the operation. The response returns the success or failure state of the operation as first executed by the server, and reflects either the current state of the system or the state as it existed when the request was first received. unsupported The request was rejected because the server does not support repeatable execution of the request. The server returns 412 (Precondition Failed) without attempting to execute the request. The server state is the same as if the request had never been received. 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. The server returns 412 (Precondition Failed) without attempting to execute the request. The server state is the same as if the request had never been received. The request header attributes are passed on to the SAP Business Suite backend system. In the backend system the idempotent utility (provided by the underlying SAP NetWeaver) handles the idempotent support generically. When the backend system receives a request it delegates the handling of the RepeatabilityCreation header to the idempotent utility class.

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.

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

Page 37 of 95

For this the SAP Gateway Implementation Guide (MG) has been enhanced. In transaction SPRO open the SAP Reference IMG and navigate to NetWeaver SAP Gateway Service Enablement Services .

Backend OData Channel

Connection Settings to SAP Gateway

SAP

Define Settings for Idempotent

To define settings for idempotent services, proceed as follows: 1. Click on the Activity icon of the above mentioned IMG activity. 2. Enter the following default values: For Period Hours in Document the typical value is 6 . For Period Hours in Document ID the typical value is 12 . 3. Choose Schedule . A message displays confirming that the job has been scheduled. 4. Choose Continue .

1.4.2.6.2 Defining a Remote Function Call to SAP Gateway You create or define a background remote function call (bgRFC) destination, which is used for communications in an outbound queue, and an inbound queue among SAP systems. This is an activity that is done in the backend system, that is, the system where software component IW_BEP is installed. If you are using push from a backend system to an SAP Gateway hub system, it is important not to have a trusted RFC connection. 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. Instead a dedicated technical user like ALEREMOTE has to be maintained in the RFC destination in the backend system.

Note You can also use an existing bgRFC destination in your SAP system to the host of SAP Gateway. You can define this remote function call by using the implementation guide (IMG). In transaction SPRO open the SAP Reference IMG and navigate to NetWeaver Queues .

SAP 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. Click on the Activity icon. 2. Choose Create . The RFC Destination Window displays. 3. In RFC Destination specify a name for the RFC destination to be created. For example, BEP_BGRFC_DEST . 4. In Connection Type enter 3 , for ABAP connections. 5. 6. 7. 8. 9. 10.

In Description 1 , enter an explanatory text. Choose Enter , and select tab Technical Settings . Enter the SAP Gateway host name in Target Host , and enter its corresponding system number. On tab Logon & Security enter the technical user and make sure that Current User is not selected. Choose Enter and select the Special Options tab. Depending on the SAP NetWeaver version, do the following: For SAP NetWeaver 7.02, go to section Select Transfer Protocol and select 1 Classic with bgRFC from the list. For SAP NetWeaver 7.0, go to section Select qRFC Version and select bgRFC from the list in qRFC Version . 11. Choose Save and Yes to close the warning message that displays. 12. Choose Remote Connection to test the connection. Information about the connection type displays.

1.4.2.6.3 Connection Settings to SAP Gateway The Business Enablement Provisioning (BEP) functionality can publish events to one or more hosts running SAP Gateway. However, you must first identify the SAP Gateway landscape to use with it. For OData Channel you also specify the SAP Gateway landscape.

Prerequisites Make sure that you have: Defined an RFC destination to SAP Gateway to broadcast the events. The system name, client ID, and a system alias of the host of the SAP Gateway landscape to which you want to connect.

Specifying Connection Settings You can specify settings for connecting to a SAP Gateway landscape by using the implementation guide (IMG). In transaction SPRO open the SAP Reference IMG and navigate to SAP NetWeaver SAP Gateway Settings .

SAP Gateway Service Enablement

Backend OData Channel

Connection Settings to SAP Gateway

1. Click on the Activity icon. 2. Choose New Entries and enter the following: Destination System Specify the system name of the host of SAP Gateway. Client Specify the system client ID of the host of SAP Gateway. The client ID you specify should be in the specified system. System Alias Enter a unique name for the host of SAP Gateway. RFC Destination Specify the name of the RFC destination to the host of SAP Gateway, .for example BEP_BRFC_DEST .

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

Page 38 of 95

3. Save your settings.

1.4.2.6.4 Configure the bgRFC Supervisor Destination You configure a supervisor destination for the bgRFC to receive the configuration settings for the bgRFC scheduler. In addition, the supervisor starts or stops the schedulers as required.

Prerequisites You have created a system user of type B called BGRFCSUPER . Use transaction SU01 to create the system user. This user is used for the bgRFC communication using the destination you will create. For example, BGRFC_SUPERVISOR . You have assigned role SAP_BC_BGRFC_SUPERVISOR to user BGRFCSUPER . Use transaction SU01 to assign role to the user BGRFCSUPER . For SAP NetWeaver 7.0, you have created a bgRFC destination as an ABAP connection, using the RFC destination name BGRFC_SUPERVISOR , without load balancing, target host, SAP Gateway host and service. Specify the user, language and password. This ensures that the scheduler is activated on the same application server as the specified user. Later, you configure the supervisor destination for the bgRFC to receive the configuration settings for the bgRFC scheduler.

Note The bgRFC supervisor user you specify must have authorizations from authorization object S_RFC. These are defined in role SAP_BC_BGRFC_SUPERVISOR. The procedure you employ depends on the version of SAP NetWeaver in your system.

Configuring the bgRFC Supervisor Destination You can configure this bgRFC supervisor destination by using the implementation guide (IMG). In transaction SPRO open the SAP Reference IMG and navigate to SAP NetWeaver Supervisor Destination .

SAP Gateway Service Enablement

Backend OData Channel

Connection Settings to SAP Gateway

Create bgRFC

Proceed as follows: 1. Click on the Activity icon. 2. Select tab Define Supervisor Dest . 3. Depending on the version of SAP NetWeaver, do the following: For SAP NetWeaver 7.02, choose Create . The Create bgRFC Destination for Supervisor window is displayed. 1. Choose Create User . For example, BGRFCSUPER . 2. Save your settings. For SAP NetWeaver 7.0, make sure you have already created a separate bgRFC destination for the supervisor using the name BGRFC_SUPERVISOR. 1. Enter the bgRFC supervisor destination name BGRFC_SUPERVISOR , in Destination under New Supervisor Destination . 2. Choose Enter . The supervisor destination and the user details display. 4. In the bgRFC Configuration window choose Save .

More Information bgRFC (Background Remote Function Call)

1.4.2.6.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. All the messages are written in unit queues, which consist of function modules to be processed as an indivisible unit. Find all the messages that failed to be transported from the host of the backend or OData Channel to the consumer environment, because of system fault exceptions. System faults are all standard REST errors, for example: communication error, or other errors that occurred during the activation and operations of Web services.

Note Application fault exceptions are displayed in the application itself.

Prerequisites Make sure that you have the authorization object S_BGRFC for monitoring or customizing activities assigned to your user role.

Analyzing the Results of the Monitor You analyze each error message and decide how best to correct the error. If the error can be fixed, make the necessary corrections and then send it to the unit again, otherwise delete the unit. You can manually restart the unit even if the retry limit has been exceeded. You can go into the code to debug the unit (this requires the appropriate

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

Page 39 of 95

authorization role), or delete all the units inside the inbound destination. You can monitor the bgRFC queues by using the implementation guide (IMG). In transaction SPRO open the SAP Reference IMG and navigate to NetWeaver

SAP Gateway Service Enablement

Backend OData Channel

Connection Settings to SAP Gateway

Monitor bgRFC Queues

SAP .

Proceed as follows to monitor bgRFC queues: 1. Click on the Activity icon to open the bgRFC monitor. Alternatively you can use transaction SBGRFCMON. 2. Select the option for the Outbound scenario and the Queued unit type. Select other parameters of the monitor as required. 3. Choose Execute to run the monitor. The status of the queues is displayed. 4. Monitor the Queue with the Event ID and instance number for the messages which were not sent.

1.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. This section provides the configuration information for all the SAP Gateway supported scenarios. SAP Gateway supports services on these channels: OData Channel — See OData Channel Scenarios for information on configuration settings for OData Channel supported scenarios. Generic Channel — See Generic Channel Scenarios for information on configuration settings for Generic Channel supported scenarios.

Prerequisites Following are the different components (along with their releases) required for SAP Gateway. You can download the packages and patches from the SAP Service Marketplace at: http://service.sap.com/swdc

.

Component

Release

SAP ERP

ERP 2004 with NW 7.0 SPS 18 (validated stack)

SAP ECC add-on

ECC-SE 602 or higher

SAP BI (optional)

BI 3.5 – SP 22 or BI 7.0 - SP 17

SAP CRM

CRM 6.0 or higher

1.4.3.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. 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.4.3.1.1 Configuring Workflow for SAP Gateway This section explains how to configure Workflow for use with SAP Gateway scenarios. You can configure Workflow in the following ways: Configuring Workflow Notifications

Note If you want to obtain notifications, you first need to configure the Business Enablement Provisioning (IW_BEP) component before configuring Workflow. This is because Workflow for SAP Gateway is reliant on the BEP functionality. . If you do not configure the IW_BEP component, you can still use the Workflow functionality, but you will not be able to use Push notifications. If your system is based on SAP NetWeaver 7.40 or higher, you do not need to install the component IW_BEP since the SAP Gateway Foundation component SAP_GWFND is installed as standard. Workflow Settings

1.4.3.1.1.1 Creating an Administrator Role for Workflow Procedure Note To perform Workflow configuration steps, you must have an Administrator Role.

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

Page 40 of 95

You create a role for an administrator user with permissions and privileges for several tasks including the following: Analyze logs and identify potential issues with the ERP landscape. Configure and maintain Workflow-specific ERP components and applications. For more information about SAP user administrator types, see Setting Up User and Authorization Administrators in the SAP Help Portal.

Note For all steps in the IMG there is always consumer independent documentation available. To create the administrator role and assign it to users: 1. On the ERP system, open transaction PFCG . The Role Maintenance page is displayed. 2. In the Role field, enter any of the basis roles, for example: SAP_BC_BASIS_ADMIN SAP_BC_CTS_ADMIN SAP_BC_BASIS_MONITORING SAP_BC_BATCH_ADMIN SAP_BC_BDC_ADMIN SAP_BC_WEBSERVICE You can choose any of the listed standard administrator roles, or enter an existing one. 3. Choose the ( Copy Role ) icon to create a copy of the standard role. 4. In the Query dialog box, enter a name for the new role in the to role field, for example, Z_SAP_BC_BASIS_ADMIN . 5. 6. 7. 8. 9. 10. 11. 12. 13. 14.

Choose Copy all . The Change Roles dialog box is displayed and the role is created. In the Role Maintenance page, choose the Edit icon. Select the Authorizations tab. Choose Change Authorization Data under the Maintain Authorization Data and Generate Profiles section. Select Edit > Insert Authorization(s) > From template . The Choose Template page is displayed. Select /IWWRK/RT_WF_ADM from the list. Choose the checkmark. Choose Generate . The Generate profile dialog box is displayed. Select the Generate option. In the Assign Profile name for Generated Authorization Profile dialog, maintain the profile name according to your requirements. For example T-SCL550003 .

15. 16. 17. 18. 19. 20. 21. 22.

Choose the checkmark. The Change role: Authorizations page is displayed. The status of the profile is displayed as “Generated”. Go back to the Change Roles page, and select the Users tab in the User Assignment section. Enter the names of the users you want to assign to this role. Choose Save . Choose User comparison . The Complete Role Master Record page is displayed. Choose Complete comparison . Choose Save . Check that the role was properly created and assigned.

Recommendation Log on to the ERP system using the user you just assigned. You should be able to access transaction SIMGH and search for the entry Workflow Pattern Customization . You can logon to the ERP host with the administrator user you have created to configure the ERP components and content, and install consumer applications.

Recommendation Log on to the ERP system using the user you just assigned. You should be able to access transaction SIMGH and search for the entry Workflow Pattern Customization . You can logon to the ERP host with the administrator user you have created to configure the ERP components and content, and install consumer applications.

1.4.3.1.1.2 Customizing SAP Gateway Workflow Activities This section explains how to customize Workflow for use with SAP Gateway scenarios. Prerequisites Before sending notifications, you must configure the SAP Gateway Workflow process as described in the Configuring Workflow Notifications topic.

1.4.3.1.1.2.1 Configuring Workflow Notifications This section describes the basic flow for sending notifications. The flow is composed of the following steps: 1. Creating a type G RFC destination. 2. Configuring User Authorizations for Push Notifications.

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

Page 41 of 95

3. Running scheduled reports.

Prerequisites The following prerequisite must be complied with before you can send notifications: Workflows containing User Decisions or Activity Steps, are configured in the system and can be triggered in the SAP Business Suite system. After the notifications have been configured, you must subscribe to the relevant Workflow service as described in the Subscribing to Notification Types topic.

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

Note The delivery address is that of the SAP connectivity service. The SAP connectivity service on-demand component resides in the customer's on premise environment. It is responsible for enabling the connectivity from the SAP connectivity service servers, located in SAP's on-demand environment, to the customer's SAP Gateway instance, located in customer's onpremise environment. To create a type G RFC destination: 1. In the SAP Gateway system, open transaction SPRO. 2. Choose SAP Reference IMG . 3. Select SAP Customizing Implementation Guide SAP NetWeaver SAP Gateway SAP Gateway to Consumer Create RFC Destination for Outbound Queues . 4. Choose Execute. The Configuration of RFC Connections page is displayed. 5. Choose Create. 6. In the RFC Destination field, enter the desired name, for example GW_RFC . 7. 8. 9. 10. 11. 12. 13. 14. 15. 16.

OData Channel

Configuration

Connection Settings

In the Connection Type field, press F4 and select G HTTP Connection to External Server . Under the Technical Settings tab, in the Description field, enter the desired description. Press Enter. An Information dialog box is displayed. Choose the checkmark to continue. In the Target Host field, enter the host IP. In the Service No. field, enter the port number. In the Path Prefix field, enter any additional directories, if relevant. If relevant, select the Logon & Security tab. Enter the security settings as required. Choose Save.

To continue with the flow, go to Configuring User Authorizations for Push Notifications.

1.4.3.1.1.2.1.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. 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, make sure you use the Role Template. 1. In the SAP Business Suite system, open transaction PFCG. 2. In the Role field, enter name of role you want to create. 3. Choose Single Role . 4. Choose Save. 5. Select the Authorizations tab and choose the Edit icon. 6. 7. 8. 9.

Choose Change Authorization Data under the Maintain Authorization Data and Generate Profiles section. Select Edit > Insert Authorization(s) > From template . The Choose Template page is displayed. Select /IWWRK/TR_WF_GW_USR from the list. Choose the Adopt reference .

10. Choose Generate. The Generate profile dialog box is displayed. 11. Choose the Generate option. 12. In the Assign Profile name for Generated Authorization Profile dialog, maintain the profile name according to your requirements. For example T-SCL550 . 13. Choose the checkmark. The Change role: Authorizations page is displayed. The status of the profile is displayed as “Generated”. 14. Go back to the Change Roles page, and select the Users tab in the User Assignment section. 15. Enter the names of the users you want to assign to this role. 16. Choose Save. 17. Choose User comparison . The Complete Role Master Record page is displayed. 18. Choose Complete comparison . 19. Choose Save. 20. Check that the role was properly created and assigned.

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

Page 42 of 95

To continue with the flow, go to Running Scheduled Reports.

1.4.3.1.1.2.1.3 Running Scheduled Reports To send notifications tasks between the ECC SAP system and consumer applications, 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. Schedule the reports as per the following sequence: 1. Schedule the NetWeaver report RSWNSEL (or run the report when required). The necessary variant of the report is Scenario OSP, filter OSP_DELTA. We recommend that you run the reports at a frequency of 15 minutes. 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. 2. Schedule the Workflow SAP Gateway pattern report /IWWRK/R_WF_ITEM_SELECTION_GW (or run the report when required). This report should run after the successful execution of the NetWeaver report RSWNSEL. This report processes the workflow items retrieved by the report RSWNSEL and sends task notifications. The necessary variant of the report is a Default variant. We recommend that you run this report at a frequency of 15 minutes. Refer to the next section Procedure to Schedule Running of Reports to run the reports.

Procedure to Schedule Running of Reports You can schedule the running of reports using your administrator user. To schedule running of various reports, 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. On the SAP system, open transaction SE38 The ABAP Editor: Initial Screen page is displayed. 2. In the Program field, enter RSWNSEL . 3. Select the Variants radio button. 4. Choose Display. The ABAP: Variants – Initial Screen page is displayed. 5. In the Variant field, enter the name of the variant. For example, GW_VAR1 6. 7. 8. 9. 10.

Choose Create. The Maintain Variant: Report page is displayed. In the Scenario field, enter OSP. In the Filter field, enter OSP_DELTA. Choose Attributes . The Variant Attributes page is displayed. In the Description field, enter the variant’s description.

11. Choose 12. Choose

Save. The Maintain Variant: Report page is displayed. Save to save the value of the variants.

Creating Variants for Report /IWWRK/R_WF_ITEM_SELECTION_GW To create variants for the /IWWRK/R_WF_ITEM_SELECTION_GW report: 1. On the SAP system, open transaction SE38 The ABAP Editor: Initial Screen page is displayed. 2. In the Program field, enter /IWWRK/R_WF_ITEM_SELECTION_GW . 3. Select the Variants radio button. 4. Choose Display. The ABAP: Variants – Initial Screen page is displayed. 5. In the Variant field, enter the name of the variant. For example, GW_VAR1 6. Choose Create. The Maintain Variant: Report page is displayed. 7. Choose Attributes . The Variant Attributes page is displayed. 8. In the Description field, enter the variant’s description. 9. Choose 10. Choose

Save. The Maintain Variant: Report page is displayed. Save to save the value of the variants.

Scheduling Background Jobs To schedule background jobs: 1. 2. 3. 4. 5. 6. 7. 8. 9. 10. 11. 12.

On to the SAP system, open transaction SM36. The Define Background Job page is displayed. Choose Job wizard to create a new job. In the wizard’s opening page, choose Continue . In the Job Name field enter a name and choose Continue . Select the ABAP program step radio button and choose Continue . In the ABAP Program Name field enter the report name (RSWNSEL). In the Variant field, enter the variant name, for example GW_VAR1 and choose Continue . Check the Add additional steps (optional) checkbox, and choose Continue . Select the ABAP program step radio button and choose Continue . In the ABAP Program Name field enter the report name (/IWWRK/R_WF_ITEM_SELECTION_GW) In the Variant field, enter the variant name, for example GW_VAR1 and choose Continue twice. Select the Immediately radio button and choose Continue .

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

Page 43 of 95

13. In the Periodic jobs section, select the Period checkbox and choose Continue . 14. Select None of the above and choose Other periods . 15. In the Minute(s) field, enter 15 . 16. Choose Create . 17. Choose Continue . 18. Choose Complete . Updating Background Jobs To update background jobs: For help on updating a job, refer to the topic Background Job Monitoring Monitor on the SAP Library at http://help.sap.com/saphelp_nw70ehp1/helpdata/en/1d/ab3207b610e3408fff44d6b1de15e6/frameset.htm

and to the topic Managing Jobs from the Job

Overview on the SAP Library at http://help.sap.com/saphelp_wp/helpdata/en/c4/3a8009505211d189550000e829fbbd/frameset.htm

This is the last step in the configuration flow, go to Subscribing to Notification Types to subscribe to the relevant Workflow service.

1.4.3.1.1.2.2 Workflow Settings This section describes how to configure the Workflow process. 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 the appropriate service for your system landscape. 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, see Deployment Options.

Note If your system landscape is based on SAP NetWeaver 7.40 or higher, you do not need to install the IW_BEP component in your system since the BEP functionality is included in the core SAP Gateway component SAP_GWFND, which is installed as standard.

Activating the Service By default, the service is deactivated. To consume it, you must first activate it. 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. 2. If you are using the central hub deployment option, set the For Local App flag. 3. 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.

Workflow Configurations You can perform the following configurations on the Workflow process: Task Provider Customizing Maintain Workflow Filter Settings Maintain Task Names and Decision Options Enable Task Filter To reach these activities: 1. From your SAP system, open transaction SPRO. 2. Choose SAP Reference IMG . 3. Navigate to SAP NetWeaver SAP Gateway Service Enablement

Content

Workflow Settings

.

Task Provider Customizing This activity allows you to maintain Workflow task providers in the Task Provider Framework. 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. The Generic Worklist collects the user items from all customized active task providers to create a unified inbox view. Activating an Existing Provider To activate an existing provider: 1. In the Dialog Structure section, double-click Providers . 2. From the Providers table, select the BWF checkbox to activate the /IWWRK/WFSERVICE subscription notification. 3. Choose Save. Adding a New Provider To add a new provider, you must register an entry in the Providers section, add its details in the Provider Details section and define its adapter classes for the Task Provider Framework in the Adapter Classes section. You can also maintain additional services for the provider. 1. In the Dialog Structure section, double-click Providers . 2. Choose New Entries .

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

Page 44 of 95

3. 4. 5. 6. 7.

In the Providers section, enter the provider ID and select the Active checkbox. Choose Save. In the Dialog Structure section, select Provider Details . Choose New Entries . In the Provider Details table, enter the provider ID, the default internal service name, the version number, and the provider's description.

Note If no specific service can be found for an item, the default service and version number is used instead. 8. Choose Save. Defining the Provider Adapter Classes 1. 2. 3. 4. 5. 6.

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

1. In transaction SPRO open the SAP Reference IMG and navigate to 2. 3. 4. 5. 6. 7.

SAP NetWeaver

SAP Gateway

OData Channel

Configuration

Connection Settings SAP Gateway to SAP System . Click the Manage SAP System Aliases activity icon. Choose New Entries . In the SAP System Alias field, enter the name of the alias that you created. In the Description field, enter a long text. Select the For Local App checkbox. In the RFC Destination field, enter NONE .

8. In the Software Version field, enter /IWPGW/PO . 9. Save your settings.

1.4.3.1.2.2.5 Activating the Process Service You use this procedure to activate the process service for an SAP Business Suite system. This enables a user to retrieve and use process definition and instance information.

Prerequisites You have created a system alias for the SAP Business Suite system.

Procedure 1. Log on to the SAP Gateway system. 2. In transaction SPRO open the SAP Reference IMG and navigate to

SAP NetWeaver

SAP Gateway

OData Channel

Administration

General

Settings . 3. Click the Activate and Maintain Services activity icon. 4. In the Service Catalog section, check if the ZPGW technical service name exists. 5. If ZPGW exists, perform the following substeps: 1. Select the ZPGW service. 2. Choose System Alias . 3. Choose New Entries . 4. In the Service Doc. Identifier field, enter ZPGW_0001 . 5. In the SAP System Alias field, select the alias of the provider system. 6. If ZPGW does not exist, perform the following substeps: 1. Choose Add Service . 2. In the System Alias field, select the alias of your provider system. 3. Press Enter . 4. Select the entry with technical service name /IWPGW/PGW . 5. In the Package field, enter $TMP . 6. Choose Continue . 7. Save your settings.

1.4.3.1.2.1.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. This enables a user to retrieve and use process context information in addition to process definition and instance information.

Procedure 1. Log on to the SAP Gateway system where Business Process Content Powered by SAP NetWeaver is deployed. 2. In transaction SPRO open the SAP Reference IMG and navigate to SAP NetWeaver SAP Gateway Service Enablement 3. 4. 5. 6. 7. 8. 9. 10. 11. 12. 13.

Content

Business

Process Enablement . Expand the Process Context Service node. Click the Register Context Service for Process Definition activity icon. Choose Add Service . In the System Alias field, select the alias of the required provider system. Press Enter . Select the process definition entry for which you want the system to retrieve the context details. Choose Select . Make a note of the value in the Technical Model Name field. Press Enter . Choose Yes for the confirmation message. Choose Continue .

1.4.3.1.2.2.7 Activating the Process Context Service You use this procedure to activate the process context service for an SAP Business Suite system. This enables a user to retrieve and use process context

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

Page 48 of 95

information in addition to process definition and instance information.

Prerequisites You have created the system alias for the SAP Business Suite system.

Procedure 1. Log on to the SAP Gateway system. 2. In transaction SPRO open the SAP Reference IMG and navigate to 3. 4. 5. 6. 7.

SAP NetWeaver

SAP Gateway

OData Channel

Administration

General

Settings . Click the Activate and Maintain Services activity icon. Choose Add Service . In the System Alias field, select the alias of the provider system. In the Technical Service Name field, enter the service name you made a note of when registering the context service. Press Enter .

8. In the Add Service section, select the technical service name entry. 9. In the Package field, enter $TMP . 10. Choose Continue .

1.4.3.1.2.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. In this case, you perform the configuration steps on two different systems.

Procedure 1. Create a connection from Business Process Content Powered by SAP Gateway system to SAP Business Suite system. For more information, see Connecting Business Process Content and Business Suite Systems. 2. Create a system alias for the SAP Business Suite system in Business Process Content Powered by SAP Gateway system. For more information, see Creating a System Alias for SAP Business Suite System. 3. Create a connection from SAP Gateway system to Business Process Content Powered by SAP Gateway system. For more information, see Connecting SAP Gateway and Business Process Content. 4. Create a system alias for the Business Process Content Powered by SAP Gateway system in the SAP Gateway system. For more information, see Creating a System Alias for Business Process Content System. 5. Activate the process service for the SAP Business Suite system. For more information, see Activating the Process Service. 6. If you want to enable a user to consume process context information, perform the following substeps: 1. Register the process context service for the SAP Business Suite system. For more information, see Registering Process Context Service for Deployment Scenario 2. 2. Activate the process context service for the SAP Business Suite system. For more information, see Activating the Process Context Service.

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.

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.

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

Page 49 of 95

8. 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. 14. 15. 16. 17.

In the Target Host field, enter the server name of the business suite system. In the System Number field, enter the instance number of the business suite system. Choose the Logon & Security tab page. Select the Current User checkbox. Check that the Trust Relationship or Trusted System option is set to Yes .

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.2.2.2 Creating a System Alias for SAP Business Suite System Prerequisites You have configured a connection to 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. Click the Maintain System Alias activity icon. Choose New Entries . In the SAP System Alias field, enter a name for the alias. In the Process Platform field, select Business Suite Process Observer Provider . In the RFC Destination field, enter the RFC destination of the business suite system.

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

Page 50 of 95

9. Save your settings.

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

Prerequisites You have enabled a trusted RFC connection in the Business Process Content Powered by SAP Gateway system.

Procedure 1. Log on to the SAP Gateway system. 2. In transaction SPRO open the SAP Reference IMG and navigate to 3. 4. 5. 6.

SAP NetWeaver

SAP Gateway

OData Channel

Configuration

Connection Settings SAP Gateway to SAP System . Choose the Manage RFC Destinations activity icon. Choose Create . In the RFC Destination field, enter a name for the RFC destination you want to create. In the Connection Type field, enter 3 .

7. In the Description 1 field, enter a description for the RFC destination. 8. Press Enter . 9. Choose the Technical Settings tab page. 10. Check that the Load Balancing option is set to No . 11. 12. 13. 14. 15.

In the Target Host field, enter the server name of the Business Process Content system. In the System Number field, enter the instance number of the Business Process Content system. Choose the Logon & Security tab page. Select the Current User checkbox. Check that the Trust Relationship option is set to Yes .

16. Save your settings. 17. To check if the connection is working, choose Connection Test .

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

Procedure 1. Log on to the SAP Gateway system. 2. In transaction SPRO open the SAP Reference IMG and navigate to 3. 4. 5. 6. 7. 8.

SAP NetWeaver

SAP Gateway

OData Channel

Configuration

Connection Settings SAP Gateway to SAP System . Click the Manage SAP System Aliases activity icon. Choose New Entries . In the SAP System Alias field, enter the name of the alias that you created in the Business Process Content system. In the Description field, enter a long text. In the RFC Destination field, enter the RFC destination of Business Process Content system. In the Software Version field, enter /IWPGW/PO .

9. Save your settings.

1.4.3.1.2.2.5 Activating the Process Service You use this procedure to activate the process service for an SAP Business Suite system. This enables a user to retrieve and use process definition and instance information.

Prerequisites You have created a system alias for the SAP Business Suite system.

Procedure 1. Log on to the SAP Gateway system.

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

Page 51 of 95

2. In transaction SPRO open the SAP Reference IMG and navigate to

SAP NetWeaver

SAP Gateway

OData Channel

Administration

General

Settings . 3. Click the Activate and Maintain Services activity icon. 4. In the Service Catalog section, check if the ZPGW technical service name exists. 5. If ZPGW exists, perform the following substeps: 1. Select the ZPGW service. 2. Choose System Alias . 3. Choose New Entries . 4. In the Service Doc. Identifier field, enter ZPGW_0001 . 5. In the SAP System Alias field, select the alias of the provider system. 6. If ZPGW does not exist, perform the following substeps: 1. Choose Add Service . 2. In the System Alias field, select the alias of your provider system. 3. Press Enter . 4. Select the entry with technical service name /IWPGW/PGW . 5. In the Package field, enter $TMP . 6. Choose Continue . 7. Save your settings.

1.4.3.1.2.2.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, which enables a user to retrieve and use process context information in addition to process definition and instance information.

Prerequisites You have created the system alias for the SAP Business Suite system.

Procedure 1. Log on to the Business Process Content Powered by SAP Gateway system. 2. In transaction SPRO open the SAP Reference IMG and navigate to SAP NetWeaver 3. 4. 5. 6. 7. 8. 9. 10. 11. 12.

SAP Gateway Service Enablement

Content

Business

Process Enablement . Expand the Process Context Service node. Click the Register Context Service for Process Definition activity icon. Choose Add Service . In the System Alias field, select the alias of the required business suite provider system. Press Enter . In the Add Context Service section, select the process definition for which you want to register the context service. Press Enter . Make a note of the value in the Technical Model Name field. Press Enter . Choose Yes for the confirmation message.

1.4.3.1.2.2.7 Activating the Process Context Service You use this procedure to activate the process context service for an SAP Business Suite system. This enables a user to retrieve and use process context information in addition to process definition and instance information.

Prerequisites You have created the system alias for the SAP Business Suite system.

Procedure 1. Log on to the SAP Gateway system. 2. In transaction SPRO open the SAP Reference IMG and navigate to 3. 4. 5. 6. 7.

SAP NetWeaver

SAP Gateway

OData Channel

Administration

General

Settings . Click the Activate and Maintain Services activity icon. Choose Add Service . In the System Alias field, select the alias of the provider system. In the Technical Service Name field, enter the service name you made a note of when registering the context service. Press Enter .

8. In the Add Service section, select the technical service name entry. 9. In the Package field, enter $TMP . 10. Choose Continue .

1.4.3.1.2.3 User Authorizations for SAP Business Workflow PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.

Page 52 of 95

1.4.3.1.2.3 User Authorizations for SAP Business Workflow Systems To access the process details from an SAP Business Workflow system, a user must have the authorizations listed below. Authorization Object: PLOG Authorization Field

Value

PPFCODE

DISP

PLVAR

dummy

OTYPE

WS

INFOTYP

1000

SUBTYP

dummy

ISTAT

1

1.4.3.1.3 Configuring the Task Gateway Service The Task Gateway service provides an access point for consumer applications to different tasks using SAP Gateway. This OData service allows different task providers to expose tasks within one harmonized view. For more information about role templates required for configuration, see User, Developer, and Administrator Authorizations.

Prerequisites If you have an SAP NetWeaver Business Process Management (BPM) system, you must create a logical port to it before installing the Task Gateway service. To integrate BPM, you require SAP NetWeaver 7.31 SP05 or higher. To create a logical port: 1. 2. 3. 4. 5.

In your SAP Gateway system, open transaction SOAMANAGER. Select the Service Administration tab. Choose Single Service Configuration . From the Search by: by drop-down list, select Consumer Proxy . In the Search Pattern: field, enter TaskFacade .

6. 7. 8. 9. 10. 11. 12. 13. 14. 15. 16. 17.

From the Field: by drop-down list, select External Name . Choose Go . In the Search Results table, select the consumer proxy. Choose Apply Selection . In the Details of Proxy Definition section, select the Configurations tab. Choose Create Logical Port . The SOA Management popup is displayed. In the Logical Port Name field, enter the port name. In the Description field, enter a description providing additional information about the connection. Under Configuration Type , select the Manual Configuration radio button. Choose Apply Settings . In the Configuration for Logical Port section, select the Transport Settings tab. In the URL Access Path field, enter TaskFacadeService/TaskFacade .

18. 19. 20. 21.

In the Computer Name of Access URL field, enter the computer's name. In the Port Number of Access URL field, enter the relevant port number. Select the Consumer Security tab. Under the Authentication Settings section, select the SAP Authentication Assertion Ticket radio button.

Note For more information about SSO (Single Sign On), see the Administration for User Authentication and Single Sign-On (SSO) section. 22. Save the changes.

Installing the Service To use the Task Gateway service: If your system landscape is based on SAP NetWeaver 7.0, 7.01, 7.02, 7.03 or 7.31, you must first install the components IW_PGW and IW_BEP in your SAP Gateway system. To support the Business Workflow, you must also install the component IW_BEP in your SAP Business Suite system. If your system landscape is based on SAP NetWeaver 7.40 or higher, 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. However, you must install the component IW_PGW. For more information, see Deployment Options.

Activating the Service Activating the service consists of two main steps: 1. Setting up the service in the SAP Gateway system: Create a system alias.

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

Page 53 of 95

Activate the service. Assign the software version to the service. 2. Connecting the service to the SAP Business Suite backend system where you want to have the SAP Gateway information displayed: Add additional system aliases. The service uses the multi-origin composition (MOC) component. For more information, see the Multiple Origin Composition section. To create a system alias: 1. In the SAP Gateway system, open transaction SPRO. 2. Choose SAP Reference IMG . 3. Select SAP Customizing Implementation Guide SAP NetWeaver SAP Gateway OData Channel Configuration Connection Settings SAP Gateway to SAP System . 4. Open the Manage SAP System Aliases activity. The Change View “Manage SAP System Aliases”: Overview page is displayed. 5. Choose New Entries . 6. In the Manage SAP System Aliases table, enter the following: Under SAP System Alias , enter the new system alias. For example, GWQ_800_BEP. Under Under Under Under

Description , enter a description for the system alias. Local SAP GW , make sure the checkbox is not selected. For Local App , select the checkbox. RFC Destination , enter the trusted RFC destination to the SAP system.

Note If you have an SAP NetWeaver BPM system, set WS Provider System as the RFC Destination. Under Software Version , press F4 and select the relevant data provider (software version), for example, /IWPGW/BWF or/IWPGW/BPM (for a BPM system). 7. Choose Save. 8. To create additional system aliases for other providers like BPM repeat steps 5 to 7. To activate the service: 1. In the SAP Gateway system, open transaction SPRO. 2. Choose SAP Reference IMG . 3. Select SAP Customizing Implementation Guide 4. Open the Activate and Maintain Services activity.

SAP NetWeaver

SAP Gateway

OData Channel Development with IW_BEP

Registration

.

5. Choose Add New Service . ( Add New Service ). The Add Service page is displayed. 6. In the System Alias field, press F4 and select the system alias you created in the procedure above. 7. Press Enter . The Add Service table is populated. 8. From the Technical Service Name column, double-click /IWPGW/TASKPROCESSING. The Add Service page is displayed. 9. 10. 11. 12. 13.

Copy the name that appears in the Technical Model Name field, you will need it to assign the software version to the service. In the Package field, enter the package to which you want to assign the service. Choose the checkmark. The Activate and Maintain Services page is displayed. Under the ICF Nodes section, make sure the ODATA node status is set to Active . Under the System Aliases section, make sure the system alias we activated is displayed.

To assign the software version to the service: 1. In the SAP Gateway system, open transaction SPRO. 2. Choose SAP Reference IMG . 3. Select SAP Customizing Implementation Guide SAP NetWeaver SAP Gateway OData Channel Development with IW_BEP Registration . 4. Open the Assign Data Provider to Data Model activity. The Change View “Assign Data Provider to Data Model”: Overview page is displayed. 5. Choose New Entries . 6. In the Assign Data Provider to Data Model table, enter the following: Under Model Identifier , enter the technical name you obtained in the previous step (To activate the service) followed by _0001_BE . For example, _0001_BE .

Under Type , select (Adaptation) Data Provider from the drop-down list. Under Software Version , press F4 and select the relevant software version for example /IWPGW/BPM or /IWPGW/BWF. Under Class/Interface , enter /IWFND/CL_MGW_RUNT_RCLNT_PRXY. Under Description , enter a description of the data model. Under Model Name , enter enter the technical name you obtained in the previous step (To activate the service). 7. Choose Save. 8. To create additional software versions, repeat steps 5 to 7. To add additional system aliases: 1. Create a new system alias as described in the procedure above. 2. In the SAP Gateway system, open transaction SPRO. 3. Choose SAP Reference IMG . 4. Select SAP Customizing Implementation Guide SAP NetWeaver SAP Gateway OData Channel OData Channel Development with IW_BEP Registration . 5. Open the Activate and Maintain Services activity. The Activate and Maintain Services page is displayed. 6. In the Service Catalog table, search for TASKPROCESSING in the External Service Name column and select the entire line. 7. In the System Aliases section, choose ( Add System Alias ). The Change View “Assign SAP System Aliases to OData Service”: Overview page is displayed. 8. Select an existing SAP system alias and choose Copy. 9. In the SAP System Alias field, press F4 and select the System Alias you have created. 10. In the Default System field, the checkbox does not need to be selected. If the checkbox is selected, the corresponding SAP system will be called by default. 11. Choose ( Copy ). 12. Choose Save.

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

Page 54 of 95

Note For the role template /IWPGW/RT_WF_USR, you must maintain the authorization object S_SERVICE with the object types IWSG and IWSV. For more information, seeRoles in the SAP Gateway Landscape, section Assignment of Authorization Objects. Once your service is activated you can navigate to the Task collection to get all your inbox tasks from the implemented providers, such as Business Workflow and BPM. For example: http://:/sap/opu/odata/IWPGW/TASKPROCESSING;mo/TaskCollection

Adding New Providers Task SAP Gateway service has two providers out-of-the-box: a provider for SAP Business Workflow, and one for BPM. If you require an additional provider, you must add it manually. To add a new provider: 1. 2. 3. 4.

In your SAP Gateway system, open transaction SPRO. Choose SAP Reference IMG . 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.

.

1.4.3.1.3.1 Creating a System Alias To create a system alias for the Task Gateway service, proceed as follows: 1. In the SAP Gateway system, start transaction SPRO. 2. Choose SAP Reference IMG . 3. Choose SAP Customizing Implementation Guide SAP NetWeaver Gateway OData Channel Configuration Connection Settings Gateway to SAP System . 4. Select the Manage SAP System Aliases activity. The Change View "Manage SAP System Aliases" Overview screen is displayed. 5. Choose New Entries . 6. In the Manage SAP System Aliases table, enter the following: Under SAP System Alias , enter the system alias, for example, BEP. Under Under Under Under

SAP

Description , enter a description for the system alias. Local SAP GW , ensure that this checkbox is not selected. For Local App , select the checkbox. RFC Destination , enter the trusted RFC destination to the SAP system.

Note If you want to create a system alias for an SAP Business Process Management (BPM) system, set WS Provider Systems (enter the logical port you maintained in SOAMANAGER) and leave the RFC destination empty. Under Software Version , use input help ( F4 ) and select the relevant data provider (software version), for example, /IWPGW/BWF for an SAP Business Worfklow (BWF) system or /IWPGW/BPM for an SAP Business Process Management system. 7. Choose Save .

Note To create additional system aliases for other providers such as SAP Business Workflow Management (BWF) or SAP Business Process Management (BPM), repeat steps 5-7.

1.4.3.1.3.2 Activating Task Gateway Service To activate the Task Gateway service, proceed as follows: 1. In the SAP Gateway system, start transaction SPRO. 2. Choose SAP Reference IMG . 3. Choose SAP Customizing Implementation Guide

SAP NetWeaver

Gateway

OData Channel

Administration

General Settings

.

Note If your system is based on SAP NetWeaver 7.40 or higher, choose OData Channel Administration General Settings .

SAP Customizing Implementation Guide

SAP NetWeaver

SAP Gateway

4. Select the Activate and Maintain Services activity. 5. Choose Add New Service . The Add Service screen is displayed. 6. In the System Alias field, use input help ( F4 ) and select the system alias you have created. 7. Press Enter . The Add Service table is populated. 8. In the Technical Service Name column, double-click /IWPGW/TASKPROCESSING. The Add Service screen is displayed. 9. Copy (or make note of) the name that is displayed in the Technical Model Name field. You need this to assign the software version to the service. 10. In the Package field, enter the package to which you want to assign the service for transportation from one system to another. If you do not want the service to be transported, enter $TMP as the package name and the service will be created locally. 11. Choose the checkmark. The Activate and Maintain Service screen is displayed. 12. In the ICF Nodes section, ensure the ODATA node status is set to Active . 13. In the System Aliases section, ensure that the correct system alias is displayed.

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

Page 55 of 95

Result After you have activated the service, you can navigate to the Task collection to get all your inbox tasks from the implemented providers such as SAP Business Workflow and SAP Business Process Management (BPM).

Example http://:/sap/opu/odata/IWPGW/TASKPROCESSING;mo;v=/TaskCollection

1.4.3.1.3.3 Assigning a Software Version to Service To assign a software version to the service, proceed as follows: 1. In the SAP Gateway system, start transaction SPRO. 2. Choose SAP Reference IMG . 3. Choose SAP Customizing Implementation Guide

SAP NetWeaver

Gateway

OData Channel

Administration

General Settings

.

Note If your system is based on SAP NetWeaver 7.40 or higher, choose OData Channel Administration General Settings .

SAP Customizing Implementation Guide

SAP NetWeaver

SAP Gateway

4. Select the Assign Data Provider to Data Model activity. The Change View "Assign Data Provider to Data Model: Overview" screen is displayed. 5. Choose New Entries . 6. In the Assign Data Provider to Data Model table, enter the following: Under Model Identifier , enter the technical model name defined when you activated the service followed by _0001_BE . For example, _0001_BE .

Under Type , select (Adaption) Data Provider from the drop-down list. Under Software Version , use input help ( F4 ) and select the relevant software version, for example, /IWPGW/BWF or /IWPGW/BPM. Under Class/Interface , enter /IWFND/CL_MGW_RUNT_RCLNT_PRXY. Under Description , enter a description for the data model. Under Model Name , enter the technical name specified when you activated the service. 7. Choose Save .

Note To create additional software versions, repeat steps 5 to 7. For each system in your system landscape that is to be used with Task Gateway, you will need to repeat these steps to ensure that the relevant software version is assigned. The software version dictates the provider that is to be called.

More Information For information about how to activate a service, see Activating a Service.

1.4.3.1.3.4 Adding Additional System Aliases You can add additional SAP system aliases and assign these to the TASKPROCESSING OData service. By adding additional system aliases and assigning these to the service, data requests from an SAP Gateway consumer can be routed to the corresponding backend system. The SAP system alias can have a specific role or a specific host name associated to itself, so that you can specify different roles or host names for the same system alias. If you leave the User Role or the Host Name field empty, the setting is valid for all roles/host names. Different backend systems are supported, if you specify corresponding roles/host names and system aliases. The roles are only for user grouping and do not need to have any special authorization. For more information, see Assigning SAP System Alias to OData Service . To add additional system aliases, proceed as follows: 1. Create a new system alias. 2. In the SAP Gateway system, open transaction SPRO. 3. Choose SAP Reference IMG . 4. Choose SAP Customizing Implementation Guide

SAP NetWeaver

Gateway

OData Channel

Administration

General Settings

.

Note If your system is based on SAP NetWeaver 7.40 or higher, choose OData Channel Administration General Settings .

SAP Customizing Implementation Guide

SAP NetWeaver

SAP Gateway

5. Select the Activate and Maintain Services activity. The Activate and Maintain Service screen is displayed. 6. In the Service Catalog table, search for TASKPROCESSING in the External Service Name column and select the entire row. 7. In the System Aliases section, choose Add System Alias . The Change View "Assign SAP System Aliases to OData Service" Overview screen is displayed. 8. Select an existing SAP system alias and choose Copy . 9. In the SAP System Alias field, use input help ( F4 ) and select the System Alias you have created. 10. In the Default System field, the checkbox does not need to be selected. If the checkbox is selected, the corresponding SAP system is called by default. 11. Choose Enter . 12. Choose Save .

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

Page 56 of 95

More Information For information about how to create a new system alias, see Creating a System Alias.

1.4.3.1.3.5 Adding New Providers The Task Gateway service has two providers out-of-the-box, one for SAP Business Workflow and one for SAP NetWeaver Business Process Management. If you require an additional task provider, you must add it manually. To add a new provider, proceed as follows: 1. In your SAP Gateway system, start transaction SPRO. 2. Choose SAP Reference IMG . 3. Choose SAP NetWeaver SAP Gateway Service Enablement Content Task Gateway Service Registration 4. Select the Provider Implementation activity. Follow the instructions provided in the activity's documentation.

.

1.4.3.1.3.6 Enabling User List for Task Gateway Service When you set up the Task Gateway Service, 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). 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, for example, you should enable the user list function. To enable the user list for selection purposes for Task Gateway, proceed as follows: 1. In your SAP Gateway system, start transaction SPRO. 2. Choose SAP Reference IMG . 3. In the SAP Customizing Implementation Guide, choose Gateway Service . 4. Open the Task Gateway Service Settings activity. 5. Choose Edit . 6. Select the Is User List Enabled column. 7. Choose Save .

SAP NetWeaver

SAP Gateway Service Enablement

Content

Task Gateway

Task

Result If the Is User List Enabled column is selected, the user list is enabled and consequently a list of all users in the SAP Gateway system is available for selection in the input help for Task Gateway. If the Is User List Enabled column is not selected, the user list is disabled and consequently no input help containing user names is available for Task Gateway. Consequently, it is necessary to enter the specific name for substitutes, for example.

1.4.4 Former Development In this section, you can find information about former development and programming paradigms.

Recommendation We strongly recommend using the OData Channel (ODC) programming paradigm for all SAP Gateway development. As of SAP Gateway 2.0 Support Package 05, you are strongly recommended to use the Service Builder (transaction SEGW) for your OData design-time development . For more information, see SAP Gateway Service Builder. Depending on whether you want to develop SAP Gateway content in an SAP Business Suite backend system or in an SAP Gateway hub system, you can choose between embedded deployment or central hub deployment. For more information, see Embedded Versus Hub Deployment and Deployment Options. This section comprises the following information:

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. All rights reserved.

Page 57 of 95

1.4.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. 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. 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. All rights reserved.

Page 58 of 95

EmployeeTimeSheetAllowedWo rkBreakDownStructureElemen tByEmployeeQueryResponse_I n EmployeeTimeSheetAllowedRe ceivingCostCentreByEmploye eQueryResponse_In EmployeeTimeSheetAllowedOr derByEmployeeQueryResponse _In EmployeeTimeSheetAllowedRe sourceClassByEmployeeQuery Response_In WorkAgreementSimpleByEleme ntsQueryResponse_In

1.4.4.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. The SAP Gateway ERP users should be assigned to these roles so that they can use SAP Gateway services. For this: 1. Identify the list of SAP ERP systems on which the functionality should be accessible by SAP Gateway. 2. Create system alias for each of these systems. 3. For each of these systems, define a role for which the administrator should assign the list of users (who has access to execute the functionality)

Note 1. You must be an SAP Gateway administrator or have an SAP user administrator to create the roles. 2. The roles must be defined/created on the SAP Gateway server. 3. If there is only one SAP ERP system and all the users on SAP Gateway should be able to access ERP functionality on this SAP ERP system then role creation and assigning of roles to GSDO groups is optional but this is not recommended. To create roles, proceed as follows: 1. Open transaction pfcg in the SAP Gateway system. 2. 3. 4. 5. 6. 7. 8.

Enter a name for the role in the Role field. Choose Single Role . Save the Role . Choose the Authorization tab. Choose Change Authorization . Choose the template mentioned in the Role Templates section. Choose Generate to create a new role.

For information on changing roles, see Changing Standard Roles.

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. All rights reserved.

Page 59 of 95

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, 56B1795EE40F0F7302DE059E7586FA SRV_TYPE-HT

S_CODE

TCD-SICF

While creating role template in the SAP ERP system, include the authorizations provided in the table below. The user must have these authorizations to access SAP ERP system for SAP ERP scenarios: SAP ERP Scenario Employee

Service

Authorization Object S_RFC

Authorization Values RFC_TYPE=FUGR/RFC_NAME=RH6 5/ ACTVT=16 RFC_TYPE=FUGR/RFC_NAME=BFH V/ ACTVT=16 RFC_TYPE=FUGR/RFC_NAME=PAD _ESA_SERVICES/ ACTVT=16 RFC_TYPE=FUGR/RFC_NAME=HRW PC_EMPLOYEEPROFILE_45FF/ ACTVT=16

Material

S_RFC

RFC_TYPE=FUGR/RFC_NAME=BFH V, BUS1001 and BUS1001006/ACTVT=16

Bill of Material (BOM)

S_RFC

RFC_TYPE=FUGR/RFC_NAME=SU_ USER,CSEP,BUS1001 and C1L6/ACTVT=16

ERP Document

S_RFC

RFC_TYPE=FUGR/RFC_NAME=CVB API and CVAPI01/ACTVT=16 RFC_TYPE=FUGR/RFC_NAME=CVB API and BAPT/ACTVT=16 RFC_TYPE=FUGR/RFC_NAME=CVB API,CVAPI01 and BAPT/ACTVT=16

S_TCODE

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. All rights reserved.

Page 60 of 95

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

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.

Manage RFC Destinations 1. In transaction SPRO open the 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

Field

SAP Gateway

OData Channel

Configuration

and click the Activity icon.

Description

RFC Destination

Enter a name for the RFC destination. Example, BKDCNT200

Connection type

Choose the option, 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. Choose New Entries . 3. 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.

Description

SAP System Alias

Name of the system alias.

Description

Descriptive text for the system alias.

Local SAP GW

Leave unchecked if the SAP ERP system is not on the same system as the SAP Gateway system.

RFC Destination

Specify the RFC destination defined for your SAP system, for example, BKDCNT200 .

WS Provider

Leave it blank.

Software Version

Enter Default .

4. Save your settings.

Assign SAP System Aliases to OData Service 1. 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. All rights reserved.

Former Development

OData Channel

and click the Activity icon.

Page 61 of 95

Customer

/IWCNT/SG_CUSTOMER_0001

Activating the Service 1. Go to transaction SICF. 2. In the Service Name field, enter: SAP ERP Element

Service Name

Employee

Employee

Material

Material

Bill of Material (BOM)

Billofmaterial

ERP Document

Document

Sales Documents

ERPSALES

Customer

CUSTOMER

3. Choose Execute . 4. In the Maintain service window, under Virtual Host/Services section, select the last node and right click. 5. Choose the option Activate Service .

1.4.4.1.3 Settings for Time Management Application - OData Channel Time Management application enables you to perform time recording functions while away from your desk in any device or platform.

Prerequisites Configurations for Time Management Configurations on SAP Gateway - OData Channel Configurations on the SAP ERP System (Provider System) for Time Management - OData Channel Configurations on the SAP Gateway System (Consumer System) for Time Management - OData Channel

Reference For more information, see SAP Library for SAP ERP on SAP Help Portal at http://help.sap.com/erp. In SAP Portal, SAP ERP SAP ERP Central Component (Open the documentation) Resources Choose Personnel Time Management .

Expand SAP ERP Central Component

Expand Human

1.4.4.1.3.1 Configurations on the SAP Gateway for Time Management - OData Channel Manage RFC Destinations 1. In transaction SPRO open the SAP Reference IMG and navigate to: Connection Settings SAP Gateway to SAP System 2. Choose Create and enter the following values: Field

SAP NetWeaver

Manage RFC Destinations

SAP Gateway

OData Channel

Configuration

and click the Activity icon.

Description

RFC Destination

Enter a name for the RFC destination. Example, CONNECT_ TO_BACKEND

Connection type

G (HTTP Connection to Ext. Server)

Description

RFC destination for SAP system

Manage SAP System Aliases 1. 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. 2. Choose New Entries . 3. Enter the following details for the system alias: Field

Configuration

Description

SAP System Alias

Name of the system alias.

Description

Descriptive text for the system alias.

Local SAP GW

Leave unchecked if the SAP ERP system is not on the same system as the SAP Gateway system.

RFC Destination

Specify the RFC destination defined for your SAP system, for example, BKDCNT200.

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

Page 62 of 95

WS Provider

Leave it blank.

Software Version

Enter Default .

4. Save your settings.

Assign SAP System Aliases to OData Service 1. 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. 2. Choose the option with service document identifier /IWCNT/SG_TIME_RECORDING_ODC_0001 and select Copy as...

Activating the Service 1. Go to transaction SICF. 2. In the Service Name field, enter EMPLOYEETIME . 3. Choose Execute . 4. In the Maintain service window, under Virtuelle Hosts/Services section, select the last node and right click. 5. Choose the option Activate Service . Continue with, Configurations on the SAP ERP System (Provider System) for Time Management - OData Channel

1.4.4.1.3.2 Configurations on the SAP ERP System (Provider System) for Time Management - OData Channel Note SAP ERP system is also called as Provider system in this section. To configure the provider system: 1. You can either import a profile using an XML template or create a profile. Importing a profile using an XML template or Creating a profile 2. Import endpoints using a Business Scenario Configuration XML or Creating endpoints using a Business Scenario 3. Verifying the endpoints created 4. Assigning personnel number for an employee: To assign an SAP User ID to a Personnel Number proceed as follows: 1. Logon to the provider system. 2. Open transaction PA30. 3. Choose the Personnel number . 4. In the Direct selection section, choose Communication (0105) in the Infotype field, and System user name (0001) in the STy (Subtype) field. 5. Click the Change icon or press F6 from the key board to view the Change Communication page. 6. In the Communication section, enter the SAP user ID in the ID/number field. You have now assigned the SAP User ID to a Personnel number. 5. Obtaining WSIL URL 1. On the Provider system, open transaction sicf. 2. Enter SERVICE for the Hierarchy Type . 3. Enter WSIL for the Service Name . 4. Choose Execute .

Note The WSIL (Web Service Inspection Language) service lists the configuration of all web services exposed by the system. 5. Choose WSIL folder and right click and select Test Service . 6. A browser window opens, copy the URL from this browser. This is the WSIL URL. 6. Obtaining the external key of the provider system. Continue with, Configurations on the SAP Gateway System (Consumer System) for Time Management - OData Channel

1.4.4.1.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. When you are configuring the Consumer system for the first time (either for Leave Management, Time Management or Codelist) you must perform all the steps provided in the procedure below. But, once you configure the Consumer system for any one of the applications (either Leave Management, Time Management, 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. All rights reserved.

Page 63 of 95

Configuring destination finder Configurations on the consumer system include: 1. Importing a Profile file — Import the Profile created in the Provider system.

Note You must import the same profile created in the provider system, else mass configuration of web service proxies in the service groups is not possible. 2. Creating a system connection to the Provider system 3. User account management 4. Importing a business scenario Configuration XML or Configuring service groups using business scenarios/ — You can either manually configure service groups using a business scenario or import a business scenario configuration XML. 5. Verifying logical ports 6. Assigning system aliases: 1. In transaction SPRO open the SAP Reference IMG and navigate to: SAP NetWeaver SAP Gateway Former Development Generic Channel Administration General Settings Manage GSDO Groups and click the Activity icon. 2. Choose Assign GSDOs , the added GSDO will be present in the list. 3. Select the GSDO Type and click Assign SAP System Alias : User Role: A specific User Role can be maintained which is checked to link to the designated system. SAP System Alias: Add the Provider System's name. 4. Select the System Alias and click Assign User Roles: User Roles can be defined here. Blank: Refers to All Roles . 7. Configuring Destination Finder: The Provider systems configured from SOA Manager have to be entered in the configuration of the Destination Finder so that during runtime, SAP Gateway can select the right provider system for a given system alias. This activity allows you to define RFC destinations that point to relevant SAP business systems. If an RFC destination points to an SAP system alias that system alias points to the corresponding SAP business system.

Note Only RFC destinations of connection type 3 (Connection to ABAP System) can be used. 1. In transaction SPRO open the SAP Reference IMG and navigate to: 2. 3. 4. 5. 6. 7. 8. 9.

SAP NetWeaver

SAP Gateway

Former Development

Channel Configuration Connection Settings SAP Gateway to SAP System Manage RFC Destinations Create a New RFC connection by specifying the RFC Destination and Connection Type . Save the new RFC connection. Go back to the SAP Gateway to SAP System activity. Execute the Manage System Aliases IMG Activity. Create a new System Alias by selecting the New Entries button. Provide the created RFC connection. Enter the Provider system's name for the system alias. Save the settings.

Generic

and click the Activity icon.

1.4.4.1.4 Configurations for ERP Customer- OData Channel The ERP Customer service assists you to view the details of the Customer, like the address of the customer and their communication and bank details.

Prerequisites Before using the Customer service, the following configurations should be completed: Configurations for ERP Customer on the SAP Gateway Sys Configurations for ERP Customer on the SAP ERP System (Provider)

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.

Managing RFC Destinations 1. In transaction SPRO, 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.

Field

Description

RFC Destination

Enter a name for the RFC destination. Example, CONNECT_ TO_BACKEND

Connection type

G (HTTP Connection to Ext. Server)

Description

RFC destination for SAP system

Managing SAP System Aliases

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

Page 64 of 95

1. In transaction SPRO, open the SAP Reference IMG and navigate to: Connection Settings SAP Gateway to SAP System 2. Choose New Entries . 3. Enter the following details for the System Alias:

SAP NetWeaver

Manage SAP System Aliases

Fields

SAP Gateway

OData Channel

Configuration

and click the Activity icon.

Description

SAP System Alias

Name of the system alias.

Description

Descriptive text for the system alias.

Local SAP GW

Leave unchecked if the SAP ERP system is not on the same system as the SAP Gateway system.

RFC Destination

Specify the RFC destination defined for your SAP system, for example, BKDCNT200.

WS Provider

Give the Provider system name that is created in the SAP Gateway SOA Manager configurations. Refer the SOA Manager Configurations documentation at http://help.sap.com . Navigate to: SAP NetWeaver SAP Gateway SAP Gateway 2.0 Library SAP Gateway Configuration Guide Configuration Settings for SAP Gateway Supported Applications SOA Management Configurations on the SAP Gateway System Creating a System Connection to Provider System .

Software Version

Verify the Software Version to set for your Data Model in the following path: In transaction SPRO, open the SAP Reference IMG and navigate to SAP NetWeaver SAP Gateway OData Channel OData Channel Development without IW_BEP Registration Assign Data Provider to Data Model : and click the Activity icon. Select your Data Model and verify the Software Version: DEFAULT is for ERP version between ECC 5.0 to ECC6.0 EhP2 ECC_604 for ERP versions from ECC6.0 EhP3

4. Save your settings.

Assigning SAP System Aliases to OData Service To assign SAP System Aliases to OData Service, proceed as follows: 1. 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. 2. Choose New Entries 3. Select the SAP Gateway OData Group /IWCNT/SG_CUSTOMER_0001 from the Service Doc Identifier list. 4. Enter the role name created above ZBUSIPARTROLE in the User Role column. 5. Press F4 to select a system alias in the SAP System Alias column. 6. Save your settings.

Activating the Service 1. Go to transaction SICF. 2. In the Service Name field, enter CUSTOMER . 3. Choose Execute . 4. In the Maintain service window, under Virtual Hosts/Services section, select the last node and right click it. 5. Choose the option Activate Service . Continue with instructions provided in the Configurations for ERP Customer on the SAP ERP System (Provider) section.

1.4.4.1.4.2 Configurations for ERP Customer on the SAP ERP System (Provider System) — OData Channel To configure the provider system: 1. You can either import a profile using an XML template or create a profile. Importing a profile using a XML template or Creating a profile 2. Import endpoints using a Business Scenario Configuration XML or Creating endpoints using a Business Scenario 3. Verifying the endpoints created 4. Assigning personnel number for an employee: To assign an SAP User ID to a Personnel Number proceed as follows: 1. Logon to the provider system. 2. Open transaction PA30. 3. Choose the Personnel number . 4. In the Direct selection section, choose Communication (0105) in the Infotype field, and System user name (0001) in the STy (Subtype) field. 5. Click the Change icon or press F6 from the key board to view the Change Communication page. 6. In the Communication section, enter the SAP user ID in the ID/number field. You have now assigned the SAP User ID to a Personnel number. 5. Obtaining WSIL URL 1. On the Provider system, open transaction sicf. 2. Enter SERVICE for the Hierarchy Type . 3. Enter WSIL for the Service Name .

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

Page 65 of 95

4. Choose Execute .

Note The WSIL (Web Service Inspection Language) service lists the configuration of all web services exposed by the system. 5. Choose WSIL folder and right click and select Test Service . 6. A browser window opens, copy the URL from this browser. This is the WSIL URL. 6. Obtaining the external key of the provider system. Continue with, Configurations for ERP Customer on the SAP Gateway Sys

1.4.4.1.4.3 Configurations for ERP Customer on the SAP Gateway System (Consumer System)— OData Channel Configurations on the consumer system include: 1. Importing a Profile file — Import the Profile created in the Provider system.

Note You must import the same profile created in the provider system, else mass configuration of web service proxies in the service groups is not possible. 2. Creating a system connection to the Provider system 3. User account management 4. Importing a business scenario Configuration XML or Configuring service groups using business scenarios/ — You can either manually configure service groups using a business scenario or import a business scenario configuration XML. 5. Verifying logical ports 6. Configuring Destination Finder: The Provider systems configured from SOA Manager have to be entered in the configuration of the Destination Finder so that during runtime, SAP Gateway can select the right provider system for a given system alias. This activity allows you to define RFC destinations that point to relevant SAP business systems. If an RFC destination points to an SAP system alias, that system alias will point to the corresponding SAP business system.

Note Only RFC destinations of connection type 3 (Connection to ABAP System) can be used. 1. In transaction SPRO open the SAP Reference IMG and navigate to: 2. 3. 4. 5. 6. 7. 8. 9.

SAP NetWeaver

SAP Gateway

OData Channel

Configuration

Connection Settings SAP Gateway to SAP System Manage RFC Destinations and click the Activity icon. Create a New RFC connection by specifying the RFC Destination and Connection Type . Save the new RFC connection. Go back to the SAP Gateway to SAP System activity. Execute the Manage System Aliases IMG Activity. Create a new System Alias by selecting the New Entries button. Provide the created RFC connection. Enter the Provider system's name for the system alias. Save the settings.

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

Managing RFC Destinations 1. 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. 2. Choose Create and enter the following values:

Configuration

Field

Description

RFC Destination

Enter a name for the RFC destination. Example, CONNECT_ TO_BACKEND

Connection type

G (HTTP Connection to Ext. Server)

Description

RFC destination for SAP system

Managing SAP System Aliases 1. 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. Choose New Entries . 3. Enter the following details for the System Alias: Fields

SAP Gateway OData Channel and click on the Activity icon.

Configuration

Description

SAP System Alias

Name of the system alias.

Description

Descriptive text for the system alias. For example, System alias for ERP Sales

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

Page 66 of 95

Document Local SAP GW

Leave unchecked if the SAP ERP system is not on the same system as the SAP Gateway system.

RFC Destination

Specify the RFC destination defined for your SAP system, for example, BKDCNT200.

WS Provider

Give the Provider system name that is created in the SAP Gateway SOA Manager configurations. Refer the SOA Manager Configurations documentation at http://help.sap.com . Navigate to: SAP NetWeaver SAP Gateway SAP Gateway 2.0 Library SAP Gateway Configuration Guide Configuration Settings for SAP Gateway Supported Applications SOA Management Configurations on the SAP Gateway System Creating a System Connection to Provider System .

Software Version

Verify the Software Version to set for your Data Model in the following path: In transaction SPRO open the SAP Reference IMG and navigate to SAP NetWeaver SAP Gateway OData Channel OData Channel Development without IW_BEP Registration Assign Data Provider to Data Model : and click on the Activity icon. Select your Data Model and verify the Software Version: DEFAULT is for ERP version between ECC 5.0 to ECC6.0 EhP2 ECC_604 for ERP versions from ECC6.0 EhP3

4. Save your settings.

Assigning SAP System Aliases to OData Service To assign SAP System Aliases to OData Service proceed as follows: 1. 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. 2. Choose New Entries 3. 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. 4. Enter the role name created above ZBUSIPARTROLE in the User Role column. 5. Press F4 to select a system alias in the SAP System Alias column. 6. Save you settings.

Activating the Service 1. Go to transaction SICF. 2. In the Service Name field, enter CUSTOMER . 3. Choose Execute . 4. In the Maintain service window, under Virtual Hosts/Services section, select the last node and right click on it. 5. Choose the option Activate Service . Continue with instructions provided in the Configurations for ERP Customer on the SAP ERP System (Providersection.

1.4.4.2 SOA Management Configurations on SAP ERP System Note SAP ERP System is also called as the Provider System in this section. SOA Management configurations mentioned in this sectionhave to performed in the Provider system.

More Information Working with the SOA Manager

1.4.4.2.1 Importing a Profile using a XML Template A template file for a Profile is attached to a SAP Note. This section guides you to import the template file for a Profile. The table below lists the SAP Note details for Time Management, Leave Management and Code List: Application

SAP Note Number

Time Management

1584236

File Details Folder Name — Time.zip File Name — profile_IWCNT_1 .xml

Leave Management

1588250

Folder Name — Leave.zip File Name — profile_IWCNT_1.xml

Code List

1588117

Folder Name — Code_List.zip File Name — profile_IWCNT_CODELIST_1+.xml

ERP Customer

0001670653

Folder Name —Customer.zip File Name —profile_IWCNT_1 .xml

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

Page 67 of 95

ERP Contact

Folder Name —Contact.zip

0001670653

File Name —profile_IWCNT_1 .xml

1. On the Provider system, navigate to the SAP Note Assistant to download the template file using the SAP note number provided above. 2. Download the XML file and save it. 3. Open transaction SOAMANAGER. 4. 5. 6. 7. 8. 9.

Navigate to Technical Administration tab Profile Management . Choose Import . In the SOA Management window, Browse and select the downloaded template file. Choose Import to complete the import process. Browse for the file in the SOA Management window and Import . Activate the Profile.

More Information Configurations on the SAP Gateway system (Provider system) for: OData Channel Scenarios: Time Management ERP Customer Generic Channel Scenarios: Time Management Leave Management Code List Configurations for ERP Customer- OData Channel

1.4.4.2.2 Profile Management Profiles are created as part of the general configuration for security and transport aspects. For web service communications, the provider and the consumer uses the same profile so that the consumer system uses the exact authentication, encryption and other settings that are offered by the provider system. A profile is created once and distributed to all relevant servers in a landscape, and then used to configure each web service on the provider and consumer system.

Creating and Distributing a Profile in SAP NetWeaver 701 (SAP NetWeaver 700 EHP1), SAP NetWeaver 711 (SAP NetWeaver 710 EHP1) and Higher Releases To create and distribute a new profile proceed as follows: 1. On the Provider system, open transaction SOAMANAGER. 2. 3. 4. 5. 6.

Navigate to Technical Configuration tab Profile Management . Choose Create to create a new profile. Enter a Name and Version for the Profile. Specify settings for Messaging , Transport Settings as needed for your company and the landscape. Configure the Security details as follows: Select the SAP Logon Ticket check box Select the Secure Communication Only check box to enable SSL.

Note The selected authentication method must support single sign-on. This may also require trust to be configured between the SAP Gateway and the SAP systems. 7. Click Save to save the profile. The Profile Activate confirmation window displays. 8. Click Yes to activate the profile.

Note After creation of profile you need to logout and logon again into the SOA Management for the new profile to be visible for assignment. 9. 10. 11. 12.

Exit SOA Management and logon again. Select the new profile you have created, and choose Export to export it as an XML file. Specify a location to save the file in the Save As window. Log on to all SAP ERP systems in the landscape, go to transaction soamanager, and import this XML file using the Import function. See Importing a Profile using an XML Template section for more information.

Creating and Distributing a Profile in SAP NetWeaver 700 and 710 To create and distribute a new profile proceed as follows: 1. On the Provider system, open transaction SOAMANAGER. 2. 3. 4. 5.

Navigate to Technical Administration tab Profile Management . Choose New Profile to create a new profile. Enter a Name and Description for the Profile. Ensure that the Transport binding properties has the following values: Property

Value

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

Page 68 of 95

ProxyHost

proxy

ProxyPort

8080

Note If you want to change a profile, you must create a new version of it. By activating a new version, the provider systems and all other pieces of configuration that use the profile still use an old version. You must go to the configuration of each provider system and configure it to use the new version of the profile. You must also activate all dependent objects if required. This has to be done in all systems in the landscape after the distribution of the new profile version

More Information Configurations on the SAP Gateway system (Provider system) for: OData Channel Scenarios: Time Management ERP Customer Generic Channel Scenarios: Time Management Leave Management Code List Configurations for ERP Customer- OData Channel

1.4.4.2.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. On the Provider system, navigate to the SAP Note Assistant to download the template file using the provided SAP Note number. The table below lists the SAP Note details for Time Management, Leave Management, Code List and ERP Customer: Applications

SAP Note Number

Time Management

1584236

Leave Management

1588250

File Name Folder Name — Time.zip File Name — scenario_IWCNT_TIMA_BSC.xml Folder Name — Leave.zip File Name — scenario_IWCNT_LEMA_BSC.xml

Code List

1588117

Folder Name — Code_List.zip File Name — scenario_CodeList.xml

ERP Customer

0001670653

Folder Name — Customer.zip File Name — scenario_IWCNT_KNA1.xml

ERP Contact

0001670653

Folder Name — Contact.zip File Name — scenario_IWCNT_KNA1.xml

2. Download the XML file and save it. 3. Open transaction SOAMANAGER. 4. 5. 6. 7. 8. 9. 10. 11. 12. 13. 14.

Navigate to Service Administration tab Business Scenario Configuration . Choose Import . In the SOA Management window, Browse and select the downloaded template file. Choose Import to complete the import process. The Configuration Scenario Details screen displays at the bottom of the screen. Choose the Provider tab and select all the services. Choose Assign . The list of Profiles in your system is displayed below. Select the profile that you have created already, and click Assign to Service . Choose Save . The Profile Activate confirmation window displays. Click Yes to activate the profile. You are redirected to SOA Configuration Request Queue Management screen. Choose Start request Queue processing to start endpoint creation.

More Information Configurations on the SAP Gateway system (Provider system) for: OData Channel Scenarios: Time Management ERP Customer Generic Channel Scenarios: Time Management Leave Management Code List Configurations for ERP Customer- OData Channel

1.4.4.2.4 Creating Endpoints using a Business Scenario PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.

Page 69 of 95

1.4.4.2.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. These web services are exposed to the Consumer system by Endpoints . To configure a service provider, you need to create and configure an endpoint. The endpoint contains a runtime configuration, which is needed to implement the service. To enable mass configuration on the Consumer system, the endpoints have to be created using a Business Scenario Configuration. To expose the service for consumption by Consumer system proceed as follows: 1. On the Provider system, open transaction SOAMANAGER. 2. 3. 4. 5. 6.

Navigate to Service Administration tab Business Scenario Configuration Choose New . Enter a Name and Description for the Business Scenario. Click Next to configure the Provider side . Click Add to search for each service that is consumed by SAP Gateway. The following services should be added: Time Management

Leave Management

Codelist

.

ERP Customer

ERP Contact

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. 8. 9. 10. 11. 12. 13.

Response_In

The Consumer side has to be configured in the second step. Click Save . Activate the Business Scenario. Click Back . Select Activation Requests Management link Choose Check for Updates button. Click Start Activation to activate endpoints. Choose Check Processing State to trigger and monitor the creation and activation of endpoints. If required, you can log on to other SAP systems and click Export to export the business scenario.

More Information Configurations on the SAP Gateway system (Provider system) for: OData Channel Scenarios: Time Management ERP Customer Generic Channel Scenarios: Time Management Leave Management Code List Configurations for ERP Customer- OData Channel

1.4.4.2.5 Verifying the Endpoints Created To check the endpoints created proceed as follows: 1. On the Provider system, open transaction SOAMANAGER. 2. Navigate to Service Administration tab Single Service Configuration . 3. Search for a service that has been previously added to the Business Scenario. 4. Select the service from the list and click Apply Selection . The Details of the Service Definition displays at the bottom of the screen. 5. Navigate to the Configurations tab. All endpoints and services are listed here. Endpoints are displayed here with a GUID as ID, and the Creation Type field is set to Created based on profile.

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

Page 70 of 95

6. Choose Display to view the configurations. To see the WSDL for the endpoint: 1. Choose Overview . 2. Select a binding. 3. Choose Show WSDL Options for the selected binding.

More Information Configurations on the SAP Gateway system (Provider system) for: OData Channel Scenarios: Time Management ERP Customer Generic Channel Scenarios: Time Management Leave Management Code List Configurations for ERP Customer- OData Channel

1.4.4.2.6 Obtaining the External Key of the Provider System While creating the Provider system in the Consumer system, you have to provide/select the SLD Identifier of the SAP system. 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. On the Provider system, open transaction SOAMANAGER. 2. Navigate to Technical Administration tab Global System Settings . 3. If no external identifier is displayed, enter an organization name and business system, and choose Save . An external identifier is now generated. In previous systems this GUID was not available. If this is the case, you cannot use mass configuration on the consumer side for the services of that system. Proceed as follows: 1. Enter any unique ID. 2. Proceed with the configuration of the business scenario. The activation of the scenario fails. 3. Create the logical ports manually. See section Verifying the logical ports.

More Information Configurations on the SAP Gateway system (Provider system) for: OData Channel Scenarios: Time Management ERP Customer Generic Channel Scenarios: Time Management Leave Management Code List Configurations for ERP Customer- OData Channel

1.4.4.3 SOA Management Configurations on the SAP Gateway System Note SAP Gateway system is also called as consumer system in this section. Applications running on the consumer system use web services to call the provider systems. Therefore, the applications have proxies that are shipped with the provider system. These proxies are grouped into service groups. Each service group can be configured to point to one or many SAP systems. The actual system that will be used is determined at run time through the destination finder. This chapter outlines the following SOA Management configuration steps to be performed in the consumer system.

More Information Working with the SOA Manager

1.4.4.3.1 Importing a Profile File When calling a Provider system, a profile has to be specified. Use the profile created and distributed in the Creating a Profile section. A template file for Profile is attached to an SAP Note. This section guides you to import the template file for Profile. The table below lists the SAP Note details for Time Management, Leave Management and Code List:

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

Page 71 of 95

Application

SAP Note Number

Time Management

1584236

File Details Folder Name — Time.zip File Name — profile_IWCNT_1 .xml

Leave Management

1588250

Code List

1588117

ERP Customer

0001670653

Folder Name —Leave.zip File Name — profile_IWCNT_1.xml Folder Name — Code_List.zip File Name — profile_IWCNT_CODELIST_1+.xml Folder Name —Customer.zip File Name —profile_IWCNT_1 .xml

ERP Contact

Folder Name —Contact.zip

0001670653

File Name —profile_IWCNT_1 .xml

1. On the Consumer system, navigate to the SAP Note Assistant to download the template file using the provided SAP Note number. 2. Download the XML file and save it. 3. Open transaction SOAMANAGER. 4. Navigate to Technical Administration tab 5. Choose Import .

Profile Management

.

Note After importing the profile you need to logout and logon again into the SOA Management for the new profile to be visible for assignment. 6. In the SOA Management window, Browse and select the downloaded template file for assignment.

More Information Configurations on the SAP Gateway system (Consumer system) for: OData Channel Scenarios: Time Management ERP Consumer Generic Channel Scenarios: Time Management Leave Management Code List Configurations for ERP Customer- OData Channel

1.4.4.3.2 Creating a System Connection to Provider System When calling a provider system, a profile has to be specified. Use the profile created and distributed in the Creating a Profile section. If the profile used in SAP Gateway system is not present in an SAP ERP system, mass configuration of the Web service proxies in service group is not possible. In this case, each Web service proxy can be configured one by one. You can create logical ports manually (see section Checking the Logical Ports you have created below). To create a System Connection to the Provider system in the Consumer system proceed as follows: 1. On the Consumer system, open transaction SOAMANAGER. 2. 3. 4. 5. 6. 7. 8. 9.

10.

Navigate to Technical Administration tab System Connections . Choose New to create a new Provider system. Enter a name and description for the Provider system, and choose the right profile name. Choose Next . Select your Provider system listed in the SLD Identifier field. If your Provider system is not in the list, enter a name for your Provider system that uniquely identifies it. Enter the name of the WSIL URL of your SAP ERP system. See section Obtaining WSIL URL of the Provider System in Configurations on the SAP ERP System (Provider System) to obtain WSIL URL of the Provider System Enter all required credentials. Choose Next . Create a business application named Default . An external key is required that identifies the Provider system. To get the external key of the Provider system, perform the steps described in the section Obtaining the external key of the Provider system. In the next steps, choose a configuration that suits your company's requirements and landscape setup.

More Information Configurations on the SAP Gateway system (Consumer system) for: OData Channel Scenarios: Time Management ERP Consumer Generic Channel Scenarios: Time Management Leave Management Code List Configurations for ERP Customer- OData Channel

1.4.4.6.1.1.2.2 User Account Management PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.

Page 72 of 95

User accounts have to be configured with the type of user authentication that takes place when the Consumer system calls the web services on the Provider system. The following three options are offered. Business User: The user logged on to the SAP Gateway also logs on the SAP system using their own user and credentials. Anonymous user: The SAP system is called with an anonymous user. Service User: The SAP system is called with a predefined service user. For setting up the communication from the Consumer systems to the Provider systems, only the Business User option is required.

Configuring User Accounts Proceed as follows to configure User accounts: 1. Log on to the SAP system where the SAP Gateway is installed. 2. Open transaction SOAMANAGER. 3. 4. 5. 6. 7. 8. 9. 10. 11. 12. 13. 14.

Navigate to Service Administration User Account Management To create a new user account, choose New . Enter a name for the user account. In the next step, select Business User . Activate the account. Go to the Account Assignment tab. Click New to create a new interface assignment. In the Business Application field, press F4 and select the Provider system you created in the Creating a System Connection to Provider System. Select Assign to all services within this business application. Choose Next . From the Account drop-down list, select the account you have just created. Click Finish .

More Information Configurations on the SAP Gateway system (Consumer system) for: OData Channel Scenarios: Time Management ERP Consumer Generic Channel Scenarios: Time Management Leave Management Code List Configurations for ERP Customer- OData Channel

1.4.4.3.4 Importing a Business Scenario Configuration XML To Import a Business Scenario Configuration XML proceed as follows: 1. On the Consumer system, navigate to the SAP Note Assistant to download the template file using the provided SAP Note number. The table below lists the SAP Note details for Time Management, Leave Management and Code List: Application

SAP Note Number

Time Management

1584236

File Name Folder Name — Time.zip File Name — scenario_IWCNT_TIMA_BS.xml

Leave Management

1588250

Folder Name — Leave.zip File Name — scenario_IWCNT_LEMA_BS.xml

Code List

1588117

ERP Customer

0001670653

Folder Name — Code_List.zip File Name — scenario_IWCNT_CODELIST.xml Folder Name — Customer.zip File Name — scenario_IWCNT_C_KNA1.xml

ERP Contact

0001670653

Folder Name — Contact.zip File Name — scenario_IWCNT_C_KNA1.xml

2. Download the XML file and save it. 3. Open transaction SOAMANAGER. 4. 5. 6. 7. 8.

Navigate to Service Administration tab Business Scenario Configuration . Choose Import . In the SOA Management window, Browse and select the downloaded template file. Choose Import to complete the import process. Click Save .

Note A dialogue box appears prompting you to activate the business scenario. You are then redirected to SOA Configuration Request Queue Management screen where you need to click Start request Queue processing to start logical port creation.

More Information

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

Page 73 of 95

Configurations on the SAP Gateway system (Consumer system) for: OData Channel Scenarios: Time Management ERP Consumer Generic Channel Scenarios: Time Management Leave Management Code List Configurations for ERP Customer- OData Channel

1.4.4.3.5 Configuring Service Groups using a Business Scenario Service groups allow you to configure multiple consumer proxies at the same time. For example, they allow multiple consumer proxies to be used to access different services offered by the same Provider system. To configure Service Groups using Business Scenario proceed as follows: 1. Logon to the Consumer system. 2. Open transaction SOAMANAGER. 3. 4. 5. 6. 7.

Navigate to Service Administration tab Business Scenario Configuration . Choose New . Enter a Name and Description for the Business Scenario. Choose Next and skip the Provider side configuration. Choose Add to add the service groups for the following applications: /IWCNT/SG_TIME_MGMT service group to the work list for Time Management /IWCNT/SG_LEAVE_MANAGEMENT for Leave Management /IWCNT/CODELIST_SERVICE_GROUP for Code List

8. One service group (that is, one set of Web service consumer proxies) may point to many Provider systems. Perform the following steps for each provider system. 1. Add the service group. 2. Choose Assign Business Application . Select the Business scenario that was created when creating the provider system. 9. Activate the Business Scenario. 10. Choose Check Processing State to monitor pending activities. 11. Choose Start request Queue processing to trigger the creation of Logical Ports for each Web service consumer proxy and provider system

More Information Configurations on the SAP Gateway system (Consumer system) for: OData Channel Scenarios: Time Management ERP Consumer Generic Channel Scenarios: Time Management Leave Management Code List Configurations for ERP Customer- OData Channel

1.4.4.3.6 Verifying Logical Ports A logical port is a reference to runtime configuration on the consumer system to access the provider's endpoint. This section guides you to verify the logical ports created while Configuring Service Groups. 1. Logon to the Consumer system. 2. Open transaction SOAMANAGER. 3. Navigate to Service Administration tab Single Service Configuration . 4. Search for the service group that has been configured previously. 5. To see the details for a service group, click the arrow next to the label to open up the tree. On the first hierarchy level, all configured provider systems are listed. On the second hierarchy level, the proxies are listed 6. Go to the Configurations tab. A logical port that has the Creation Type value set to Created based on profile is listed. 7. Choose Ping web service to check the configuration. 8. To see the details of a proxy, select it and click Apply Selection . If no logical port is listed, or it is not possible to create logical ports via the business scenario, you can manually create a logical port. Choose Create Logical Port . Chose a Name and Description . Enter the URL to a WSDL or select a file. To obtain the URL of a WSDL, see section Verifying the Endpoints Created.

More Information Configurations on the SAP Gateway system (Consumer system) for: OData Channel Scenarios: Time Management ERP Consumer

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

Page 74 of 95

Generic Channel Scenarios: Time Management Leave Management Code List Configurations for ERP Customer- OData Channel

1.4.4.4 Generic Channel Configuration Recommendation We strongly recommend using the OData Channel (ODC) programming paradigm for all SAP Gateway development. As of SAP Gateway 2.0 Support Package 05, you are strongly recommended to use the Service Builder (transaction SEGW) for your OData design-time development . For more information, see SAP Gateway Service Builder. Depending on whether you want to develop SAP Gateway content in an SAP Business Suite backend system or in an SAP Gateway hub system, you can choose between embedded deployment or central hub deployment. For more information, see Embedded Versus Hub Deployment and Deployment Options. 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. In the SAP Reference IMG navigate to SAP NetWeaver SAP Gateway Former Development Generic Channel .

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. In the SAP Reference IMG navigate to SAP NetWeaver

SAP Gateway Service Enablement

Generic Channel

.

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. All rights reserved.

Page 75 of 95

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.4.4.4.1 Defining Settings for Idempotent Services Idempotency guarantees delivery of synchronous messages exactly once. You configure idempotent services by scheduling a background job that ensures that request messages in SAP Gateway only occur once. To define settings for idempotent services, proceed as follows: 1. In transaction SPRO open the SAP Reference IMG and navigate to:

SAP NetWeaver

Configuration Connection Settings SAP Gateway to Consumer 2. Enter the following default values: For Period Hours in Document the value is 6 .

Define Settings for Idempotent Services

SAP Gateway

Former Development

Generic Channel

and click on the Activity icon.

For Period Hours in Document ID the value is 12 . 3. Choose Schedule . A message displays confirming that the job has been scheduled. 4. Choose Continue .

To check that you have successfully defined the idempotent services settings, carry out the following steps: 1. In transaction SM37 enter SAP_BC_IDP_WS_SWITCH* as the Job name and * as the User name . 2. Choose Execute . A list with all scheduled jobs SAP_BC_IDP_WS_SWITCH_BD and SAP_BC_IDP_WS_SWITCH_BDID is displayed.

1.4.4.4.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. Proceed as follows: 1. In transaction SPRO open the SAP Reference IMG and navigate to:

SAP NetWeaver

Configuration Connection Settings SAP Gateway to Consumer 2. On the Configuration of RFC Connections page choose Create . 3. In the RFC Destination field, enter IWFND_WSIL_LOCAL_DEST .

Create RFC Destination for WSIL Service.

SAP Gateway

Former Development

Generic Channel

and click on the Activity icon.

4. In the Connection Type field, enter H . 5. In the Description 1 field, enter RFC Destination for WSIL Service . 6. 7. 8. 9.

Choose Enter . On tab Technical Settings enter the SAP Gateway host in the Target Host field. In the Service No. field, enter the HTTP port. In the Path Prefix field, enter the path of the local WSIL service, for example, /sap/bc/srt/wsil .

Note The WSIL service lists the configuration of all Web Services exposed by the system. The /SAP/BC/SRT/WSIL service must have been activated in transaction SICF. To obtain the WSIL URL, carry out the following steps: 1. Log on to the SAP system you specified as a provider, and enter transaction SICF. 2. Enter WSIL for the Service Name and choose Execute . The WSIL service is now displayed in the HTTP service tree. 3. Double-click on the WSIL entry to obtain its URL. The path for the WSIL service is displayed: /default_host/sap/bc/srt/ The default value for the URL is: http:///sap/bc/srt/wsil 10. Save your settings.

To check that you have successfully created an RFC destination for the WSIL, select Connection Test . The test result displayed on the Test Result tab should contain Status HTTP Response 200.

1.4.4.4.3 Assigning the System Alias Pointing to the SAP System

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

Page 76 of 95

You have to specify which content is being enabled by assigning a SAP system alias. You can also activate framework services such as metadata. 1. In transaction SPRO open the SAP Reference IMG and navigate to: 2. 3. 4. 5. 6. 7. 8.

SAP NetWeaver

SAP Gateway

Former Development

Generic Channel

Administration General Settings Manage GSDO Groups and click on the Activity icon. From the Manage SAP Gateway GSDO Groups table, select the entry for your scenario. In the Dialog Structure section, double-click Assign SAP System Aliases . Choose New Entries . In the SAP System Alias column, use the value help to select the system alias that points to the SAP system on which the service is to be executed. In the User Role column, enter a role that contains users who need to use the content scenario in the system of the SAP system alias. Leave this column empty if all user roles need access. Save your settings. 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.

If you want to consume metadata information, proceed as follows: 1. Create an RFC destination and an Alias for LOCAL which points to the SAP Gateway system itself. 2. Use built-in SAP Gateway services: the GSDO group is called IWF_FW_SERVICES and it already contains the required GSDO. Therefore, you only need to maintain the SAP system alias. In this case assign LOCAL. As a result you can fetch a list of all Service Documents, for example, http://:/sap/opu/odata/IWFND/MetaDataProcessing/ServicedocumentCollection/?$format=xml

1.4.4.4.4 Checking SAP System Aliases The Check SAP System Aliases activity verifies the various connections you have configured, 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.

RFC test

Checks if the assigned RFC destinations are functional.

To check the configuration for aliases for a SAP system, proceed as follows: In transaction SPRO open the SAP Reference IMG and navigate to: Configuration

Connection Settings

SAP NetWeaver

SAP Gateway to SAP System

SAP Gateway

Check SAP System Aliases

Former Development

Generic Channel

and click on the Activity icon.

A status report of the listed checked items displays.

More Information Creating the System Alias for Applications

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

.

1.4.4.5 Code List Overview Code List feature enables the content developers to easily create value helps for various fields. Code Values can come from different backend systems or from a single backend system. 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. 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.

Why do you need this Function In real time business scenarios, it is possible for field, to have a different set of valid values based on the context. For example, while creating a document in CRM, the list of possible values for DocumentType is different from the list of valid DocumentTypes while creating a document in ERP. In addition to this, it is also possible for the source of the possible DocumentTypes to be different in each of these scenarios. For example, the list of valid document types for an ERP document may come from an ESA service, while the list of valid DocumentTypes for a CRM document may come from a domain, i.e. the source of valid values is different depending on the software version. Code List has been developed to cater to these scenarios.

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

Page 77 of 95

What does this function do? For a user to enter a partner role and wants to fetch the list of valid partner roles, the content developer needs to do the following: . Create a User-Centric SAP Gateway Data Model for Partner Roles. See Creating a SAP Gateway Data Model based on the Code List PS model for more information. Create the associated SAP Gateway Consumption Model and then fetch the list of Partner Roles using this Service. See Creating a SAP Gateway Consumption Model based on the SAP Gateway Data Model for more information. The content developer needs to create an Entity Provider class to specify the technical details of the source of the value helps. 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. 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.4.4.5.1 Code List Usage Using the Code List feature, the content developers can easily create value helps for various fields. For example, to fetch the list of valid partner roles for a consumer when they want to enter a partner role. For this, the content developer needs to first identify the source of the list of valid partner roles, and then by using the Code List feature fetch them for the consumer. 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. 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. 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, 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 Entity Provider Class can be named as: IWCNT/CL_CLST_EPRRQ_PROLES The mv_domain_name variable of this class can be set to: /SAPTRX/EV_PARROL And the mv_value_help_source_category variable can be set to: 02 This indicates that the domain with fixed values will be used to fetch the code list in the: SET_VALUE_HELP_SOURCE method of the class This domain name would be used in order to fetch the value help for Partner Roles.

Example Value Help Source is Domain In order to fetch the list of valid values for Partner Roles, the following values need to be set in the SET_VALUE_HELP_SOURCE method of the class. MV_VALUE_HELP_SOURCE_CATEGORY = '02' MV_DOMAIN_NAME = ‘/SAPTRX/EV_PARROL’

Example

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

Page 78 of 95

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, the following values need to be set in the SET_VALUE_HELP_SOURCE method of the 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- ESA service MV_VALUE_HELP_SOURCE_CATEGORY = '03' MV_ESA_NAME = 'CountryCode' MV_ESA_TYPE = 'CountryCode' MV_ESA_NAMESPACE = 'http://sap.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. Once registered, the Code List fetched by the backend connectivity API will be available in IT_PROCESSED_BE_DATA parameter of the mapping specialist classes.

Example 1. Registering Backend Connectivity API for fetching Code List for Gender from a Domain with fixed values Implement the following code in the Entity Provider Class:

Syntax 01. DATA: ls_mapping_specialist_attr TYPE LINE OF gtyt_map_specialist_attributes. DATA: lo_clst_bec_dom TYPE REF TO /iwcnt/cl_clst_bec_dom. ls_mapping_specialist_attr-execution_mode = /iwcnt/if_common_c=>gc_execution_mode_q. ls_mapping_specialist_attr-bop_type = /iwfnd/if_mgw_bec_bop=>gc_bop_type_custom. CREATE OBJECT lo_clst_bec_dom EXPORTING iv_code_name = 'Gender' iv_domain_name = 'AD_SEX'. ls_mapping_specialist_attr-be_api_ref ?= lo_clst_bec_dom. APPEND ls_mapping_specialist_attr TO et_mapping_specialist_attr. Once the backend API has been registered, the Code List can be accessed via the IT_PROCESSED_BE_DATA parameter in the respective mapping specialists.

Syntax 01. DATA: ls_processed_be_data LIKE LINE OF it_processed_be_data, lt_gender_codes TYPE /iwcnt/t_clst_attr. FIELD-SYMBOLS: Type any. READ TABLE it_processed_be_data INTO ls_processed_be_data WITH KEY name = 'Gender'. IF sy-subrc = 0. ASSIGN ls_processed_be_data-value->* TO . lt_gender_codes[] = ENDIF. The internal tablelt_gender_codes [][] will now contain the gender codes fetched from the fixed values associated with the domain AD_SEX. 2. Registering Backend Connectivity API for fetching Code List from a BAPI Parameter. Implement the following code to register the Backend Connectivity API for fetching Code List from a BAPI parameter in the REGISTER_MAPPING_SPECIALISTS method of the entity provider class.

Syntax 01. DATA: ls_mapping_specialist_attr TYPE LINE OF gtyt_map_specialist_attributes. DATA: lo_clst_bec_bapi TYPE REF TO /iwcnt/cl_clst_bec_bapi. ls_mapping_specialist_attr-execution_mode = /iwcnt/if_common_c=>gc_execution_mode_q ls_mapping_specialist_attr-bop_type = /iwfnd/if_mgw_bec_bop=>gc_bop_type_custom.

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

Page 79 of 95

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. APPEND ls_mapping_specialist_attr TO et_mapping_specialist_attr. Once the backend API are registered, Code List can be accessed via the IT_PROCESSED_BE_DATA parameter in the respective mapping specialists.

Syntax 01. DATA: ls_processed_be_data LIKE LINE OF it_processed_be_data, lt_gender_codes TYPE /iwcnt/t_clst_attr. FIELD-SYMBOLS: Type any. READ TABLE it_processed_be_data INTO ls_processed_be_data WITH KEY name = 'TitleCode'. IF sy-subrc = 0. ASSIGN ls_processed_be_data-value->* TO . lt_title_codes[] = ENDIF. The internal table lt_title_codes[] will now contain the Title codes fetched from the value help associated with the BAPI parameter.

Creating Code List Model The Code List PS model is a very simple model that has two properties namely Code and Text. The property Code is marked as the key of the model and is also the only filterable property of the model. 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, 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.

Registration The Entity Provider Class /IWCNT/CL_CLST_EPRRQ_PROLES and the SAP Gateway Consumption model /IWCNT/PARTNER_ROLES_0001_UC is then registered in the transaction: SPRO SAP Customizing Implementation Guide Assign Data Provider to the Data Model .

SAP NetWeaver

SAP Gateway

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. See Customizing the SAP Gateway System for more information.

Creating SAP Gateway Data Model based on the Code List PS Model To create a Data Model based on the Code List PS Model proceed as follows: 1. 2. 3. 4.

Logon to the SAP Gateway system. Open Object Navigator (transaction se80). Choose SAP GW Data Model from the drop-down list. Enter a name for the SAP GW Data Model. The SAP GW Data Model name should follow the convention “__UC” The version must be 4 characters long with leading zeros.

Example /IWCNT/PARTNER_ROLES_0001_UC 5. Click Display and choose Yes in the Create Data Model window. 6. Choose Existing Data Model in the Create From pane. 7. Enter the following information for the model: Name as/IWCNT/MGW_CODE LIST Type as PS Version as 0001 8. Set labels, external names, descriptions for the fields in the SAP Gateway Data Model.

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

Page 80 of 95

Adding the Code List SAP Gateway Data Model to an existing SAP Gateway Consumption Model To create SAP Gateway Consumption Model based on the SAP Gateway Data Model: 1. 2. 3. 4. 5. 6.

Logon to the SAP Gateway system. Open Object Navigator (transaction se80). Choose SAP GW Consumption Model from the drop down list. Enter the name of an existing SAP Gateway Consumption Model. Right click the SAP Gateway Consumption Model and choose Add SAP GW Data Model. Specify the SAP Gateway Data Model created in the Creating SAP Gateway Data Model based on the Code List PS model. 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.

1.4.4.5.2 Customizing the SAP Gateway System for Code List In order to maintain the configuration entries for Code List the Entity Provider class, the SAP Gateway Data Model and the SAP Gateway Consumption model should be created. Refer to Usage of Code List for more details.

Note All the screenshots shown below are samples only. The actual customizing entries will depend on the SAP Gateway Data Model, the SAP Gateway Consumption Model and the GSDO group that will be created by the content developer for a Code List implementation. The screenshots below are based on the examples mentioned in the Usage of Code List section. To configure the SAP Gateway systems for Code List: 1. In the SPRO transaction SAP Customizing Implementation Guide SAP NetWeaver Development without IW_BEP Registration Assign Data Provider to the Data Model

SAP Gateway .

Former Development

OData Channel

Example For Partner Roles Code List, the Model Identifier should be set to/IWCNT/PARTNER_ROLES_0001_UC and the Class/Interface should be set to /IWCNT/CL_CLST_EPRRQ_PROLES.

Assigning Data Provider to Data Model

2. In the SPRO transaction SAP Customizing Implementation Guide SAP NetWeaver SAP Gateway Development without IW_BEP Registration Assign SAP System Aliases to OData Service .

Former Development

OData Channel

Assigning SAP System Aliases to OData Service

Note The above image is just a sample. Configure the existing SAP Gateway Consumption model (as explained under Adding the Code List SAP Gateway Data Model to an existing SAP Gateway Consumption Modelin the Code List Usagechapter.

1.4.4.5.3 Code List Cache Cleanup Functional Overview

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

Page 81 of 95

The cache cleanup functionality cleans the code list cache tables for the OData channel which are maintained in the SAP Gateway system. This functionality can be used by the administrator to clear the cache data either periodically or whenever required by refreshing the cache data. The cached data can be deleted based on the created by user(s) and time restrictions. To delete the code list cache for the OData Channel proceed as follows: 1. In the SPRO transaction, expand SAP Customizing Implementation Guide SAP NetWeaver Cache Settings Cleanup Cache and Persistency 2. Specify User(s) if you want to delete the entries cached by a specific user or users. 3. Specify the cleanup scenario as /IWCNT/CL_CODELIST_CLEANUP_MGW. 4. Specify the time restriction if needed. 5. Execute.

SAP Gateway

OData Channel

Administration

Note Uncheck the Execute in Test Mode checkbox in order to delete the cached value helps from the Codelist Cache tables.

1.4.4.6 Configuration Settings for Generic Channel Scenarios Recommendation We strongly recommend using the OData Channel (ODC) programming paradigm for all SAP Gateway development. Depending on your use case, either use embedded deployment or central hub deployment. For more information, see Deployment Options. If you want to use OData Channel, either use backend OData Channel or hub OData Channel with software component IW_BEP. 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.4.4.6.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.

Creating Roles You must create roles for SAP CRM and assign these roles to the CRM GSDO group. The CRM SAP Gateway users should be assigned to these roles so that they can use SAP Gateway services. For this: 1. Identify the list of SAP CRM systems on which the functionality should be accessible by SAP Gateway. 2. Create system alias for each of these systems. 3. For each of these systems, define a role for which the administrator should assign the list of users (who has access to execute the functionality)

Note 1. You must be an SAP Gateway administrator or have an SAP user administrator to create the roles. 2. The roles must be defined/created on the SAP Gateway server. 3. If there is only one SAP CRM system and all the users on SAP Gateway should be able to access CRM functionality on this SAP CRM system, then role creation and assigning of roles to GSDO groups is optional but this is not recommended. To create roles, proceed as follows: 1. Open transaction pfcg in the SAP Gateway system. 2. 3. 4. 5. 6. 7. 8.

Enter a name for the role in the Role field. Choose Single Role . Save the Role . Choose the Authorization tab. Choose Change Authorization . Choose the template mentioned in the Role Templates section. Choose Generate to create a new role.

For information on changing roles, see Changing Standard Roles. 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. All rights reserved.

Page 82 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. All rights reserved.

Page 83 of 95

You need to perform the following customizing settings in the SAP Gateway system: Creating SAP system aliases Assigning roles to a GSDO group Assigning SAP system aliases to a GSDO group

Note The configurations mentioned below must be carried out for CRM activity, accounts and contacts.

Creating System Alias for Applications Proceed as follows: 1. In transaction SPRO open the SAP Reference IMG and navigate to:

SAP NetWeaver

Configuration Connection Settings SAP Gateway to SAP System 2. Choose New Entries . 3. Enter the following details for the system alias: Field

SAP Gateway

Former Development

Manage SAP System Aliases

Generic Channel

and click the Activity icon.

Description

SAP System Alias

Name of the system alias.

Description

Descriptive text for the system alias.

Local SAP GW

Leave unchecked if the CRM system is not on the same system as the SAP Gateway system. Check it if the CRM system is on the same system as the SAP Gateway system.

RFC Destination

Specify the RFC destination defined for your SAP system, for example, BKDCNT200 .

WS Provider System

If you are using SAP CRM 7.0, leave the field blank. If you are using SAP CRM 6.0, you can: 1. Leave the field blank if you are using BAPI based connection (We recommend you to use BAPI based connection). 2. Choose a provider system if you are using ESA services. For information on configuring a provider system, see Configuring a GSDO to Connect to the SAP CRM system.

Software Version

Enter CRM_6.0 or CRM_7.0 according to the CRM version you are using.

4. Save your settings. Assigning Roles to a GSDO Group Proceed as follows: 1. In transaction SPRO open the SAP Reference IMG and navigate to:

SAP NetWeaver

SAP Gateway

Former Development

Generic Channel

Administration General Settings Manage GSDO Groups and click the Activity icon. 2. Select the GSDO Group ( IWACT for CRM Activity and IWBPC for CRM Accounts and Contacts), from the Manage GSDO Groups list. 3. Choose Assign User Roles on the dialog structure. 4. Choose New Entries . 5. Enter the role name in the Assign User Roles column. For example, ZRole . 6. Save your settings. Assigning SAP System Aliases to a GSDO Group Proceed as follows: 1. In transaction SPRO open the SAP Reference IMG and navigate to:

SAP NetWeaver

SAP Gateway

Former Development

Generic Channel

Administration General Settings Manage GSDO Groups and click the Activity icon. 2. Select the GSDO Group ( IWACT for CRM Activity and IWBPC for CRM Accounts and Contacts), from the Manage GSDO Groups list. 3. Choose Assign SAP System Aliases on the dialog structure. 4. Choose New Entries . 5. Enter the role name created above ZRole in the User Role column. 6. Press F4 to select a system alias in the SAP System Alias column. 7. Save your settings.

1.4.4.6.1.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.0 system. Applications running on the GSDO use web services to call the SAP systems. Therefore, the applications have proxies that are shipped with the GSDO. These proxies are grouped in service groups. Each service group can be configured to point to one or many SAP systems. The actual system that is used is determined at runtime via the destination finder. Applications bundle proxies to service groups in a granularity that matches the way the web services are offered by the SAP systems. For example, if an SAP system offers the web service Get Employee, it also offers the web service Create Employee , as they belong to the same deployment unit. 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. 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. 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. All rights reserved.

Page 84 of 95

SOA Management configurations on the SAP Gateway system

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

Note SAP CRM system is also referred to as provider system here. SOA Management configurations on the provider system include: Creating a New Profile in the Provider System — A profile that contains general configuration on security and transport systems for the entire landscape. Configuring Provider Systems — Provider systems, to indicate which SAP systems are called. This can be compared with RFC destinations.

1.4.4.6.1.1.1.1 Creating a New Profile in the Provider System A profile is general configuration of security and transport aspects. For web service communications, the provider and the consumer have to use the same profile so that the calling system uses the exact authentication, encryption, and other settings that are offered by the provider system. A profile is created once, distributed to all relevant servers in a landscape, and then used for the configuration of each web service on the provider and consumer side.

Note If you are using SAP Basis release 700, it is not possible to use Mass Configuration for the services of that system. In such case, you need to manually create logical ports.

Creating and Distributing a New Profile 1. In the SAP CRM system go to transaction SOAMANAGER, choose

Technical Configuration

Profile Management

.

2. Choose Create . 3. Enter a profile name in the Profile Name field under the Profile Properties section. 4. Check for the settings for reliable messaging, transport binding and authentication that fulfill the needs of your company and landscape. The selected authentication method must support single sign-on. This may also require trust to be configured between the GSDO and the SAP systems. 5. Save and activate the profile. 6. Select the new profile you have created, and choose Export to export it to a file.

Note If you do not have the option to export the files, you need to create logical ports manually on the consumer system. 7. Log on to all relevant systems in the landscape, go to transaction SOAMANAGER, and import the profile.

Note If you want to change a profile, you must create a new version of it. By activating a new version, the provider system and all other pieces of configuration that use the profile still use an old version. You must go to the configuration of each provider system and configure it to use the new version of the profile. You must also reactivate all dependent objects as required. This has to be done in all systems in the landscape after the distribution of the new profile version.

1.4.4.6.1.1.1.2 Configuring Provider Systems A provider system is the SAP CRM system being used. Web services called by the GSDO have to be exposed using the profile created. Web services are exposed via endpoints. To enable mass configuration on the consumer side, the endpoints have to be created using a Business Scenario .

Creating Endpoints using a Business Scenario For creating endpoints using a business scenario, proceed as follows: 1. In the SAP CRM system go to transaction SOAMANAGER, choose

Business Administration

Mass Configuration

.

2. Choose Create , enter configuration scenario name and description. 3. Choose the Provide tab and choose Add 4. Enter CRM_BPBASICDATABYNAMEADDRQR in the Search Pattern field, choose Both Names from the Field and click Go . 5. Choose the service from the list and click Add to Worklist .

Note If you have the option to import the Mass Configuration/Business Scenario XML file, see SAP Note 1585723 files.

for the procedure to import the XML

6. Choose the provider added and click Assign . 7. Choose a profile from the Profiles sections and click Assign to Service . 8. Save and activate the configuration scenario.

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

Page 85 of 95

9. Click Back and go to Activation Request Management. 10. Choose Check for Updates . 11. Choose Start Activation for creating end points.

Checking the Endpoints Created For checking the endpoints created, proceed as follows: 1. In the SAP CRM system go to transaction SOAMANAGER, choose

Business Administration

Web Service Administration

.

2. Search for the service that has been previously added to the business scenario. 3. Select the service from the list and choose Apply Selection. 4. Choose the Configurations tab. All endpoints and services are listed here. Endpoints are displayed here with a GUID as ID, and the Creation Type field is set to Created based on the profile. 5. Choose Display to see its configuration.

WSDL for the Endpoints To see the WSDL for the endpoint, proceed as follows: 1. Choose Overview tab. 2. Select a binding from the drop-down box. 3. Choose Open WSDL document for selected binding .

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

Note SAP Gateway system is also referred to as consumer system here. SOA Management configurations on the consumer system include: Creating a Provider System in the Consumer System — The service groups, to determine which SAP systems may be called per service group from the GSDO (acting as the consumer). User Account Management — User Account Management, for authentication settings when calling an SAP system.

1.4.4.6.1.1.2.1 Creating a Provider System in the Consumer System When calling a provider system, a profile has to be specified. Use the profile created and distributed in the Creating a New Profile in the Provider System section. If the profile used in the GSDO is not present in a provider system, mass configuration of the web service proxies in service groups is not possible. In this case, each web service proxy can be configured one by one. You can create logical ports manually, see Creating a Fallback Configuration.

Creating a Provider System 1. In the SAP Gateway system go to transaction SOAMANAGER choose

Technical Administration

System Connections

.

2. Choose New . Enter a name and description for the provider system.

Note The name of the Provider system and the name of the WS Provider System (mentioned in section Creating System Alias for Applications) should be same. 3. 4. 5. 6.

Choose the profile you created as mentioned in the section Creating a New Profile in the Provider System. Choose Next . If your SAP system is listed in the SLD Identifier field, select it, else enter a name for your SAP system that uniquely identifies it. Enter the URL for WSIL (Web Service Inspection Language) of your SAP system. The default value for the URL is http:///sap/bc/srt/wsil? sap-client= . You can also obtain a URL, follow the procedure below. For obtaining a URL to configure WSIL, proceed as follows: 1. Log on to the provider SAP system you created. 2. Go to transaction SICF. 3. Enter SERVICE for the Type Hierarchy . 4. Enter WSIL for Service Name . 5. Choose Execute .

Note 1. The WSIL service lists the configuration of all web services exposed by the system. 2. Logical ports can be created using SOAMANAGER automatic configuration, which either uses Service registry (If configured) or WSIL to retrieve WSDL and corresponding endpoints. If you do not have Service registry in your landscape you must provide WSIL details while configuring the provider system in consumer system SOAMANAGER (in System Connection).

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

Page 86 of 95

7. 8. 9. 10.

Enter the user, password for WSIL and choose Next . Choose New , in the Systems Connections Wizard . Enter a name in the Application Name field and provide a description. An external key is required that identifies the provider system. Perform the steps given below to get an external key. To obtain the external key of a provider system, proceed as follows: 1. In the provider system go to transaction SOAMANAGER choose Technical Administration Global System Settings

.

2. If no external identifier is displayed, enter an organization name and business system. 3. Save your settings. An external identifier is now generated.

Note For releases lower than SAP Basis 701 this GUID is not available. If this is the case, you cannot use mass configuration on the consumer side for the services of that system. Proceed as follows: 1. Enter any unique ID in the External Key field. 2. Proceed with the configuration of the business scenario. The activation of the scenario fails. 3. Create the logical ports manually (see section Check the logical ports you have created below). 11. Choose a configuration that suits your requirements and landscape setup like, authentication method and secure communication.

1.4.4.6.1.1.2.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. 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. Anonymous user: SAP system is called with an anonymous user. Service User: SAP system is called with a predefined service user. For setting up the communication from the SAP Gateway to the provider systems, only the Business User option is required.

Configuring User Accounts To configure user accounts, proceed as follows: 1. In the SAP Gateway system go to transaction SOAMANAGER, choose

Service Administration

User Account Management

.

2. Choose New , enter a name and description for the user account. 3. Choose Next, select Business User for Account Type . 4. 5. 6. 7. 8. 9. 10. 11.

Choose Finish and activate the account. Choose Account Assignment tab. Choose New to create a new interface assignment. Choose the business application that was created when creating the Provider Systems. Choose the check box Assign to all services within this business application . Choose Next . Choose the account you created. Choose Finish .

Configuring the Consumption Model using the Business Scenario 1. In the SAP Gateway system go to transaction SOAMANAGER choose 2. 3. 4. 5. 6.

Service Administration

Business Scenario Configuration

.

Choose New to create a new configuration scenario. Enter a name and description for the business scenario. Choose Next . This skips the step to configure the provider side. Choose Add to add a service group to the work list. Enter /IWCNT/SG_BUSINESS_PARTNER in the Search Pattern field, choose Both Names from the Field and click Go .

7. Choose the service group from the list and click Add To Worklist . 8. One service group (one set of web service consumer proxies) may point to many provider systems. Perform the following steps for each provider system. 1. Select the service group. 2. Choose Assign Business Application . 3. Choose the business application that was created when creating the Provider Systems, click Assign To Service Group . 9. Choose Finish and activate the configuration scenario. 10. Choose Check for Updates to monitor or trigger the creation of logical ports for each web service consumer proxy and provider system.

Note For the procedure on creating logical ports manually, see Creating a Fallback Configuration.

Checking the Logical Ports Created 1. In the SAP Gateway system go to transaction SOAMANAGER choose

Service Administration Single Service Configuration . 2. Choose ServiceGroup in the Search by field, enter /IWCNT/SG_BUSINESS_PARTNER in the Search Pattern field, choose Both Names from the Field and click Go . 3. Search for the service group that has been configured previously. 4. To see the details for a service group, click the arrow next to the label to open up the tree. On the first hierarchy level, all configured provider systems are listed. On the second hierarchy level, the proxies are listed. 5. To see the details of a proxy, select it and click Apply Selection . 6. Go to the Configurations tab. A logical port is listed that has the Creation Type value set to Created based on profile 7. Choose Ping web service to check the configuration.

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

Page 87 of 95

If no logical port is listed, or it is not possible to create logical ports via the business scenario, you can manually create a logical port as mentioned below: Choose Create Logical Port . Choose a name and description. Enter the URL to a WSDL or select a file. To obtain the URL of a WSDL, see Checking the created endpoints section in Creating a New Profile in the Provider System.

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, the GSDO can select the right provider system for a given system alias. 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, which should be the same as Provider System created in the consumer system.

1.4.4.6.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.4.4.6.2.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.

Creating Roles You must create roles for Reporting Management and assign these roles to the Reporting Management GSDO group. The Reporting Management users should be assigned to these roles so that they can receive report templates and can execute the reports. For this: 1. Identify the list of SAP ERP and BI systems (for Reporting Management) on which the functionality should be accessible by SAP Gateway. 2. Creating system alias for each of these systems. 3. For each of these systems, define a role for which the administrator should assign the list of users (who has access to execute the functionality).

Note 1. You must be an SAP Gateway administrator or have an SAP user administrator to create the roles. 2. The roles must be defined/created on the SAP Gateway server. 3. If there is only one SAP ERP or BI system and all the users on SAP Gateway should be able to access Reporting Management functionality on this system then role creation and assigning of roles to GSDO groups is optional but this is not recommended. To create roles, proceed as follows: 1. Open transaction pfcg in the SAP Gateway system. 2. 3. 4. 5. 6. 7. 8.

Enter a name for the role in the Role field. Choose Single Role . Save the Role . Choose the Authorization tab. Choose Change Authorization . Choose the template mentioned in the Role Templates section. Choose Generate to create a new role.

For information on changing roles, see Changing Standard Roles. Role Templates Use the predefined role templates mentioned below to create user roles for SAP Gateway Reporting Management. /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, FUNC

ACTVT

16

S_TCODE

TCD-SICF

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

Page 88 of 95

While creating role template in the SAP ERP/BW system, include the authorizations provided in the table below. The user must have these authorizations in the SAP Reporting Management systems (ERP/BW) to access SAP Gateway services for Reporting Management: Reporting Management System SAP ERP system

SAP BI system

Authorization Object

Field

S_RFC

S_RFC

Field Value

RFC_TYPE

FUGR

RFC_NAME

/OSP/R3_REPORT

ACTVT

16

RFC_TYPE

FUGR

RFC_NAME

/OSP/BW_REPORT

ACTVT

16

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. In transaction SPRO open the SAP Reference IMG and navigate to:

SAP NetWeaver

Configuration Connection Settings SAP Gateway to SAP System 2. Choose New Entries . 3. Enter the following details for the system alias: Field

SAP Gateway

Manage SAP System Aliases

Former Development

Generic Channel

and click the Activity icon.

Description

SAP System Alias

Name of the system alias.

Description

Descriptive text for the system alias. For example, .

Local SAP GW

Leave unchecked if the Reporting Management system is not on the same system as the SAP Gateway system. Leave it checked it if the Reporting Management system is on the same system as the SAP Gateway system.

RFC Destination

Specify the RFC destination defined for your SAP system, for example, BKDCNT200 .

WS Provider System

Leave it blank.

Software Version

ERP , BW or DEFAULT depending on the Reporting system you are using.

4. Save your settings. Assigning Roles to a GSDO Group Proceed as follows: 1. In transaction SPRO open the SAP Reference IMG and navigate to:

SAP NetWeaver

SAP Gateway

Former Development

Generic Channel

Former Development

Generic Channel

Administration General Settings Manage GSDO Groups and click the Activity icon. 2. Select the GSDO Group ( IWREPT , IW_SD_REPT or IWRPMD ), from the Manage GSDO Groups list. 3. Choose Assign User Roles on the dialog structure. 4. Choose New Entries . 5. Enter the role name in the Assign User Roles column. For example, ZMANAGER . 6. Save your settings. Assigning SAP System Aliases to a GSDO Group Proceed as follows: 1. In transaction SPRO open the SAP Reference IMG and navigate to:

SAP NetWeaver

SAP Gateway

Administration General Settings Manage GSDO Groups and click the Activity icon. 2. Select the GSDO Group ( IWREPT , IW_SD_REPT or IWRPMD ), from the Manage GSDO Groups list. 3. Choose Assign SAP System Aliases on the dialog structure. 4. Choose New Entries . 5. Enter the role name created above ZMANAGER in the User Role column. 6. Press F4 to select a system alias in the SAP System Alias column. 7. Save your settings.

1.4.4.6.2.2 Configuring Subscriptions for Report Results Subscription is required to get the report results upon execution of a Report. You need to configure subscription settings for GSDO. Proceed as follows: 1. In transaction SPRO open the SAP Reference IMG and navigate to:

SAP NetWeaver

Configuration Subscription Settings Maintain Subscription Settings for GSDO 2. Choose New Entries . 3. Enter the following details in the Maintain Subscription Settings for GSDO screen: Field

SAP Gateway

Former Development

Generic Channel

and click the Activity icon.

Description

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

Page 89 of 95

GSDO Type

IWCNT~OM_REPORT_RESULT_SET

SAP System Alias

Name of the SAP Gateway system alias.

Event Group ID

REPORT_RESULT_NOTIF

Description

Event for Report Result Set

XNotification Type

IWCNT~OM_REPORT_PUSH_NOTIF

No Backend

Check this option.

4. Save your settings.

1.4.4.6.2.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, 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.4.4.6.2.3.1 Managing Source Systems, Report Types and Formats Manage Source Systems, Report Types and Formats activity allows you to maintain report source systems, types, and delivery formats. The source systems, report types and formats you maintain here are displayed in the customizing activity Manage Reports and their Properties.

Maintaining Report Delivery Formats To maintain report delivery formats, proceed as follows: 1. In transaction SPRO open the SAP Reference IMG and navigate to:

SAP NetWeaver

Peripheral Settings Manage Source Systems, Report Types and Formats 2. Choose New Entries to define a new format. Field

SAP Gateway

Content

Reporting Administration

and click the Activity icon.

Description

Report Delivery Format

Enter the format in which the report should be delivered.

File Type Delivery Format Description

Enter a description for the delivery format.

3. Save your settings.

Maintaining Source Systems, Report Types and Report Formats To maintain source systems, report types and report formats, proceed as follows: 1. In transaction SPRO open the SAP Reference IMG and navigate to: 2. 3. 4. 5. 6. 7.

SAP NetWeaver

SAP Gateway

Content

Reporting Administration

Peripheral Settings Manage Source Systems, Report Types and Formats and click the Activity icon. Select a report delivery format from the Delivery Formats section and double-click Manage Source Systems . The page displays the source systems for reports that have been defined. Select a report source type and double-click Manage Report Types . The page displays the report types that have been configured for the source system. Choose New Entries to define a new report type. Enter a name and description for the report type. Save your settings. In the Manage Report Types view, select a row and double-click Manage Formats . The page lists all report formats that have been defined for the report type. Choose New Entries to specify a new format. Field

Description

Report Delivery Format

Select a delivery format here. The formats you have configured in the Delivery Formats view is displayed here.

Delivery Format Description

Enter a description for the delivery format.

Default

Select this checkbox to specify the format as the default format for the report type.

8. Save your settings.

1.4.4.6.2.3.2 Managing Reports and their Properties You can manage a report assigned to the SAP Gateway. You can also configure a new report, edit its properties. Requirements Other important configurations like system alias, source system, categories, and context variables must be defined. The reports configured here must already

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

Page 90 of 95

exist in the RFC destination. 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.4.4.6.2.3.2.1 Configuring a New Report To configure a new report, 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 Reports and their Properties and click the Activity icon. All reports that have been configured are listed. 2. Choose New Entries to create a new report. 3. In the Report Source and Type section, enter the following values: Field SAP System Alias

Description Select the source system from which the report is derived.

Note Choose the source system based on the type of report (ERP or BW). Report Type

Choose the report type.

Work Area, User Group, Query Name

Press F4 in one of these fields and select a value. The other two fields are automatically populated with their corresponding values.

Note This is specific to SAP ERP query.

4. In the Report Properties section, specify the following values: Field

Description

Technical Name

Enter the technical name of the report.

ALV Layout Variant

Select a layout for the report.

Report Title

Enter a title for the report.

Report Description

Enter a description for the report.

Category

Select the category of the report.

Active

Select the checkbox to make the report available to the users. This checkbox is available only if at least one role is maintained for the report.

Forward Report Template

Not applicable.

5. In the Allow Users to Run the Report section, specify the following values: Field

Description

Immediately

If this checkbox is selected, the user can run the report any time. It is executed immediately and is delivered to the user’s client when ready.

Based on user-defined scheduling

If this checkbox is selected, the user is allowed to schedule when the report should be run. If this checkbox is not selected, then If there are report settings created with free scheduling for the master template, those along with the corresponding jobs on the backend gets deleted.

Based on time points

If this checkbox is selected, the user is allowed to run the report based on time points. (Time points are specified in the Report Scheduling view.) If this checkbox is selected, the Based on user-defined scheduling checkbox is also selected.

Note This checkbox is enabled only if at least one time point is maintained. Based on data change events

If this checkbox is selected, the user is allowed to run the report based on data change events. (Data change events refer to events that can trigger a report run when certain conditions are met and data in the SAP system are changed. Data change events are configured in the Report Scheduling view.)

Note This option is available only for BW reports. This checkbox is enabled only if at least one data change event is configured. If this checkbox is selected, the Based on user-defined scheduling checkbox is also selected.

6. In the Display Documentation to End users section, select one of the following options: Field

Description

Existing documentation

Select this option to display the existing report documentation to users.

Custom documentation

Select this option if you would like to create a new documentation for the report.

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

Page 91 of 95

None

Select this option to not display any report documentation to users.

7. Save your settings. After you have configured the report, click the Check icon (or press CTRL F7 ) to check if all configurations for the report are correct. This runs the report /IWCNT/R_REPORT_CONFIG_CHECKS . If you run this report from the main Manage Reports and their Properties view where all the reports are listed, the checks are carried out for all displayed reports.

1.4.4.6.2.3.2.2 Configuring Report Parameters To configure report parameters, 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 Reports and their Properties and click the Activity icon. All reports that have been configured are listed. 2. Choose a report from the Manage Reports and their Properties view list. Double-click Report Parameters and Values in the dialog structure on the left. The parameters of the report are listed. 3. Enter the following values for the editable fields: Field

Description

Order

For each parameter, enter a number to represent the order in which it should be displayed to the user.

Mandatory

Select the checkbox if it is mandatory for the users to enter a value for the parameter.

Display

Specify whether the parameter should be displayed to users or not, and whether it should be editable if displayed.

Parameter Name

Change the name of the parameter.

Radio Buttons Group Name

If you want to group certain parameters together and display them as a series of radio buttons, enter group names for each set of radio buttons. For example, you could enter the group name Date for parameters Today , Tomorrow and Specify Date ; and the group name Country for parameters One country and Several countries .

F4 Availability

If this option is enabled, it indicates that the F4 option is available. You cannot edit this option.

Context Group

Specify the context group for the parameter.

Context Variable

Enter the context variable for the parameter.

Sign

Select Inclusive here to query reports that are within the values specified in the parameter. For example, if the parameter dates specify August 01 to August 30, the report considers these dates when run.

Default Condition

Select the default condition to be displayed for the parameter. This option only specifies the default display. The user can still select other conditions for the value.

Default Low/From Value

Enter the default starting value to be displayed for parameters that require a range of values.

Default High/To Value

Enter the default ending value to be displayed for parameters that require.

Note In case a particular parameter has multiple parameter values then the value, which has the lowest parameter order is displayed and this cannot be modified. 4. Save your settings.

1.4.4.6.2.3.2.3 Configuring Multiple Values for a Parameter To configure multiple values for a parameter, proceed as follows: 1. In transaction SPRO open the SAP Reference IMG and navigate to: 2. 3. 4. 5. 6.

SAP NetWeaver

SAP Gateway

Content

Reporting Administration

Report Settings Manage Reports and their Properties and click the Activity icon. All reports that have been configured are listed. Choose a report from the Manage Reports and their Properties view list. Double-click Report Parameters and Values in the dialog structure on the left. The parameters of the report are listed. Choose a parameter for which multiple values can be configured, in the Report Parameters and Values view. Double-click Define Multiple Values in the dialog structure on the left. The page lists all values that have been configured for the parameter. Choose New Entries to define a new value. Enter the default conditions for the new parameter value. Save your settings.

1.4.4.6.2.3.2.4 Configuring Delivery Formats for a Report To configure delivery formats for reports, proceed as follows: 1. 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. All reports that have been configured are listed.

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

Page 92 of 95

Report Settings Manage Reports and their Properties and click the Activity icon. All reports that have been configured are listed. 2. Choose a report from the Manage Reports and their Properties view list. Double-click Report Formats in the dialog structure on the left. The parameters of the report are listed. 3. In the Manage Reports and their Properties view, select a report and double-click Report Formats for Report Type in the dialog structure on the left. The page lists all delivery formats that have been specified for the report. 4. Configure the following values for a format: Field

Description

Format

Select the report format.

Display

Select whether the format should be allowed or not allowed. You can also specify whether the format should be the default format if allowed.

5. Save your settings.

1.4.4.6.2.3.2.5 Specifying Roles for a Report To specify roles for a report, 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 Reports and their Properties and click the Activity icon. All reports that have been configured are listed. 2. Choose a report from the Manage Reports and their Properties view list. Double-click Report Roles in the dialog structure on the left. The page lists all roles that can access the report. 3. Choose New Entries . 4. In the Role field, press F4 and choose a role. 5. Save your settings.

1.4.4.6.2.3.2.6 Report Scheduling To define scheduling for a report, 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 Reports and their Properties and click the Activity icon. All reports that have been configured are listed. 2. Choose a report from the Manage Reports and their Properties view list. Double-click Report Scheduling in the dialog structure on the left. The page lists all scheduling options that have been defined for the report. 3. Configure the following values for a scheduling option: Field

Description

Type

Choose if the report should be run based on a time point or a data change event.

Event Name

Enter the name of the time point or data change event.

Event Description

Enter a description for the time point or data change event.

Display

Choose whether running a report based on this schedule should be allowed or not allowed. You can also specify whether the schedule should be the default schedule if allowed.

4. Save your settings.

1.4.4.6.2.3.3 Managing Categories Each report configured can have a category assigned to it. You can add, modify and delete report categories. Only categories that are defined here are displayed in the activity Manage Reports and their Properties. Deletion of a category is not allowed unless all the report templates under the category are moved to a different category or deleted. To create a new category, proceed as follows: 1. 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. 2. Choose New Entries to define a new category. Enter a name and description for the category. 3. Save your settings.

1.4.4.6.2.3.4 Managing Context Variables You can define context variables for various tasks. Context variables make entering parameter values easy for users. For example, you can create context variables for dates such as today , tomorrow and this year . Users can select such relative values when running a report, instead of having to select exact dates from a displayed calendar. Context variables can be assigned to a context group and a data type can be specified for each group. Standard Settings Five context variables are predelivered in the system. You can modify these and also create new ones.

Maintaining Context Groups Proceed as follows:

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

Page 93 of 95

1. In transaction SPRO open the SAP Reference IMG and navigate to:

SAP NetWeaver

SAP Gateway

Content

Reporting Administration

Report Settings Manage Context Variables and click the Activity icon. 2. Choose New Entries to define a new context group Field

Description

Context Group

Enter a name for the context group.

Context Group Description

Enter the name of the time point or data change event.

Value Type

Select the data type for the context group.

3. Save your settings.

Maintaining Context Variables 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 Context Variables and click the Activity icon. 2. In the Manage Context Groups view, select a context group and double-click Manage Context Variables on the dialog structure in the left menu. The page lists all context variables that have been defined for the group. 3. Choose New Entries to create a new variable. Field

Description

Context Variable

Specify the technical name for the context variable to map it to an RFC destination.

Context Variable Description

Enter a description for the context variable.

Control Type

Select Parameter if the variable refers to specific values (for example, a date). Select Select-Options if the variable refers to relative values (for example, a date range).

4. Save your settings.

Maintaining Context Variables Mappings 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 Context Variables and click the Activity icon. 2. In the Manage Context Variables view, select a context variable and double-click Enable Context Variables on the dialog structure in the left menu. The page lists the SAP System Alias that the context variable has been mapped to. 3. Choose New Entries to define a new system. Field

Description

SAP System Alias

Select the SAP System Alias of the system to locate the class.

Class

Select the class name.

4. Save your settings.

1.4.4.6.2.3.5 Configuring System Time Points You must configure a system time point for a report. Before you define the system time points for a report, you must define a schedule for them. You define scheduling for the system time points by creating a background job for it. Create a background job and define a schedule for it. Define and subscribe the system time points for a report. To define the schedule using background jobs, proceed as follows: 1. Go to transaction SM36. 2. Enter a name for the new background job in the Job Name field. For example, TP_BROADCASTING_ERPReport001.

Note Do not change the default values for Job class, Status, and Exec. Target. 3. 4. 5. 6. 7. 8. 9.

Choose Start condition . The Start Time dialog box displays. Choose Date/Time , and enter the values. Check Periodic Job . Choose Periodic Values . Choose the schedule you want, and save your settings. Choose Step from Define Background Job screen. The Create Step 1 dialog box displays. In Program name under ABAP program, enter the following names to create two steps for the job with the following: RSRD_BROADCAST_FOR_TIMEPOINT /OSP/IW_TIMEPOINT_PROCESS

10. Choose Save , and from Job in the Define Background Job menu bar, choose Save .

1.4.4.6.2.3.6 Managing System Time points and Data Change Events PUBLIC © 2014 SAP SE or an SAP affiliate company. All rights reserved.

Page 94 of 95

Note You must manage events data change only for Business Intelligence (BI) reports. Time points refer to frequencies (for example, every hour, every 2 days, every Saturday) that are defined and used by various jobs and schedulers. You can create time points there, so that they can be used by reports and run at such frequencies. An event signals that a particular situation has occurred in the system and specific background processing that is waiting for this event must be activated accordingly. Events data changes are associated with a process chain, which is a sequence of processes waiting in the background for an event. You configure events data change by creating a variant of process chain, defining a schedule, and activating it.

Creating Variant for a Process Chain and Define Schedule To create a variant for a process chain, and define the schedule, proceed as follows: 1. Go to transaction RSPC. 2. Choose Create to create a new process chain. 3. Enter a name for the process chain and choose Continue . The Insert a Start Process dialog is displayed. Create a process variant as the start process of the chain. 4. Choose Create and enter a name and description for the variant. 5. Choose Change Selections . 6. Choose Date/Time to schedule date and time. 7. Choose Periodic Job . 8. Choose Period Values. Select the schedule you want to use (hourly, daily, weekly, monthly, other periods). 9. Save your settings. 10. Click the Process Types icon to load all available process types. 11. Under Load Process and Post Processing , select Trigger Event Data change (for broadcaster) to insert the variant of the process chain. 12. Click the Create icon to create a new event and give it a name and a description. The Info cube (Info provider) for which you created the event data change is displayed. 13. Press F4 to select the Info cube (Info provider). 14. Save your settings. This inserts the newly created event data change in the process chain. 15. Choose Start Process and move the pointer over the event data change. 16. Click the Activate icon, and then the Activate and Schedule icon. Select the relevant application server to activate and schedule. You can test whether the event data change is functional. Testing involves modifying data from an Info cube.

Defining Time Points and Data Change Events To check whether the event data change is functional, proceed as follows: 1. Go to transaction RSRD_START. 2. Select the name of the Info cube for which you have defined the event data change. 3. Click the Execute icon with ‘P_ONLINE’ checked. To define time points and data change events, 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. 2. Click Refresh to retrieve the latest list of system time points and data change events. The Status column shows the status of items that have been updated or deleted. 3. Check the Active checkbox for time points and data change events that should be used to configure reports. These time points and events are now available in the activity Manage Reports and their Properties .

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

Page 95 of 95