Copyright(c) 2018 by Nixon Vunganai.

All rights reserved.

Neither this document nor any part of it may be copied or reproduced in any form or by any
means or translated into another language, without the prior consent of Nixon Vunganai. The
information contained in this document is subject to change without notice.

WHATSAPP +255738656506
INTRODUCTION 4

SAP GATEWAY SERVICE ENABLEMENT 5

Backend OData Channel 5

User Settings 5
Define Role for Backend OData Channel User 5
Define Role for Backend OData Channel Administrator 6
Define Role for Backend OData Channel Developer 6
User Self Service Setup 6
Maintain URL for User Account Activation 6
Maintain Number Range Interval for User Self Service 7
Maintain RFC Destination for User Replication 8
Maintain User Category 9
Verify User Request 10
Define Notification Process for User Request Management 10
Implement User Management 12
Define Handler for User Management Notification 12
User Request Cleanup 13
Connection Settings to SAP Gateway 13
Define Settings for Idempotent Services 13
Create RFC Destination for Outbound Queues 14
SAP Gateway Settings 15
Create bgRFC Supervisor Destination 16
Monitor bgRFC Queues 17
Service Development for Backend OData Channel 18
Maintain Models 18
Maintain Services 18
Maintain Annotation Models 19
Display Models and Services 19
OData Channel Generation Tool 20
Service Development with OData V4 20
OData V4 Service Administration 20
Configuration Settings 21
Define Global Configuration Settings 21
Define Parallelization of Batch Queries 21
Backend Event Publisher Administration 22
Event Definition 22
Event Type Linkages 23
Logging Settings 24
Set Log Level for All Users 24
Set Log Level for Specific Users 25
Clear Application Log 27
Customizing of the SAP Gateway CCMS Context 27
Support Utilities 28
Create Default Cleanup Jobs 28
Manage Cleanup Jobs 28
Application Log 28
Clear Cache 29
Content 29
Workflow Settings 29
Task Provider Customizing 29
Maintain Workflow Filter Settings 31
Maintain Task Names and Decision Options 31
Enable Task Filter 32
Task Gateway 33
Task Gateway Service 33
Task Gateway Service Settings 33
Context Service Settings 33
Scenario Definition 33
Registration 35
Provider Implementation 35
Unified Inbox 36
Unified Inbox Configuration 36
General Settings 37
Create BAdI Implementation to Fetch List of Users for Roles 37
Business Process Enablement 37
Process Service 37
Business Suite - Process Observer 37
Create RFC Destination 37
Maintain System Alias 38
Process Context Service 39
Register Context Service for Process Definition 39

WHATSAPP +255738656506
INTRODUCTION
Welcome to the fascinating world of SAP. This book helps you crack the tricks of mastering SAP HANA
Customization
SAP Gateway Service Enablement

Backend OData Channel

User Settings

Define Role for Backend OData Channel User

Use

Users of SAP Gateway Generic Channel are grouped in roles, which are needed for several other
configurations.

Requirements

You can find details about different SAP user administrator types in the SAP NetWeaver
Library documentation at http://help.sap.com/nw70 -> SAP NetWeaver 7 Including
Enhancement Package 2. In the Functional View select SAP NetWeaver by Key Capability
-> Security -> Identity Management -> User and Role Administration of AS ABAP ->
Configuration of User and Role Administration -> First Installation Procedure -> Setting up User
and Authorization Administrators.

Standard settings

There is no restriction on the number and names of roles created for SAP Gateway.

Activities

The roles of the users in your SAP Gateway Generic Channel system has to be enhanced with the
authorizations contained in the authorization template /IWBEP/RT_MGW_USR.

Proceed as follows:

1. Click on the activity icon. The Role Maintenance screen is displayed.

2. In the Role field, enter the role already set up in the system and assigned to the existing user (or set
up the role first).
3. Specify the required SAP Gateway authorizations for this new role. On the Authorizations tab
choose Change Authorization data.
4. From the list of template roles, select /IWBEP/RT_MGW_USR and choose Adopt reference.
If the list of templates does not appear, choose Edit -> Insert Authorization(s) -> From
template.

5. Assign values to the authorization fields according to the role.

6. Save your settings for the role.

WHATSAPP +255738656506
Define Role for Backend OData Channel Administrator

Use

In addition to defining a role for a Backend OData Channel user you need to create an administrator role.
Only users with the appropriate administrator role can carry out customizing activities.

After this role has been created, it must be assigned to users.

Requirements

Roles can only be created and assigned to users by a user administrator.

Activities

First create an administrator role, then assign the role to users.

The role template for the administrator role is /IWBEP/RT_MGW_ADM.

For information on creating administrator roles and assigning roles, see the SAP NetWeaver
documentation.

Define Role for Backend OData Channel Developer

Use

In addition to defining roles for a user and an administrator you also have to define roles for your
developers.

For an OData Channel developer the role template /IWBEP/RT_MGW_DEV is provided.

Activities

For information on creating and assigning roles, see the SAP NetWeaver documentation.

User Self Service Setup

Maintain URL for User Account Activation

Use
 You can maintain the activation URL of the application you are using to manage your user accounts. For
example, http://host:port/applicaiton.

Note: This is a mandatory activity.

Activities

1. Click New Entries.

2. Enter the external service name of the OData service used for User Request Management in the
External Service Name field.
If you have extended the SAP delivered OData service for User Request Management then
enter the external service name of the extended OData service, else enter
USERREQUESTMANAGEMENT.

3. Enter a version number.

4. Enter the namespace used in the User Request Management OData service in the Namespace
field.
5. Enter the activation URL of the application. The URL is sent to the user via notification (for
example, email) for activating the user account.

Maintain Number Range Interval for User Self Service

Use

Note: This is a mandatory activity. The number range you set here is required for generating the users in
the SAP system.

Activities

Display Intervals - Click Display Intervals to see the number range already created.

Maintain Intervals

