SAP Gateway

What's New in SAP Gateway 2.0 SPS 12

What's New in the Framework()

SAP Gateway Master Guide

General Overview

SAP Gateway and OData

Development Overview

SAP Gateway Service Builder

Deployment Options

Embedded Versus Hub Deployment

Glossary

SAP Gateway Installation Guide

Installation Prerequisites

Installing SAP Gateway Components

Unicode and Non-Unicode Support

SAP Gateway Configuration Guide

General Configuration Settings

Profile Parameters

ICF Services

Changing Password for Initial Logon

Language Settings

SAP Gateway Configuration

User, Developer, and Administrator Roles

Creating and Assigning Roles

Connection Settings for SAP Gateway Hub System

Connection Settings: SAP Gateway to Consumers

Creating an RFC Destination for Outbound Queues

Registering an RFC Destination for Outbound Queues

Creating a bgRFC Supervisor Destination

Connection Settings: SAP Gateway to SAP Systems

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

Activating SAP Gateway

Service Development in the Backend System

Maintaining Models and Services

Displaying Models and Services

Defining Parallelization of Batch Queries

Service Development in the SAP Gateway Hub System

Assigning SAP System Alias to OData Service

Multiple Origin Composition

Dynamic System Alias Calculation Via /IWFND/ES_MGW_DEST_FINDER

Connection Settings to SAP Gateway

Defining Settings for Idempotent Services

Defining a Remote Function Call to SAP Gateway

Connection Settings to SAP Gateway

Configure the bgRFC Supervisor Destination

Monitoring bgRFC Queues

Configuration Settings for SAP Gateway Supported Scenarios

Configuration Settings for OData Channel Scenarios

Configuring Workflow for SAP Gateway

Creating an Administrator Role for Workflow

Customizing SAP Gateway Workflow

Configuring Workflow Notifications

Creating a Type G RFC Destination

Configuring User Authorizations for Push Notifications

Running Scheduled Reports

Workflow Settings

Configuring Business Process Content Services

Configuring Services for Deployment Scenario 1

Connecting Business Process Content and Business Suite Systems

Creating a Software Version for Provider System

Mapping the Software Version and Technical Model

Creating a System Alias

Activating the Process Service

Registering Process Context Service for Deployment Scenario 1

Activating the Process Context Service

Configuring Services for Deployment Scenario 2

Connecting Business Process Content and Business Suite Systems

Creating a Software Version for Provider System

Mapping the Software Version and Technical Model

Creating a System Alias for SAP Business Suite System

Connecting SAP Gateway and Business Process Content

Creating a System Alias for Business Process Content System

Activating the Process Service

Registering Process Context Service for Deployment Scenario 2

Activating the Process Context Service

User Authorizations for SAP Business Workflow Systems

Configuring the Task Gateway Service

Creating a System Alias

Activating Task Gateway Service

Assigning a Software Version to Service

Adding Additional System Aliases

Adding New Providers

Configuring Task Gateway Service Settings

Former Development

Configurations for ERP on SAP Gateway

Role Templates for ERP Scenarios

Configurations on SAP Gateway for SAP ERP

Settings for Time Management Application - OData Channel

Configurations on the SAP Gateway for Time Management - OData Channel

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

Configurations on the SAP Gateway System (Consumer System) for Leave Management

Configurations for ERP Customer- OData Channel

Configurations for ERP Customer on the SAP Gateway System— OData Channel

Configurations for ERP Customer on the SAP ERP System (Provider System) — OData Channel

Configurations for ERP Customer on the SAP Gateway System (Consumer System)— OData Channel

Configurations for ERP Sales Documents on the SAP Gateway System— OData Channel

SOA Management Configurations on SAP ERP System

Importing a Profile using a XML Template

Profile Management

Importing Endpoints Template using Business Scenario Configuration

Creating Endpoints using a Business Scenario

Verifying the Endpoints Created

Obtaining the External Key of the Provider System

SOA Management Configurations on the SAP Gateway System

Importing a Profile File

Creating a System Connection to Provider System

User Account Management

Importing a Business Scenario Configuration XML

Configuring Service Groups using a Business Scenario

Verifying Logical Ports

Generic Channel Configuration

Defining Settings for Idempotent Services

Creating an RFC Destination for the WSIL Service

Assigning the System Alias Pointing to the SAP System

