Receiver Function Module (SAP Library

Receiver Function Module

Definition

Function module with defined interface for receiving events.

The event manager calling the receiver function module initiates the event receiver’s reaction to the event.

Use

The container passed in the interface of the function module is read with macro instructions provided. If object references were passed in the container, they must first be converted into runtime handles.

For further information and a full list of all macro instructions, refer to:

Macro Instructions for Processing a Container Instance in a Program.

Macro Instructions for Accessing Objects, Attributes, and Methods

The workflow system uses the following function modules as standard:

Function module	Use
SWW_WI_CREATE_VIA_EVENT	Is entered for triggering events.
SWW_WI_COMP_EVENT_RECEIVE	Is entered for terminating events.
SWW_EI_EVENT_RECEIVE	Is entered for wait steps.

Structure

The interface of the receiver function module is described with the following parameters:

Import parameters
OBJTYPE	SWETYPECOU-OBJTYPE	Type of the triggering object.
OBJKEY	SWEINSTCOU-OBJKEY	Concatenated, object type-specific key of the triggering object. The reference to the triggering object is created internally from this information and written to the event container under the element ID _Evt_Object .
EVENT	SWEINSTCOU-EVENT	ID of the event. The event must be defined for the triggering object type.
RECTYPE	SWETYPECOU-RECTYPE	Receiver type.
Table parameters
EVENT_CONTAINER	SWCONT	Persistent event container of the event.

There is a template function module for receiver function modules ( SWE_CD_TEMPLATE_REC_FB ) in the function group SWE_TEMPLATE .

Integration

The receiver function module must be provided by the potential event receiver. The interface of this function module is standard and predefined.

The receiver function module expects the ID of the event, the event container and the name of the receiver type as input parameters. Return parameters are not passed by the receiver function module.

Return parameters and exceptions cannot be passed by the receiver function module. In addition, it cannot initiate exceptions (error messages and warnings) which lead to the function module being aborted.

The receiver function module must be flagged as RFC-enabled.