1. Click Change Intervals to edit an existing number range or create a new one.
2. Click Insert Interval to add a new interval.
3. In the Insert Interval screen, enter:
01 in the No. field

Enter a number in the From number field which will be the lower limit of the interval you are
creating.

Enter a number in the To number field which will be the upper limit of the interval you are
creating.

Leave the Ext checkbox uncheked.

4. Click Insert (Enter).
WHATSAPP +255738656506
 5. Click Save.
Status - Click Change Stat. to change the Current Number.

Maintain RFC Destination for User Replication

Use

This IMG activity enables you to replicate the users from the SAP backend to SAP Gateway Hub system

You can maintain the list of RFC destinations (created on the SAP backend which points to the SAP
Gateway Hub system) to replicate the users (created on the SAP backend) to SAP Gateway Hub system.

Note: By default this activity allows you to replicate the users on to a single SAP Gateway Hub system,
if you want to replicate the users on multiple SAP Gateway Hub systems, you can use either the User
Management BAdI or Handler of User Notification BAdI. These BAdIs can be implemented using the
following IMG activities:

- Implement User Management

- Define Handler for User Management Notification

Requirements

You should create Type RFC destinations on the SAP backend. This RFC destination should point to
SAP Gateway Hub system.

You should run this activity before executing the /IWBEP/USERREQUESTMANAGEMENT OData
service (to create the user).

Standard settings

You need to maintain the following values in case you are using the default User Self Service solution
from SAP Gateway. The RFC destination entered here shall be used for replicating users on the SAP
Gateway Hub system.

Implementation Type - IWBEPUM

RFC Destination - The trusted RFC destination created on the SAP backend system between SAP
Gateway Hub and SAP backend system.

Activities

1. Click New Entries.

2. Enter the implementation type. Implementation type can be any key with a maximum of eight
characters. For example, Z_MY_UM or IWBEPUM in case default User Self Service solution from SAP
Gateway needs to be used.
 3. Enter the RFC destination name which you have created on SAP backend system between SAP
Gateway Hub and SAP backend system.

Maintain User Category

Use

You can maintain the list of user categories for your application using this activity. Each user category is
mapped to a Reference User. Reference user should be created in the system with roles and authorization
required for the application.

Note: This is a mandatory activity.

Consider a B2C application "A". The application "A" provides a self service for B2C customers to create
users in the system. In case you want to restrict the user's action based on certain category (let's say
"Agent" or "Normal User"), you can define categories "Agent" and "Normal User" using this IMG
activity. You should also maintain a reference user for both categories. Requirements

You can define a standard set of user categories for each application. The user category shall be part of
the User Request entity of USERREQUESTMANAGEMENT. During the creation of user request,
applications can provide the user category. Based on the user category the corresponding reference user
is picked from the configuration table and users are created.

You should create and maintain the reference user for their (categories) application in the system. The
reference user shall be assigned with roles and authorization required for accessing their applications.
The reference user shall be used as a reference for creation of users. If reference user is not maintained in
the system an error is thrown.

Activities

1. Click New Entries.

2. Enter the external service name of the OData service used for User Request Management in
the External Name field.
In case if you have not extended the OData service "USERREQUESTMANGEMENT" delivered by
SAP, then enter "USERREQUESTMANAGEMENT" in the External Name field.

3. Enter a version number.

In case if you have not extended the OData service "USERREQUESTMANGEMENT" delivered by
SAP, then enter "0001" in the Service Version field.

4. Enter the namespace used in the User Request Management OData service in the Namespace field.
In case if you have not extended the OData service "USERREQUESTMANGEMENT" delivered by
SAP, then enter "/IWBEP/" in the Namespace field.

5 Enter a three digit number for the user category in the User Category field that shall be used in the
application.
6 Enter a text in the User Category Text field, for example 'Agent'.

WHATSAPP +255738656506
 7 Enter the reference user name (maintained in the system) in the Ref. User Name field.

Verify User Request

Enhancement Spot

The enhancement spot /IWBEP/ES_MGW_URM contains BAdI definitions for enhancing the User
Request Management flow.

BAdI Definition

The enhancement provides BAdI /IWBEP/BD_MGW_URM_VERIFICATION using which

applications can implement a verification process before a user request is created in the system. No
default implementation is provided. The user request entity is extendable with application specific fields
like Business Partner ID, Meter ID, and so on. The values for these fields can be requested during the
user creation process and can be validated by implementing this BAdI definition.

BAdI Implementation

The BAdI /IWBEP/BD_MGW_URM_VERIFICATION defines the functionality for verifying the

information provided during the user request creation. It has a filter. If you have extended the
USERREQUESTMANAGEMENT OData service, use the combination of Service Document Name,
Service Document Namespace, Service Document Version of the extended OData service as BAdI
filter parameters.

BAdI Interface

The BAdI interface /IWBEP/IF_MGW_URM_VERIFICATION contains methods for verifying the user
request information before creating the user request.

BAdI Method

The method VERIFY_USER_REQUEST_INFO is called before the user request is created in the system.
If the method returns 'RV_IS_VALID = space', then the user request is not created in the system.

Define Notification Process for User Request Management

Enhancement Spot

The enhancement spot /IWBEP/ES_MGW_URM contains BAdI definitions for enhancing the User
Request Management flow.
 BAdI Definition

The enhancement provides BAdI /IWBEP/BD_MGW_URM_NOTIFICATION using which you can send
notifications to anonymous users trying to create named users in the system. As a fallback
implementation, an email agent would be delivered for sending notifications to anonymous users via
email (for verification). The notification contains an Activation Key embedded in an URL. Anonymous
user needs to verify the user account by accessing the URL.

BAdI Implementation

The BAdI /IWBEP/BD_MGW_URM_NOTIFICATION defines the functionality for sending

notifications from User Request Management application. If you have extended the
USERREQUESTMANAGEMENT OData service, use the combination of Service Document Name +
Service Namespace + Service Version of the extended OData service as BAdI filter parameters, else use
the following filter parameters:

Service Document Name - USERREQUESTMANAGEMENT

Service Namespace - /IWBEP/

Service Version - 0001

User Request Management application has the provision to deliver notifications via email as the standard.
You can enhance the solution by adding your own notification mechanism.

Activities

In case you want to use the standard notification agent to send email notifications but customize the
content:

1. Extend the class /IWBEP/CL_MGW_URM_NOTIF_STD.

2. Redefine the COMPOSE method.

3. Register the extended class as BAdI implementation.

By default, the notification content is in the following format, you can use the same format or customize
it as per your requirement:

"Dear <User Name>,

Verify your email address by clicking the link. If you are not able to access the link, copy paste the
URL -
<http://host:port/<applicationpath>?RequestID=<value>&ActivationKey=<value>&type=<v alue>> in
the browser. Regards,

User Administration Team"

Note: Content inside angle brackets serves as placeholder.

WHATSAPP +255738656506
Implement User Management

Enhancement Spot

The enhancement spot /IWBEP/ES_MGW_UM contains BAdI definition to manage the users ( for
enhancing the User Management flow).

BAdI Definition

The BAdI /IWBEP/BD_MGW_UM_USR_MANAGER can be used to:

- Create users
- Manage users
- Reset passwords
- Check user existence
The BAdI has a filter, use the following as the BAdI filter parameters:

- Service Document Name - USERMANAGEMENT

- Service Namespace - /IWBEP/
- Service Version - 0001

The BAdI is a multiple use BAdI. There can be multiple BAdI implementations for the same filter
values, however during runtime it is expected to have only one of the BAdI implementation to be active.

BAdI Implementation

A default implementation /IWBEP/BD_MGW_UM_USR_MGR_SUSR is provided for managing users

using the user and role administration functions of SAP NetWeaver AS ABAP. The BAdI
implementation is executed in an asynchronous mode.

Define Handler for User Management Notification

Enhancement Spot

The enhancement spot /IWBEP/ES_MGW_UM contains BAdI definition to manage the users ( for
enhancing the User Management flow).

BAdI Definition

The BAdI /IWBEP/BD_MGW_UM_NOTIFICATION is used to notify the person (who has implemented
the BAdI) about the user creation.

Applications can use this information to perform application specific logic like replication of user along
with Business partner data into SAP Business Suite system.
 This is a multiple use BAdI without filters. User Management OData service calls the BAdI
implementations for the BAdI definition notifying that the user has been created.

The BAdI is executed in an asynchronous mode.

User Request Cleanup

Use

You can delete the user request which are in process / open / completed / cancelled using this activity.

Activities

- To delete the user requests which are older than 'X' number of days and which are in process, enter
the duration (in days) in the In Process (Days) field. The user requests in process (which are older
than the number of days entered) will be deleted upon execution.
- To delete the user requests which are older than 'X' number of days and which are open, enter the
duration (in days) in the Open (Days) field. The user requests open (which are older than the
number of days entered) will be deleted upon execution.
- To delete the user requests which are completed, select Delete Completed Requests checkbox
and click Execute.
- To delete the user requests which are cancelled, select Delete Cancelled Requests checkbox and
click Execute.
- To delete all the user requests (in process, open, completed, cancelled), select Delete All Requests
checkbox and click Execute.

Connection Settings to SAP Gateway

Define Settings for Idempotent Services

Use

In SAP Gateway, synchronous communication with the consumer uses the OData protocol. In
this communication, there is no certainty that each request message sent by the groupware arrives only
once at the provider. A message may be lost or may arrive several times ( for instance, during network
problems). The framework ensures that a request message is executed only once ( idempotency ).

Activities

WHATSAPP +255738656506
 SAP NetWeaver provides a framework that ensures that service calls are executed only once. This
framework must first be configured.

Create RFC Destination for Outbound Queues

Use

The RFC service uses outbound queues to reliably send information to a consumer. These outbound
queues use Background Remote Function Call (bgRFC) technology.

Note

This is a shared configuration step for notifications for OData Channel Push as well as for the
Backend Event Publisher.

Activities

To create a bgRFC destination proceed as follows:

1. Click on the activity icon. The Configuration of RFC Connections window opens (transaction
SM59).
2. Choose Create. The RFC Destination Window opens.
3. In RFC Destination enter a name for the RFC destination you want to create. The name is pre-
defined.
4. In Connection Type enter , for ABAP connections.
5. In Description 1, enter some text describing the RFC destination. For example, Backend Event
Publisher RFC Destination.
6. Choose Enter.
7. On tab Technical Settings make sure that the option for Load Balancing is set to Yes.
The fields for Target System, Msg.Server and IP Address are filled automatically. The
settings from the current system are used.

8. Select the tab Special Options.

- In higher releases choose bgRFC under Select qRFC Version.
- In lower releases choose Classic under Select Transfer Protocol.
9. Select the tab Logon & Security.
10. In the Logon section enter a special service user. If you use either OData Channel or notifications,
the service user must have a role based on template IWFND/RT_TU_NOTIF in the SAP Gateway
system. Make sure that the option Current User is not active.
11. Choose Save. A warning message displays.
12. Choose Yes.
 13. Choose Connection Test to test the connection.

SAP Gateway Settings

The Backend Event Publisher service can broadcast events to one or more servers running SAP Gateway.
However, you must identify the correct SAP Gateway server to use with the service.

The Service Builder provides the feature where you can maintain the services of one or more servers
running SAP Gateway.

Note

This is a shared configuration step for notifications for OData Channel, Backend Event Publisher
as well as for the Service Builder.

Use

You assign the RFC destination to the specific SAP Gateway system you want to use with Backend
Event Publisher and Service Builder.

You can specify more than one SAP Gateway servers to which you want to propagate events.

Requirements

Make sure that you have done the following:

- Defined a RFC destination to the SAP Gateway server to which you want to broadcast the events or
connect the Service Builder.
- You should know the system name, client ID and the system alias of the host of the SAP Gateway
server to which you want to connect to.