Checking SAP System Aliases

Subscription Settings

Code List

Code List Usage

Customizing the SAP Gateway System for Code List

Code List Cache Cleanup

Configuration Settings for Generic Channel Scenarios

Settings for Customer Relationship Management on SAP Gateway

Configuring GSDO to Connect to the SAP CRM System

SOA Management Configurations on SAP CRM System

Creating a New Profile in the Provider System

Configuring Provider Systems

SOA Management Configurations on SAP Gateway System

Creating a Provider System in the Consumer System

User Account Management

Settings for Reporting Management

Settings for Reporting Management on SAP Gateway

Configuring Subscriptions for Report Results

Settings for Reporting Administration

Managing Source Systems, Report Types and Formats

Managing Reports and their Properties

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

Managing Categories

Managing Context Variables

Configuring System Time Points

Managing System Time points and Data Change Events

Settings for Human Capital Management for SAP Gateway

Settings for Time Management

Settings for Time Management on SAP Gateway

Configurations on the SAP ERP System (Provider System) for Time Management

Configurations on the SAP Gateway System (Consumer System) for Time Management

Settings for Leave Management

Configuring SAP Gateway System for Leave Management

Configurations on the SAP ERP System (Provider System) for Leave Management

Configurations on the SAP Gateway System (Consumer System) for Leave Management

Settings for User Profile

Settings for Code List in the SAP Gateway System

Creating a GSDO Type

Creating a GSDO Group

Assigning System Alias

Maintaining Code Type

Code List Usage

Code List Cache Cleanup

Configuring SAP Gateway System and SAP ERP System-ESA Service

Configurations on the SAP ERP System (Provider System) for Code List

Configurations on the SAP Gateway System (Consumer System) for Code List

SAP Gateway Technical Operations Guide

Alert Monitoring with CCMS

Trace and Log Files

Service Context Facade

Supportability

Error Log

Configuration Settings for the Error Log

SAP Performance Statistics

Tracing Tools: Configuration

Application Log Viewer

What Information Should Be Included in a Customer Service Ticket

How to Set Up Remote Support

Which Tools Can Be Used for Troubleshooting?

How to Handle Bad Request Errors

How to Enable Compression

URL Generation

Last Modified and Cache Control

Implementation

Framework $expand

Implementation Example

Error Messages and Issues

SAP Gateway Security Guide

Technical System Landscape

Security Aspect of Data, Data Flow, and Processes

User Administration and Authentication

SAP Gateway Authentication and Single Sign-On

Using SAP NetWeaver Portal as an Authentication Provider

Security Assertion Markup Language

Configuring SAML for Use in SAP Gateway

SAP Gateway Host as the SAML2 Service Provider

X.509 Client Certificate Authentication Method

Security Setup for Communication with the Connectivity Provider System

User Management

Authorizations in the SAP System

Roles in the SAP Gateway Landscape

Assigning Authorization to Transaction and Search Help

Exporting and Importing Roles, Users, and Authorizations

Session Security Protection

Cross-Site Request Forgery Protection

Encoded Functionality

Handling Confidential Data in OData URLs

Network and Communication Security

Secure Data Storage

Checking and Validating Application Requests

Checks and Validations of Entries Received through Components

Cross-Site Scripting (XSS) Protection

Used Communication Channels

Encrypted Communication Channels

Configuring Secure Communication in Your Landscape via SSL

Enabling Secure Network Communications Connections to SAP System

Configuring Trust in the SAP Gateway System Landscape

Configuring Trust between SAP Gateway and SAP Systems

Configuring the SAP System as the Trusting System

Configuring the SAP Gateway Host as the Trusted System

Security for Additional Applications

Security Aspects of User Self Service

Security Aspects for Backend Event Publisher

Security Aspects for Workflow

Security Aspects for Task Gateway, My Inbox, and Unified Inbox

Security Configuration for the ERP Document Scenario

Web Application Scenario

Desktop Application Scenario

Mobile Device Scenario

Cloud Application Integration Scenario

Social Network Application Scenario

Server Side Application Scenario

Data Protection and Privacy

SAP Annotation Security Level for Handling Batch Requests

Application Log Settings

Avoid Caching of Confidential Data

Virus Scan

SAP Gateway Developer Guide

OData Channel

OData in SAP Gateway - Feature Overview

OData Query Options

General Considerations

