SAP Gateway Foundation (SAP_GWFND) |
SAP Gateway Foundation Master Guide |
General Overview |
What's New |
SAP Gateway and OData |
SAP Gateway Service Builder |
Deployment Options |
Unicode and Non-Unicode Support |
Glossary |
SAP Gateway Foundation Configuration Guide |
Quick Configuration |
Central Hub Deployment |
Service Development in Backend System |
Service Development in Hub System |
Embedded Deployment |
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 the 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 |
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 |
Defining Connection Settings to SAP Gateway |
Creating a bgRFC Supervisor Destination |
Monitoring bgRFC Queues |
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 |
SAP Gateway Foundation Technical Operations Guide |
Alert Monitoring with CCMS |
Trace and Log Files |
Read Access Logging (RAL) and OData |
Service Context Facade |
Supportability |
Error Log |
Configuration Settings for the Error Log |
SAP Performance Statistics |
SAP Gateway Statistics |
Configuring Tracing Tools |
Performance Trace |
Payload Trace |
SAP Gateway Client |
Notification Monitor |
Application Log Viewer |
High Availability |
Periodical Tasks |
Custom Development |
Troubleshooting |
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 Foundation 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 Enterprise 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 |
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 Workflow |
Web Application Scenario |
Desktop Application Scenario |
Mobile Device Scenario |
Cloud Application Integration Scenario |
Social Network Application Scenario |
Enabling OAuth 2.0 Authentication for OData Services |
Server Side Application Scenario |
Data Protection and Privacy |
SAP Annotation Security Level for Handling Batch Requests |
Avoid Caching of Confidential Data |
Virus Scan |
SAP Gateway Foundation Developer Guide |
OData Channel |
OData in SAP Gateway - Feature Overview |
OData Query Options |
General Considerations |
OData Best Practices |
Performance Best Practices |
Co-Deployment |
Cached Request Processing and Micro Hub |
Whitelisting for OData Services for Cached Request Processing |
Creating High-Quality OData Services |
Deployment Considerations for Development |
Development in SAP Gateway Hub System |
Development in SAP Business Suite Backend System |
Basic Features |
Catalog Service |
Media Links |
Service Life-Cycle |
Activate and Maintain Services |
Maintaining Models and Services |
Maintain Annotation Models |
Metadata 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 |
Soft State Based Query Result Cache |
Search and Open Search Capabilities |
Simple Field Extensibility |
Conversion Support for Complex Filters |
Excel Support |
User Self Service |
Configuration Settings for User Self Service |
Configuring SAP Business Suite System for User Self Service |
Configuring SAP NetWeaver System for User Self Service |
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 an SAP Gateway Service 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 |
/IWBEP/IF_MGW_EXPR_VISITOR |
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 |
SAP Gateway Service Builder |
Working on Service Builder Projects Complying with OData V2 |
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 |
Data Model Definition via Declarative Method |
Entity Types |
Defining Properties |
Mappings and ABAP Type Editor |
EDM Type Vs ABAP Type Validation |
Navigation Properties |
Entity Sets |
Associations |
Referential Constraints |
Association Sets |
Function Imports |
Function Import Parameters |
Complex Types |
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 Services from External Framework (SPI, BW Query, GenIL) |
Referencing Data Source |
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 |
Copying Data Model Artifacts |
Schema Namespace |
Sample Service - Basic |
Sample Service - Basic: Entity Types |
Sample Service - Basic: Complex Types |
Sample Service - Basic: Value Help (Entity Type/Sets) |
Sample Service - Basic: Function Imports |
Sample Service - Basic: Language-Dependent Text Handling |
Registering Sample Service - Basic |
Service Implementation |
Redefining Methods of the Operations |
Mapping to a Data Source |
Creating the Mapping |
Mapping UI |
Mapping Table |
Data Source View |
Deleting the Mapping |
Mapping Rules |
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 |
Generating ABAP Classes |
BOP Interface Naming Rules |
ABAP Classes |
Model Provider Class |
Base Class: Model Provider Class |
Implementation Class: Model Provider Class |
Data Provider Class |
Base Class: Data Provider Class |
Implementation Class: Data Provider Class |
Annotation Provider Class |
Base Class: Annotation Provider Class |
Implementation Class: Annotation Provider Class |
Service Maintenance |
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 |
Get Step History |
Apply Decision |
Apply Forward |
Apply Reserve |
Apply Release |
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) |
Extensible Elements Collection (0..1) |
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) |
Substitution Collection (0..n) |
Substitution Profiles Collection (0..n) |
Actions |
Apply Decision |
Apply Forward |
Apply Reserve |
Apply Release |
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 |
SAP Gateway Cookbooks |
Getting Started with the Service Builder |
Creating a Project |
Copying a Service Builder Project |
Importing Data Model from File |
Importing a Data Source (RFC/BOR Interface) |
Including an OData Service (SAP Gateway) |
Redefining Services |
Redefining SAP Gateway Services |
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 the APC Implementation Class |
Service Maintenance |
Creating OData Channel Content |
SAP Business Suite Backend System |
Create the Model Provider Class (MPC) |
Create the Data Provider Class (DPC) for the Runtime |
Register the Model / Service |
SAP Gateway Hub System |
Activate the Service |
Delete the Service |
Code Snippets |
Model Provider Class (MPC) |
Data Provider Class (DPC) |
SAP Gateway Foundation for OData V4 Developer Guide |
Central Concepts of the OData V4 Runtime |
Deployment Options |
Service Group |
Cross-Service References |
Repository |
Development of OData V4 Services |
Service Provisioning |
Metadata Definition |
Data Provider Definition |
Convenience Features |
Test Applications |
Service Registration |
Service Group Publishing |
Tools |
Service Administrator |
Metadata Cache |
Security Enhancements for OData V4 |
Virus Scanning |
OData V4 APIs |
OData V4 Runtime Classes |
Class /IWBEP/CL_V4_ABS_DATA_PROVIDER |
Class /IWBEP/CL_V4_ABS_MODEL_PROV |
OData V4 Runtime Interfaces |
Interface /IWBEP/IF_V4_DP_BASIC |
Interface /IWBEP/IF_V4_DP_INTERMEDIATE |
Interface /IWBEP/IF_V4_DP_ADVANCED |
Interface /IWBEP/IF_V4_DP_BATCH |
Interface /IWBEP/IF_V4_DP_PROCESS_STEPS |
Interface /IWBEP/IF_V4_DATA_PROVIDER |
OData V4 Model Interfaces |
Interface /IWBEP/IF_V4_MED_ACTION |
Interface /IWBEP/IF_V4_MED_ACTION_IMP |
Interface /IWBEP/IF_V4_MED_ENTITY_TYPE |
Interface /IWBEP/IF_V4_MED_ACT_PARAM |
Interface /IWBEP/IF_V4_MED_ENUM_PROP |
Interface /IWBEP/IF_V4_MED_ACT_RETURN |
Interface /IWBEP/IF_V4_MED_CPLX_PROP |
Interface /IWBEP/IF_V4_MED_FUNCTION |
Interface /IWBEP/IF_V4_MED_CPLX_TYPE |
Interface /IWBEP/IF_V4_MED_FUNC_IMP |
Interface /IWBEP/IF_V4_MED_ENTITY_SET |
Interface /IWBEP/IF_V4_MED_FUNC_RETURN |
Interface /IWBEP/IF_V4_MED_ENTITY_TY_EDM |
Interface /IWBEP/IF_V4_MED_MODEL_EDM |
Interface /IWBEP/IF_V4_MED_NAV_PROP |
Interface /IWBEP/IF_V4_MED_FUNC_PARAM |
Interface /IWBEP/IF_V4_MED_PRIM_TYPE |
Interface /IWBEP/IF_V4_MED_MODEL |
Interface /IWBEP/IF_V4_MED_PRIM_PROP |
Interface /IWBEP/IF_V4_MED_SERVICE_REF |
OData V4 Annotation Interfaces |
Interface /IWBEP/IF_V4_ANNO_ANNOTATION |
Interface /IWBEP/IF_V4_ANNO_ANN_TARGET |
Interface /IWBEP/IF_V4_ANNO_CAST |
Interface /IWBEP/IF_V4_ANNO_COND_EXP |
Interface /IWBEP/IF_V4_ANNO_COLLECTION |
Interface /IWBEP/IF_V4_ANNO_COND_EXP_P |
Interface /IWBEP/IF_V4_ANNO_FUNCTION |
Interface /IWBEP/IF_V4_ANNO_FUN_PARAM |
Interface /IWBEP/IF_V4_ANNO_ISOF |
Interface /IWBEP/IF_V4_ANNO_RECORD |
Interface /IWBEP/IF_V4_ANNO_LABEL_ELEM |
Interface /IWBEP/IF_V4_ANNO_MODEL |
Interface /IWBEP/IF_V4_ANNO_NULL |
Interface /IWBEP/IF_V4_ANNO_PROPERTY |
Interface /IWBEP/IF_V4_ANNO_REFERENCE |
Interface /IWBEP/IF_V4_ANNO_SIMP_VAL |
Interface /IWBEP/IF_V4_ANNO_TERM |
Interface /IWBEP/IF_V4_ANNO_URL |
Working on Service Builder Projects Complying with OData V4 |
Create Service Builder Project |
Create Entity Types |
Create Properties |
Create Navigation Properties |
Define Referential Constraints |
Create Entity Sets |
Define Navigation Property Binding |
Create Complex Types |
Close or Delete a Project |
Copy a Project |
Import DDIC Structure |
Generate Runtime Objects |
Generate ABAP Classes |
ABAP Classes |
Model Provider Class |
Data Provider Class |
Publish a Service Group |
Notification Channel |
Notification Channel Provider Enablement |
Develop Notification Provider |
Demo Provider |
Sample Provider |
Call Notification API |
Sample Report to Create Notifications |
Notification Channel Hub |
Clearing Metadata Cache and Deleting Notifications |
OData V4 Service |
Notification Channel Configuration |
Configuration for Notification Channel Provider Enablement |
Configuration for Notification Channel Hub |
Push Channel Settings |
Add Push for Use with SAP Mobile Platform |
Activate Sensitive Data Cache and Data Encryption |
Notification Channel User Roles and Authorizations |
Creating and Assigning Roles from Templates |
Notification Channel Secure Data Store |
Trusted RFC Communication between Hub and Provider |
Notification Channel Troubleshooting |