Activities

To specify the SAP Gateway settings proceed as follows:

1. Choose New Entries, and specify the following in Change SAP Gateway Settings: Overview.
- Destination System
Specifies the system name of the host of SAP Gateway.

- Client
Specifies the system client ID of the host of SAP Gateway.

- System Alias
Specifies the unique name designated for the host of SAP Gateway.

- RFC Destination
Specifies the name of the RFC destination to the host of SAP Gateway.

2. Save your settings.

WHATSAPP +255738656506
Create bgRFC Supervisor Destination

You must configure a supervisor destination for the bgRFC to receive the configuration settings for the
bgRFC scheduler. The bgRFC can function only if a supervisor destination has been defined.

This activity allows you to configure a supervisor destination.

Note

This is a shared configuration step for notifications for OData Channel Push as well as for the
Backend Event Publisher.

Use

The Backend Event Publisher (BEP) uses outbound queues to reliably send information to a consumer.
These outbound queues use bgRFC (Background Remote Function Call) technology.

Such queues are used by various services; for instance, the Content Publisher.

Requirements

Make sure that the following prerequisites are fulfilled:

- In transaction SU01 you have created a system user of type B called BGRFCSUPER. This user is
used for the bgRFC communication using the destination you will create. For example,
BGRFC_SUPERVISOR.
- In transaction SU01 you have assigned the role SAP_BC_BGRFC_SUPERVISOR to the user
BGRFCSUPER.

- On SAP NetWeaver 7 you have created a bgRFC destination as an ABAP connection, using the
RFC destination name BGRFC_SUPERVISOR without load balancing, target host, gateway host,
and gateway service.
Specify the user, language, and password. This ensures that the scheduler is activated on the same
application server as the specified user. For example, BGRFCSUPER.

Later, you configure the supervisor destination for the bgRFC to receive the configuration settings for the
bgRFC scheduler.

Activities

Proceed as follows to configure the bgRFC supervisor destination:

1. Click the activity icon. The BgRFC Configuration window opens.

2. Select the tab Define Supervisor Dest.. If there is no supervisor destination maintained proceed
with the steps below.
3. Depending on the version of SAP NetWeaver do the following:
- On SAP NetWeaver 72, choose Create. The Create bgRFC Destination for
Supervisor window is displayed.
In Destination Name, enter BGRFC_SUPERVISOR, choose Create User and enter the
user name BGRFCSUPER.
 - On SAP NetWeaver 7, make sure you have already created a separate bgRFC destination
for the supervisor using the name BGRFC_SUPERVISOR. In Destination under New
Supervisor Destination, enter BGRFC_SUPERVISOR and choose Enter.
4. Save your settings.
5. In the bgRFC destination window, choose Save.
For more information on creating a supervisor destination, see the topic Creating a Supervisor
Destination in the SAP Help Portal under
http://help.sap.com/saphelp_nw70ehp2/helpdata/en/44/fd89614e241e1e10000000a155f6/frameset.ht m

Monitor bgRFC Queues

This activity allows you to monitor the Background Remote Function Call (bgRFC) queue to check for
unsent messages. All the messages are written in unit queues.
Note

This is a shared configuration step for notifications for OData Channel Push as well as for the
Backend Event Publisher.

Use

You can find all the messages that failed to be transported from the Backend Event Publisher to the
consumer environment, because of system fault exceptions. System faults are all SOAP standard errors,
for example: communication error, or other errors that occurred on the Web service.

You should analyse each error text and decide how best to correct the error. If the error can be fixed, you
should send 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 authorization role), or delete all the units inside the inbound
destination.

Note

Application fault exceptions are displayed in the application logs and not the bgRFC.

Activities

To monitor the bgRFC queue proceed as follows:

1. Click on the activity to open the bgRFC monitor, or use transaction sbgrfc.
2. Select procedure as Outbound and unit type as Queued. 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 group ID name and instance number for unsent messages.

WHATSAPP +255738656506
Service Development for Backend OData Channel

Maintain Models

Use

OData Channel implementations retrieve the data from an SAP Business Suite system, that is, a backend
system. For this you first have to define a service in the backend system. Models and services have to be
registered. First models have to be defined.

Requirements

You need a valid transport request to transport your settings, unless you are working with local objects.

Activities

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 the metadata for this
model.
6. Enter an explanatory text as Description.
7. Save your settings.
The new model has been created.

Maintain Services

Use