OData Best Practices

Performance Best Practices

Creating High-Quality OData Services

Deployment Considerations for Development

Development in SAP Gateway Hub System

Developing Content on Hub with IW_BEP Installation

Generating the BOPs

Deleting an RFC or a Web Service BOP

Implementing Metadata Provider Class

Implementing Entity Data Provider Class

Implementing Data Providers

Implementing Mapping Specialists

Implementing /IWBEP/IF_MGW_EDP_MAP_READ

Implementing /IWBEP/IF_MGW_EDP_MAP_QUERY

Implementing /IWBEP/IF_MGW_EDP_MAP_ACTION

Implementing /IWBEP/IF_MGW_EDP_MAP_CREATE

Implementing /IWBEP/IF_MGW_EDP_MAP_UPDATE

Implementing /IWBEP/IF_MGW_EDP_MAP_DELETE

Implementing /IWBEP/IF_MGW_EDP_MAP_GSTREAM

Error Handling in Mapping Specialists

Development in SAP Business Suite Backend System

Activate and Maintain Services

Maintaining Models and Services

Maintain Annotation Models

Metadata Cache

Soft State Based Query Result Cache

Advanced Features

Service Tagging

ETag Handling

ETag Handling in Batch Processing

$batch Processing

Patch Support

Delta Query Support

Conversion Handling in OData Channel

Expand in Framework and Data Provider

Deep Insert

Error Response Control for Backend Data Provider

$filter System Query Option APIs

Metadata Filtering Value List

Map Message Container to Message Protocol Format

Annotations

Vocabulary-Based Annotations

Extended Support of Long Texts in the Metadata

Soft State Support for OData Services

Simple Field Extensibility

Conversion Support for Complex Filters

User Self Service

Configuration Settings for User Self Service

Configurations on SAP Business Suite System

Configurations on SAP Gateway Hub

User Self Service IMG Activities

Creating a User Account

Resetting the Password

User Self Service Enhancement Options

Integration Scenarios

Integration of SAP Gateway and SPI

Generating SAP Gateway for SPI

Mapping Between SPI and OData Model

Integration of SAP Gateway and GenIL

Generating an SAP Gateway Service for GenIL

Enhancing the Classes

Mapping Between GenIL and OData Model

Integration of SAP Gateway and SAP Business Warehouse

Generating an SAP Gateway Analytics Service Using MDX and Easy Query

SAP Gateway With SAP HANA

Creating and Adding a HANA DB Based SAP Gateway Service

SAP Gateway with SAP HANA APIs

/IWHDB/CL_HAI_RT_ABS_MODEL

/IWHDB/CL_HAI_RT_DATA

OData Services Consumption and Integration

Creating an RFC Destination

Generating an SAP Gateway Service for OData

Enabling Media Links

Model Composition for Integration Scenarios

Subscription and Notification Flow

Subscription and Notification Flow for Push Oriented Scenarios

Creating a New OData Channel Application for Sending Notifications

Configurations on the SAP Backend System for Push Oriented Scenarios

Configurations on the SAP Gateway System for Push Oriented Scenarios

Notification Content Publisher

Notification Content Formatter

Subscription and Notification Flow for Pull Oriented Scenarios

Creating a New OData Channel Application for Pulling Notifications

Configurations on the SAP Backend System for Pull Oriented Scenarios

Configurations on the SAP Gateway System for Pull Oriented Scenarios

Pulling the Notifications Stored: Enhancements

Enabling Push/Pull for an Existing OData Channel Application

Maintaining Outbound bgRFC Queue from SAP Backend System to the Hub System

Maintaining Inbound bgRFC Queue on the Hub System

Subscription Management

An Example to Create Subscription on Behalf of Users

Fetching the List of Users for Roles

MOC for Subscription Management

Namespace Handling in Model Provider Class

Integration With Unit Test Framework

APIs and Coding

Logging in SAP Gateway

Initiating the Logger

Completing a Logging Step

Logging an Exception

Logging BAPI Returns

Logging Simple Messages

Logging Simple Messages Through a Structure

Logger Handling for Outbound Flows

Non-User and Request-Specific Logging CCMS

Message Container

OData Channel APIs

OData Channel Runtime APIs

/IWBEP/CL_COS_LOGGER

/IWBEP/CL_MGW_ABS_DATA