OData Channel implementations retrieve the data from an SAP Business Suite system, that is, a backend
system. For this you first have to define a service in the backend system. Models and services have to be
registered. After models have to be defined (see Maintain Models you assign them to the service.

Requirements

You need a valid transport request to transport your settings, unless you are working on local objects.

Activities

Maintain Services
 1. Click on the Activity icon.
2. Enter an Technical Service Name which can include a namespace.
3. Enter 0001 as Version.
4. Choose Create.
5. Enter the Data Provider Class which is the name of the class providing the runtime data for this
service. This class implements interface /IWBEP/IF_MGW_CORE_SRV_RUNTIME.

6. Enter an explanatory text as Description.

7. Save your settings.
Your service has been created.

Assign Models to Services

1. Choose Assign Model.
2. Enter the Technical Model Name and the corresponding Model Version which you have created
in Maintain Models.
3. Choose Save.
Your model assignment has been saved successfully.

Maintain Annotation Models

Use

With this activity you can register vocabulary-based annotation models.

For more information, see the documentation on the SAP Help Portal under
http://help.sap.com/nwgateway20 and navigate to SAP Gateway -> SAP Gateway Development
Guide -> OData Channel -> Basic Features -> Service Life-Cycle -> Maintain Annotation
Models.

Requirements

You need a valid transport request to transport your settings, unless you are working with local objects.

Display Models and Services

Use

OData Channel implementations retrieve the data from an SAP Business Suite system, that is, a backend
system. For this you first have to define a service in the backend system. Object models and their groups
have to be registered. This consists of the following parts:

- Define object models (see Maintain Object Models)

WHATSAPP +255738656506
 - Define object model groups and assign object models to object model groups ( see Maintain
Services)
Once a service has been defined in the backend system it needs to be activated in the SAP Gateway
system.

In this activity you can display the object models, the groups and the assignment of object models to
object model groups. Thus you get an overview on the existing object models and groups.

Note

Note that this activity is read-only.

OData Channel Generation Tool

Use

Based on an external tool this Backend OData Channel function generates the skeleton for the model
provider class and the data provider class.

Service Development with OData V4

OData V4 Service Administration

Use

A service can be made available on the SAP Gateway server as part of a service group. Therefore the
service has to be registered in the SAP Business Suite system and assigned to a service group using this
activity.

Activities

In this activity you can:

1. Register services from available repositories

2. Register service groups
3. Assign and reassign services to service groups
4. View available repositories and the services exposed through them
5. View the service groups registered in the current SAP Business Suite system and the assigned
services
6. View system information
 7. View Error Log entries for specific or all services
8. Test services via the GW-Client or Browser and view all test cases for a specific service

Configuration Settings

Define Global Configuration Settings

Define Parallelization of Batch Queries

Use

With this setting you can optimize the performance of batch request processing.

For more information, see Parallelization of consecutive queries in a batch request.

WHATSAPP +255738656506
Backend Event Publisher Administration

Event Definition

The Event Definition activity allows you to create, edit, and view information about the event you want
to make available to SAP Gateway.

In addition, you can define default text items to be sent with the specific event and specify the language
for the text.

Note: Where different text items have been provided in code, the text coming from the code replaces the
default text items.

Use

In order to publish an event using Backend Event Publisher (BEP), the system requires event definition.

You can define the entity to be published and decide whether it is published or not.

Activities

To create an event definition entry:

1. Click the activity icon. The Change Event Definition: Overview window opens.
2. Click Event definition under Dialog Structure. The table, Event Definition displays.
3. Click New Entries, and enter the following in the table, Event Definition:
- Event ID
Specify a unique name for the event. An event ID can consist of only alphanumeric characters
and an underscore. For example, SALES_ORD001_CHANGED.

The name is an internal event ID for the event records.

- Active
Select to make the event available for use in SAP Gateway. When you do not select, the event
is defined but not active.

4. Click Save.

Entering Text for an Event

You can add text to be sent along with an event. Adding text to be sent with an event is optional.

Your text entry can be in any of the supported languages in the SAP system. Only one text entry per
language is allowed.

In addition, you can use the following placeholders in your text so that their actual values are displayed at
runtime.
- '&EVENT_ID&': When used in your text, the value for the specific Event ID displays at runtime.
- '&OBJECT_ID&': When used in your text, the value for the specific event instance displays at
runtime. For example, sales order number.
- '&ACTIVITY&': When used in your text, the value for the specific event activity displays at
runtime. For example, Create, or Change.
 To enter the text items for a language to be sent with an event:

5. Click Event Definition under Dialog Structure. The table, Event Definition displays.
6. Select the specific event for which you want to provide the text and information.
7. Double click Text for Event under Event Definition in Dialog Structure to optionally define text
to be sent with the selected event.
8. Click New Entries, and enter the following:
- Language: Press F4 and select the language in which to display the text entry.
- Event Text: Enter the text you want to be displayed with the selected event. For example,
Attention: changes in inventory levels.
9. Click Save.

Event Type Linkages

The Event Type Linkages activity allows you to specify and assign a predetermined event in Business
Object Repository (BOR) object to an event in Backend Event Publisher.

You can assign BOR items to receivers; assigning BOR items to receivers is called linkage.

Use

Assign a BOR object to Backend Event Publisher by entering the following:

- Receiver Type: The unique event ID you defined in Backend Event Publisher.
- Class Name: The name of the Backend Event Publisher implementation class. It is
/IWBEP/BOR_ADAPTER.

Activities

To specify and assign a BOR item to Backend Event Publisher:

1. Click the activity icon. The Change BOR Event Configure: Overview window opens.
2. Click Event Type Linkages. The table, Event Type Linkages displays.
3. Click New Entries, and specify the following:
- Object category
Select BOR Object Type. Determines the object category to use. There are two types:
ABAP object and BOR object.

- Object Type
Press F4 and choose the object with the events. For example, BUS1001006.

- Event
Press F4 and select a predetermined unique ID of an event for the selected object. For
example, CREATED.

WHATSAPP +255738656506
 - Receiver Type
Enter the unique ID of the event you have defined in Backend Event Publisher. For example,
SALES_ORDER.

- Receiver Call
Select Method. There are two types: Function module and Method. The fields that are
presented are related to your selection.

- Class Name
Enter the name of the Backend Event Publisher implementation class:
/IWBEP/BOR_ADAPTOR.
- Interface Name
The value is automatically selected.

- Method Name
The value is automatically selected.

- Skip the following: Check Function Module, Receiver Type Function Module, and
Destination of Receiver are not applicable.
- Event Delivery
Use the selected default value.

- Linkage Activated
Select to activate.

- Enable Event Queue

Not applicable, leave it as it is.

- Behaviour Upon Error Feedback

Use the selected default value, System defaults.

- Receiver Status
Use the selected default value, No errors. The status can be one of the following:

- No errors
Specifies that the receivers are started by the system. They can be started directly or through
the event queue.

- Error
Specifies that the receiver is not started immediately, however, it is automatically available in
the event queue. The receivers can be restarted through event queue administration.
4. Click Save.

Logging Settings

Set Log Level for All Users

Use

This activity allows you to determine the amount of information logged on a global level that is
applicable for all users.
 You can specify the level of information that will be logged in the application log. Log levels can be set
for two types of activities:

- Processing for regular SAP Gateway activities.

- Processing for Single Activity Trace; this setting will override the previous setting.
For each setting, you can define one of the following possible levels:

Level | Description
All | All messages of type Information, Warning, Security and
Error will be saved to the application log.
Step Completion Information | Messages of type Step Completion Information,
Warning, Security and Error will be saved to the application log. (Messages of type Step Initiation
Information will be omitted.)
Error, Security, Warning | Messages of type Warning, Security and Error will be saved to
the application log. (Messages of type Step Initiation Information and Step Completion Information
will be omitted.)
Error, Security | Messages of type Error and Security will be saved in the application log.
Error | Messages of type Error will be saved in the application log.
(Messages of type Warning, Security, Step Initiation Information and Step Completion Information
will be omitted.)
None | No messages are created and saved.

Note

You can also specify logging information for individual users in the Customizing activity
50000001. If the log level for a particular user is set at a higher value than the global level, then
for that user the individual log level will take precedence.

Activities

To set the log level for all users proceed as follows:

1. Click on the activity icon.

2. To add a new setting, choose New Entries.
3. In the Logging Use Case column, select the activity type for which you want to define log level.
4. In the Log Level field, select a level.
5. Save your settings. Note

If no log level is set, the lowest level Error is used.

Set Log Level for Specific Users

Use

WHATSAPP +255738656506
This activity allows you to determine the amount of information logged in the application log for specific
users.

You can define one of four possible levels:

Level | Description
All | Messages of type Information, Warning, Security and
Error will be saved to the application log.
Step Completion Information | Messages of type Step Completion Information,
Warning, Security and Error will be saved to the application log. (Messages of type Step Initiation
Information will be omitted.)
Warning, Error, Security | Messages of type Warning, Security and Error will be
saved to the application log. (Messages of type Step Initiation Information and Step Completion
Information will be omitted.)
Error, Security | Messages of type Error and Security will be saved in the application log.
(Messages of type Warning, Step Initiation Information and Step Completion Information will be
omitted.)
Error | Messages of type Error will be saved to the application log.
(Messages of type Warning, Security, Step Initiation Information and Step Completion Information
will be omitted.)
None | No message are created and saved.

The log level determines the amount of messages logged for a request that is set through the
Set/Get parameter with ID /IWBEP/SUP_LOG_LEVEL. Instead of defining this Get parameter
withID /IWBEP/SUP_LOG_LEVEL for a user from the user management , you can also set the
parameter for the own user from System -> User Profile -> Own Data.

Note

You can also specify logging information for all users in the Customizing activity Set Log Level
for All Users. If the log level for a particular user is set at a lower value than the global level,
then the global level will take precedence.

Activities

To set the log level for a particular user proceed as follows:

1. Click on the activity icon. The User Maintenance screen is displayed.

2. In the User field select a user and choose Change.

3. On the Parameters tab add parameter /IWBEP/SUP_LOG_LEVEL and assign a log level.

4. Save your settings.

If the user specific log level is no longer required, set a blank parameter (press SPACE key on the
keyboard) or delete the parameter from the user's parameter list. This will log messages according to the
global log level that is defined.
Clear Application Log

Use

From time to time the application log which will have amassed a lot of entries with time, needs to be
cleared. Per default the application log should only store one entry per request. In addition, there is no
need to store these entries for more than a day or a few days.

Activities

Carry out this activity and use report sbal_delete to clear the application log.

Note
Note that this report will delete all entries in the application log.

Customizing of the SAP Gateway CCMS Context

Use

This activity allows you to modify or extend the structure of the SAP Gateway CCMS Context.

Activities

1. Create a new entry in the table.

The following fields need to be filled as follows:

- Node
ID of the new tree node. If you want to use this node as a structure node in the tree (that is, if you
are planning to define child-nodes) you have to restrict the length of the ID to 6 characters.

- Level of the node

- 0 - CCMS Context
This node defines the root of the CCMS Context. Messages cannot be reported directly to this
node. Do not use ID names longer than 6 characters.

- 1 - BEP Agent
This node specifies a SAP Gateway Layer (such as the Groupware Connectivity) or an
Application (such as Reporting). Messages can be reported directly to this node. Do not use
ID names longer than to 6 characters.

- 2 - BEP Component Layer

This node represents a drill-down into a Layer/Application node. Nodes of this type cannot
have subnodes. Messages can be reported directly to this node.

- Parent

WHATSAPP +255738656506
 Superordinated node of the current node. You can use the value help of this field to find the
appropriate node.

Support Utilities

Create Default Cleanup Jobs

Use

This activity creates the default SAP Gateway cleanup jobs. If the jobs already exist, no extra jobs will be
created.
These jobs are automatically created to run the next day at am.

The following jobs are created:

- SAP_IWBEP_SUP_UTIL_CLN
This job deletes logs of support utilities, such as error logs, traces and performance logs.

- SAP_IWBEP_QRL_CLN
This job deletes the entries of the query result log.

Manage Cleanup Jobs

Use

This activity allows you to manage the default SAP Gateway jobs which clean up the cache in the
backend.

This activity opens the standard SM7 transaction.

Application Log

Use
 The Application Log is a special SAP Gateway viewer for application logs which are also available with
transaction SLG1.

For more information, see the documentation which is available in the Application Log Viewer under
Help -> Application Help.
Clear Cache

Use

This activity allows you to clear the cache for the metadata.

This can be done for a specific model or for the whole cache if the flag Cleanup Cache for all Models
is active.

Content

Workflow Settings

Task Provider Customizing

Use

This activity allows you to maintain Workflow task providers in the Task Provider Framework.

The Task Provider Framework consists of 2 components:

- Generic Worklist
- Push Framework
The Generic Worklist collects the user items from all customized active task providers to create a unified
inbox view.

The Push Framework collects notifications from all customized active task providers and sends them to
the SAP Gateway system.

Activities

To add a new provider, you must register an entry in the Providers section, add its details in
the Provider Details and define its adapter classes for the Task Provider Framework in the Adapter
Classes section.

You can also maintain additional services for the provider.

WHATSAPP +255738656506
To add a new provider:

1. In the Dialog Structure section, double-click Providers.

2. Choose New Entries.
3. In the Providers section, enter the provider ID and select the Active checkbox.
4. Choose Save.
5. In the Dialog Structure section, select Provider Details.
6. Choose New Entries.
7. 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.

To define the provider's adapter classes:

9. In the Dialog Structure section, select Task Providers.
10. In the Task Providers table, select the relevant provider.
11. In the Dialog Structure section, double-click Adapter Classes.
12. Choose New Entries.
13. In the first line of the Adapter Classes table, under Adapter Type, select Generic Worklist from
the drop-down list.
14. 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).
15. In the second line of the Adapter Classes table, under Adapter Type, select Push Framework
from the drop-down list.
16. 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).
17. Choose Save.

To define the provider's specific services:

18. In the Dialog Structure section, select Task Providers.
19. In the Task Providers section, select the relevant provider.
20. In the Dialog Structure section, double-click Services.
21. Choose New Entries.
22. 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.
23. Choose Save.
Maintain Workflow Filter Settings

This IMG activity allows you to define filters within Workflow Management to capture workflow
statuses that are specific to Information Worker.

Activities

Click on the IMG activity.

1. Under Dialog Structure, select Business Scenario.

2. Select OSP and choose Filter Basic Data on the left menu.
3. Select OSP_DELTA and choose Filter settings. The list of settings for the selected filter type is
displayed.
4. For the TASK parameter, enter the workflow task ID to be captured within Information Worker. To
add more entries, click New Entries and enter the parameters.
5. Choose Filter Basic Data on the left menu. Select OSP_FULL and choose Filter settings.
6. For the TASK parameter, enter the workflow task ID to be captured within Information Worker.

Maintain Task Names and Decision Options

Use

This activity allows you to maintain workflow tasks that need to be included in the task filter
together with their names and decision keys.

These customizations are relevant when the filter is active. When the filter is not active, all workflow
items are read and all notifications are sent.

Activities

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 will be read according to the
system kernel language. If no name is maintained for the system kernel language, the name will consist
of the workflow and step ID.
WHATSAPP +255738656506
 To add a new workflow task with its corresponding ID to the workflow task filter:
1. In the Dialog Structure section, select Step Name.
2. Click New Entry.
3. In the Step Name section, enter the Workflow ID and step ID, and step description in the relevant
columns.

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 will be read according to the system kernel
language.

To define decision keys:

4. In the Step Name section, select the relevant workflow.
5. In the Dialog Structure section, double-click Decision keys.
6. Click New Entries.
7. In the Decision Key section, add a new decision key and its description in the relevant columns.

Enable Task Filter

Use

This activity allows you to activate or deactivate the task filter. By default, the filter is deactivated.

Activities

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 will only receive 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:

- All notifications are sent.

- All items are sent.
Task Gateway

Task Gateway Service

Task Gateway Service Settings

Use

Configure the Task Gateway service settings to enable:

- User list
- Result and time-interval driven routing
- Specify time interval (in seconds)
User List
Select the Enable User List checkbox if you want to permit a list of existing users in the SAP Gateway
system to be provided for selection processes for Task Gateway. The list of existing users is provided as
input help to facilitate the selection of appropriate users to whom you can forward tasks or who you can
define as substitutes, for example.

Result and Time-Interval Driven Routing

In cases where the list is empty, you can safeguard system performance by selecting the Enable Result
and Time Driven Routing checkbox. Subsequently, enter the time interval in seconds for which you want
to ensure that no repeat service calls are to be executed.

Context Service Settings

Scenario Definition

Use

This activity allows you to define scenarios to be consumed by the Task Gateway service.

Each scenario needs to be assigned to at least one Consumer Type (e.g. Mobile, Desktop, Tablet).
WHATSAPP +255738656506
You can also specify Roles for each Consumer type and Scenario definition.

Each Scenario aggregates the Task Definition IDs and System Alias from which the Tasks source
originates.
Activities

To add a new Scenario:

1. Choose New Entries.

2. In the Scenario Identifier field, enter a key for the scenario.
3. In the Scenario Display Name field, enter a description for the scenario.
4. In the Scenario Order field, specify the scenario ranking within the Scenario List. ( Optional ).
5. In the Technical Service Name field, press F4 and select the scenario service identifier and
version. By default, the TASKPROCESSING is displayed.
6. In the EntitySet External Name field, specify the entity to which the URL navigates.
7. In the Property External Name field, define the property name of the specific entity containing
the Task Definition ID.
8. In the Default Sort by Property field, enter the property by which the application will sort the list.
( Optional ).
9. Select the MassAction checkbox to enable performing actions on several items at the same time.
(For example, mass approval.)
10. Select the QuickAct. checkbox to enable performing quick actions on an workitem directly from
the list (For example,quick approval.)
11. In the Class for Scenario Count field, enter the name of the class that implements the
/IWWRK/IF_TGW_SCENARIO interface in the SAP system.

To assign a consumer type for a scenario:

12. In the Scenario Definition table, select the row containing the desired scenario.
13. From the Dialog Structure section, double-click Assign Consumer Type to Scenario.
14. Choose New Entries.
15. In the Task Gateway Consumer Type field, press F4 and select the desired consumer type.

To assign a role to a consumer type and scenario:

16. In the Task Gateway Consumer Type table, select the row containing the desired consumer type.
17. From the Dialog Structure section, double-click Assign Role to Consumer Type and
Scenario.
18. Choose New Entries.
19. In the Role column, press F4 and select the desired role.
 To set task definition for a scenario:

20. From the Dialog Structure section, double-click Scenario Definition.

21. Select the desired scenario row.
22. From the Dialog Structure section, double-click Task Definition for Scenario.
23. Choose New Entries.
24. In the Task Type field enter the relevant task ID for the selected scenario.
25. In the SAP System Alias field, enter the source system alias for the task type. ( The Task Gateway
service should be connected to the selected system aliases.)

Registration

Provider Implementation