/IWBEP/IF_MESSAGE_CONTAINER

/IWBEP/IF_MGW_APPL_SRV_RUNTIME

/IWBEP/IF_MGW_CONV_SRV_RUNTIME

/IWBEP/IF_MGW_ENTRY_PROVIDER

/IWBEP/IF_MGW_ODATA_EXPAND

/IWBEP/CX_MGW_BUSI_EXCEPTION

/IWBEP/IF_MGW_REQ_FUNC_IMPORT

/IWBEP/IF_MGW_REQ_FILTER

/IWBEP/IF_MGW_REQ_ENTITY_C

/IWBEP/IF_MGW_REQ_ENTITY_U

/IWBEP/IF_MGW_REQ_ENTITY_D

/IWBEP/IF_MGW_REQ_ENTITY_P

/IWBEP/IF_MGW_REQ_ENTITY

/IWBEP/IF_MGW_REQ_ENTITYSET

/IWBEP/IF_MGW_EXPR_VISITOR

OData Channel Metadata APIs

/IWBEP/CL_MGW_ABS_MODEL

/IWBEP/IF_MGW_MED_ODATA_TYPES

/IWBEP/IF_MGW_ODATA_ACTION

/IWBEP/IF_MGW_ODATA_ANNOTATABL

/IWBEP/IF_MGW_ODATA_ANNOTATION

/IWBEP/IF_MGW_ODATA_ASSOC

/IWBEP/IF_MGW_ODATA_ASSOC_SET

/IWBEP/IF_MGW_ODATA_CMPLX_PROP

/IWBEP/IF_MGW_ODATA_CMPLX_TYPE

/IWBEP/IF_MGW_ODATA_DOCUMENTTN

/IWBEP/IF_MGW_ODATA_ENTITY_SET

/IWBEP/IF_MGW_ODATA_ENTITY_TYP

ABAP Dictionary Type to EDM.Type Mapping

ABAP Dictionary Type to EDM.Type Mapping SP10

/IWBEP/IF_MGW_ODATA_ITEM

/IWBEP/IF_MGW_ODATA_MODEL

/IWBEP/IF_MGW_ODATA_NAV_PROP

/IWBEP/IF_MGW_ODATA_PARAMETER

/IWBEP/IF_MGW_ODATA_PROPERTY

/IWBEP/IF_MGW_ODATA_REF_CONSTR

OData Vocabulary Annotations APIs

/IWBEP/IF_MGW_VOCAN_ANNOTATION

/IWBEP/IF_MGW_VOCAN_ANN_TARGET

/IWBEP/IF_MGW_VOCAN_COLLECTION

/IWBEP/IF_MGW_VOCAN_FUNCTION

/IWBEP/IF_MGW_VOCAN_FUN_PARAM

/IWBEP/IF_MGW_VOCAN_LABEL_ELEM

/IWBEP/IF_MGW_VOCAN_PROPERTY

/IWBEP/IF_MGW_VOCAN_RECORD

/IWBEP/IF_MGW_VOCAN_SIMPLE_VAL

/IWBEP/IF_MGW_VOCAN_TERM

/IWBEP/IF_MGW_VOCAN_URL

OData Channel Push APIs

/IWBEP/CL_MGW_NOTIF_PUBLISHER

/IWBEP/CL_MGW_PUSH_ABS_DATA

/IWBEP/CL_MGW_PUSH_ABS_MODEL

/IWBEP/CL_MGW_SUB_REGISTRY

/IWBEP/CL_MGW_SUB_UTIL

/IWBEP/IF_MGW_NOTIF_PUBLISHER

/IWBEP/IF_MGW_NOTIF_TEXT_PROV

/IWBEP/IF_MGW_SUB_REGISTRY

/IWFND/CL_MGW_ACTIVATION_API

Debugging Query Option

Code Patterns for the OData Channel

Metadata Definition Code Patterns

Defining Entity Type

Defining Complex Type

Defining Association

Defining Composition

Data Provision Code Patterns

SAP Gateway Service Builder

Development Approaches

User Interface

Working with the Mass Maintenance View

Creating a Service Builder Project

Copying a Service Builder Project

Generating Runtime Artifacts for Copied Projects

Data Modeling Basics

Copying Data Model Artifacts

Defining a Data Model

Entity Types

Defining Properties

Mappings and the ABAP Type Editor

EDM Type Vs ABAP Type Validation

Associations

Referential Constraints

Navigation Properties

Function Import Parameters

Working with Annotations

Uploading Vocabularies into the Vocabulary Repository

Referencing a Service to Annotate a Model

Importing a Vocabulary File

Adding Vocabulary-Based Annotations to Data Model Artifacts

Schema Namespace

Data Modeling Options

Importing Data Model from File

Importing a DDIC Structure

Importing a Data Source (RFC/BOR Interface)

Importing Search Help as a Data Source

Including an OData Service

Redefining Services

Extending an OData Service Using Service Builder

Redefining OData Service (SAP GW)

Redefining a Service - Empty project

Redefining Service - Project with Model

Extending Existing Model

Overwriting a Model

Importing Properties

Redefining Services from External Framework (SPI, BW Query, GenIL)

Service Implementation

Redefining Methods of the Operations

Mapping to a Data Source

Setting Constant Values

Mapping the Query Operation

Ranges Table and Structures

Mapping the Read Operation

Mapping the Create Operation

Mapping Delete or Update Operations

Implementation Support for Association

Runtime Artifacts

Generating Runtime Objects

Creating the ABAP Classes

BOP Interface Naming Rules

Generated ABAP Classes and Service Registration

Generated Classes for Model Provider Class

Base Class: Model Provider Class

Implementation Class: Model Provider Class

Generated Classes for the Data Provider Classes

Base Class: Data Provider Class

Implementation Class: Data Provider Class

Generating Classes for Annotation Provider Class

Base Class: Annotation Provider Class

Implementation Class: Annotation Provider Class

Service Maintenance and Registration

SAP Gateway Cookbooks

OData Channel Cookbooks

Getting Started with the Service Builder

Creating a Project

Copying a Service Builder Project

Importing Data Model

Importing a Data Source (RFC/BOR Interface)

Including an OData Service (SAP Gateway).

Redefining Services

Redefining OData Services (SAP GW)

Redefining Services from External Framework (SPI, BW Query, GenIL)

Editing Properties

Checking Project Consistency

Creating Associations

Mapping Operations

Map the Query Operation

Map the Read Operation

Generating the Service

Redefining the MPC Implementation Class

Redefining the DPC Implementation Class

Redefining APC Implementation Classes

Service Maintenance

Creating OData Channel Content

1 SAP Business Suite Backend System

1.1 Create the Metadata Provider Class (MPC)

1.2 Create the Data Provider Class (DPC) for the Runtime

1.3 Register the Model / Service

2 SAP Gateway Hub System

2.1 Activate the Service

2.2 Delete the Service

3 Code Snippets

3.1 Model Provider Class (MPC)

3.2 Data Provider Class (DPC)

Former Development

Data Model Creation and Maintenance

Creating a Data Model from Scratch

OData Channel

Properties Editor

Creating Data Objects

Creating Properties

Semantic Values

Creating Operations

Creating Internal Relations

Creating Complex Types

Annotation Editor

Annotation for Data Objects

Annotation for Properties

Annotation for Relations and Operations

Documenting a Data Model

Using the Data Model Generator Tool

Creating a New Data Model

Selecting the Data Source

Overview of Data Sources

Business Object Repository

Constraints Using BOR Data Sources

Screen Scraping

Overview of Screen Scraping Recordings

Storing Recordings in Recording Groups

Recording a Transaction, its Screens, and Fields

Read-Only Data Based on Recordings

Getting Search Help Data Source

Constraints Using Screen Scraping Data Sources

Remote Function Calls

Data Model Generator Support for Data Sources

Error Handling in the Data Model Generator

Creating the Mapping

Overview of the Map Operation Dialog

Mapping Validation Rules

Mapping the Query Operation

Ranges Table

Mapping the Read Operation

Mapping the Create Operation

Mapping Delete and Update Operations

Setting Constant Values

Assigning Keys to Operations

Setting Keys for Table Entries

Editing a Data Model

Editing the Mapping in Your Data Model

Changing the Mapping

Changing a Mapping Route

Adding and Removing Properties, and Data Objects

Reassigning the Key of a Property

Generating the PS and DS Data Models

Manually Add Your Model to a Consumption Model

Configuring the System Alias for your Service

Guidelines for Using the Generated Service

Deriving a Data Model from an Existing Data Model