Use

Perform this activity to register new task providers (for example, third party task engines) for Task
Gateway. After you have registered a task provider, Task Gateway enables you to consume business
tasks that originate from this task provider.

If you work with a TCM-compliant OData provider, you do not need to perform this IMG activity. The
software version for your TCM-compliant OData provider is /IWPGW/TCM. You must enter this as the
software version when you perform the activity Manage SAP System Aliases.

You can consume the Task Gateway service with the new provider. If you do not have a UI, you can use
My Inbox or Unified Inbox. You can also view the results by navigating to the SAP Gateway Client or
any other REST clients or browsers.

Requirements

- To create a new task provider (software version):

- Open transaction SM0.
- In the Table/View field, enter /IWFND/V_COCCOL.
- Choose Maintain.
- Choose New Entries.
- Choose Type: Software Version for "Instance Manager" and insert a new identifier and
description. The new software version is just a string to enable the unique identification of the
new provider.
- The software version must be registered specifically for the Task Gateway service.
-You must implement and activate a class inheriting from the abstract class
/IWPGW/CL_TGW_TASK_FACADE_ABS. This class must implement all the task facade
methods. Depending on the support package version of component IW_PGW, you have to
define certain methods. If no actual functionality could be provided for a method, you need to
WHATSAPP +255738656506
 create an empty implementation. If you do not create an empty implementation, the provider
class cannot be activated.
- If you want to provide configuration capabilities for your provider, implement and activate a
class that inherits from the abstract class /IWPGW/CL_TGW_CFG_FACADE_ABS .If no
class is implemented, manual configuration entries are required.

Activities

To register a new task provider:

1. Choose New Entries.

2. In the relevant fields, enter:
a) Software version:
b) Technical Service Name:
c) Version:
d) Description of the task provider and the implementing class inheriting from
/IWPGW/CL_TGW_TASK_FACADE_ABS.

3. Choose Save.
To customize a new task provider:

4. Choose New Entries.

5. In the relevant fields, enter:
a) Software version: /IWPGW/<NEW PROVIDER>
b) Technical Service Name:
c) Version: Service version example: 2.
d) Description of the task provider
e) Implementing class inheriting from /IWPGW/CL_TGW_TASK_FACADE_BWF
f) Implementing class inheriting from /IWPGW/CL_TGW_CFG_FACADE_ABS
6. Choose Save.
RFC/Web Service
If your data does not reside in the same system as Task Gateway, you can use RFCs or Web services to
manipulate the data. RFCs or Web services can be called directly within each method or you can use a
backend operational proxy ( BOP ).

Unified Inbox

Unified Inbox Configuration

Use
 Configure the layout of the Unified Inbox . You can configure the appearance of the Unified Inbox and
define which fields are required and the values that are to be permitted.

You can maintain the values of the standard SAP fields and add new customer-specific fields depending
on your use case.

Activities

Maintain the field names, types, and values. Add new fields as required.

General Settings

Create BAdI Implementation to Fetch List of Users for Roles

Use

A user can get a list of roles (role user resolution) from either the backend or from the SAP
Gateway Hub system. In case the role user mapping is on SAP Gateway Hub, implement the BAdI
/IWBEP/BD_MGW_PUSH_ROL_MAP_PRV and use the class
/IWBEP/CL_MGW_PUSH_ROL_MAP_RMT as the implementation.
Standard settings

A fall-back class is delivered by SAP for the BAdI definition which would take care for role to user
resolution in the SAP backend system.

The BAdI is a single use BAdI without any filters.

Activities

The BAdI is executed by the GET_USERS_FROM_ROLE method of the utility class

/IWBEP/CL_MGW_PUSH_UTIL for fetcing the list of users for a role or list of roles.

Business Process Enablement

Process Service

Business Suite - Process Observer

Create RFC Destination

Use

WHATSAPP +255738656506
 Business Process Content powered by SAP Gateway allows you to retrieve and use process data from a
required Process Observer system, in a harmonized manner. One of the steps to achieve this is creating a
trusted RFC connection to the appropriate Process Observer system.

Activities

This activity allows you to create a trusted RFC connection to a Process Observer system.

1. Click the activity icon.

2. Choose create.
3. In the RFC Destination field, enter a name for the RFC destination you want to create.
4. In the Connection Type field, enter .
5. In the Description 1 field, enter a description for the RFC destination.
6. Press Enter.
7. Choose the Technical Settings tab page.
8. Ensure that the Load Balancing option is set to Yes.
9. Choose the Logon & Security tab page.
10. Ensure that the Trusted System option is set as Yes.
11. Enable the Current User checkbox.
12. Choose Save.
13. Choose Connection Test to test the connection.

Maintain System Alias

Use

Business Process Content powered by SAP Gateway allows you to retrieve and use process data from a
required Process Observer system, in a harmonized manner. One of the steps to achieve this is creating
system alias.

Requirements

You have created an RFC destination to the Process Observer system. For more information, see Create
RFC Destination.

Activities

This activity allows you to create a system alias for the Process Observer system.

1. Click the activity icon.

2. Choose the Display->Change button.
3. Choose New Entries.
 4. In the SAP System Alias field, enter a name for the alias.
5. In the Process Platform field, select Business Suite Process Observer Provider.
6. In the RFC Destination field, enter the RFC destination you had created.
7. Choose Save.

Process Context Service

Register Context Service for Process Definition

Use

Business Process Content powered by SAP Gateway allows you to retrieve the business context details of
a process definition in addition to the process data, from a required process provider system. To retrieve
and use context data of a process definition, you must register the process context service.

Activities

This activity allows you to register the context service for a process definition.

1. Click the activity icon.

2. Choose Create.
3. In the System Alias field, select the alias you had created.
4. Press Enter.
5. Select the process definition for which you want the system to retrieve the context details.
6. Press Enter.
7. Note down the Model/Service Name value.
8. Press Enter.
9. Choose Yes for the confirmation message.

WHATSAPP +255738656506