Creating a Data Model from a Generic Service Data Object (GSDO) Type

Editing a Data Model

Changing the Language

Creating a Consumption Model

Consumption Model URL

Code Patterns for the OData Channel

Data Provision Code Patterns

Metadata Definition Code Patterns

Defining Entity Type

Defining Complex Type

Defining Association

Defining Composition

OData Channel Generation Tool

How Does It Work?

Using the OData Channel Generation Tool

Runtime Registration and Service Activation

Hub OData Channel without IW_BEP

Developing Content on SAP Gateway OData Channel

Generating the BOPs

Deleting an RFC or a Web Service BOP

Creation of Data Model and Data Dictionary Structures

Implementing Mapping Specialists

Implementing /IWFND/IF_MGW_BOP_MAP_READ Mapping Interface

Implementing /IWFND/IF_MGW_BOP_MAP_READ for Read

Implementing /IWFND/IF_MGW_BOP_MAP_READ for Expand Entity

Implementing /IWFND/IF_MGW_BOP_MAP_QUERY Mapping Interface

Implementing /IWFND/IF_MGW_BOP_MAP_QUERY for Query

Implementing /IWFND/IF_MGW_BOP_MAP_QUERY for Expand Entity Set

Implementing /IWFND/IF_MGW_BOP_MAP_ACTION for Execute Action

Implementing /IWFND/IF_MGW_BOP_MAP_CREATE Mapping Interface

Implementing /IWFND/IF_MGW_BOP_MAP_CREATE for Create

Implementing /IWFND/IF_MGW_BOP_MAP_CREATE for Deep Insert

Implementing /IWFND/IF_MGW_BOP_MAP_UPDATE Mapping Interface

Implementing /IWFND/IF_MGW_BOP_MAP_DELETE for Delete

Implementing GET_EXPAND_CLAUSE_DEFAULT

Implementing /IWFND/IF_MGW_BOP_MAP_GSTREAM

Error Handling in Mapping Specialists

Implementing Entity Data Provider

Implementing Data Providers

Custom Backend Connectivity API

Generic Channel

Subscription Push Scenario

Push Sample Application

Enabling the Payload Push Scenario in Your Application

Query Results Caching

Business Enablement Provisioning (IW_BEP)

Business Enablement Provisioning (IW_BEP) Configuration

Defining an Event

Using a Defined Event

Assigning Backend Events to Preset BOR Events

Using the BEP API

Event Subscription and Notification

Errors

Cookbooks for Former Development

Using SAP Gateway Design Time in ABAP Workbench

Creating a Model in the ABAP Workbench

Creating the Data Model

Creating the User Centric Data Model

Creating the Consumption Model

Creating the OData Channel Runtime Class

Configuring the Runtime

Using the OData Channel Generation Tool to Create a Service

Creating and Importing the Service Description File

Confirming the Mapping and Generating the Classes and Interfaces

Implementing the GET_ENTITY and GET_ENTITYSET Methods

Registering the Service for Use at Runtime

Activating the Service on the Hub

Using Code Patterns on the OData Channel

Using Data Provision Code Patterns

Using Metadata Definition Code Patterns

SAP Gateway Generators Cookbook

Create a Data Model from BOR Data Source

Mapping the Operations

Mapping the Query Operation

Mapping the Read Operation

Mapping the Create Operation

Mapping the Update Operation

Mapping the Delete Operation

Add the Data Model to a Consumption Model

Assign the System Alias to the Service in SAP Gateway

Testing the Service

Test the Query Operation

Test the Read Operation

Test the Create Operation

Test the Update Operation

Test the Delete Operation

Generic Channel Cookbook

BCO_COMMON:4FA154B3B6D24B27E10000000A421

Getting Started with SAP Gateway Services

Creating the Data Model

Creating the UC Data Model

Creating the Consumption Model

Adding the Data Model to the Consumption Model

Checking the Service

SAP Gateway Content Guide

SAP Gateway Supported OData Channel Scenarios

Workflow Services

Workflow Task Service: Central Hub Deployment with IW_BEP Backend Installation

Subscribing to Notification Types

Collections

Workflow Task Collection (0..n)

Comments Collection (0..n)

Description Collection (0..1)

Attachments Collection (0..n)

Decision Options Collection (0..n)

Participants Collection (1..n)

Possible Agents Collection (0..n)

Related Objects Collection (0..n)

Requester Notes Collection (0..n)

Business Object Attachments Collection (0..n)

Extensible Elements Collection (0..1)

Substitution Collection (0..n)

Substitution Profiles Collection (0..n)

Outbox Task Collection

Actions

Get Substitutes by User Context

Creating a Personal Substitute

Deleting a Personal Substitute

Activate Substitution

Deactivate Substitution

Uploading Attachments to a Work Item

Deleting Attachments from a Work Item

Media Links

Query String Options

Workflow User Exits

Workflow Task Service: Central Hub Deployment with IW_BEP Hub Installation

Collections

Workflow Task Collection (0..n)

Comments Collection (0..n)

Description Collection (0..1)

Attachments Collection (0..n)

Decision Options Collection (0..n)

Participants Collection (1..n)

Possible Agents Collection (0..n)

Related Objects Collection (0..n)

Requester Notes Collection (0..n)

Business Object Attachments Collection (0..n)

Extensible Elements Collection (0..1)

Substitution Collection (0..n)

Substitution Profiles Collection (0..n)

Creating a Personal Substitute

Deleting a Personal Substitute

Activate Substitution

Deactivate Substitution

Uploading Attachments to a Work Item

Deleting Attachments from a Work Item

Task Gateway Administrator

Task Gateway Setup

Installing SAP Gateway Components

Integrating Your SAP Business Workflow System

Integrating Your SAP Business Process Management System

Task Gateway Scenarios

Defining a Task Gateway Scenario

Task Gateway Service

Task Gateway Service Version 1

Task Collection

Task Definition Collection

Consumer Scenario Collection

Scenario Collection

Context Collection

Filter Option Collection

Substitution Collection

Potential Owners Collection

Possible Agents Collection

Attachments Collection

Adding and Deleting Attachments using the Task Gateway Service

Comments Collection

Description Collection

Processing Logs Collection

Task Definition Data Collection

UI Execution Link Collection

Task Gateway Service Version 2

Task Collection

Task Definition Collection

Consumer Scenario Collection

Scenario Collection

Filter Option Collection

Substituted Users Collection

Substitutes Rule Collection

Substitution Profile Collection

Substitution Rule Collection

System Info Collection

Attachments Collection

Adding and Deleting Attachments using the Task Gateway Service

Comments Collection

Description Collection

Processing Logs Collection

Task Definition Data Collection

Task Object Collection

UI Execution Link Collection

Task Gateway Service Configuration

Creating a System Alias

Activating Task Gateway Service

Assigning a Software Version to Service

Setting Up Task Gateway Service for Multi Origin Composition (MOC)

Adding Additional System Aliases

Adding New Providers

Configuring Task Gateway Service Settings

Unified Inbox

Configuring the Unified Inbox

Configuring Theme for Unified Inbox

Substitution Profile in Unified Inbox

Task Gateway Developer

Task Gateway User Exits

Creating a New User Exit (BAdI)

Creating a New Class Implementation for Scenario Count Items

Task Gateway User

Unified Inbox

Managing Tasks with the Unified Inbox

Managing Substitution Rules in the Unified Inbox

Troubleshooting for Task Gateway

HCM Workflow Items

Business Process Content Powered by SAP Gateway

Providing Process Details

Providing Process Context Details

Using Process Details

ProcessDefinition

ProcessStepDefinition

ProcessContextDefinition

Using Process Context Details

Former Development

SAP Enterprise Resource Planning

SAP Gateway Supported Generic Channel Scenarios

Customer Relationship Management

Human Capital Management

Time Management

Leave Management

Consumption of Generic Channel Workflow Services

Subscribing to Notification Types

Generic Channel Service Workflow Collections

Workflow Task Collection

Specific Task Collections

Participants Collection (1..n)

Extensible Elements Collection (0..1)

Attachments Collection (0..n)

Attachment Data Collection (1)

Comments Collection (0..n)

Related Objects Collection (0..n)

Description Collection (0..1)

Possible Agents Collection (0..n)

Terminate Events Collection (0..n)

Requester Notes Collection (0..n)

Note Data Collection (1)

Decision Options Collection (1..n)

Upload Attachments to a Work Item

Delete Attachments from a Work Item

Raise a Terminating Event

Query String Options

Creating a New Data Model from an Existing Workflow Data Model

Workflow User Exits

Code List