Receiver Type Function Module (SAP Library

Receiver Type Function Module

Definition

Function module for establishing the receiver type.

Use

It is possible that there is to be a receiver type, but that it cannot be established until runtime from the information accompanying the event. It is therefore possible to call a receiver type function module to evaluate the event container and determine the receiver type.

A workflow is to be started in response to an event.

The receiver function module is the generic function module for starting workflows, which expects the ID of the workflow task to be started as an input parameter in the receiver type.

The ID may not be known when the linkage is entered. This may be the case if the ID of the workflow task to be started depends on information from the event-creating application (for example an amount).

The relevant information is located in the event container. The ID of the workflow task is then determined by the receiver type function module evaluating the event container.

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

Structure

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

Import parameters
OBJTYPE	SWETYPECOU-OBJTYPE	Type of 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	SWETYPECOU-EVENT	ID of event The event must be defined for the triggering object type.
GENERIC_RECTYPE	SWETYPECOU-RECTYPE	Receiver type. The receiver type, if entered, is passed to the receiver type function module. Its value, however, is overwritten by the export parameter RECTYPE of the receiver type function module.
Export parameters
RECTYPE	SWETYPECOU-RECTYPE	Receiver type Result of the evaluation by the receiver type function module.
Table parameters
EVENT_CONTAINER	SWCONT	Persistent event container of the event.

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

Integration

The evaluation of the event container with the aim of establishing the receiver type is performed in the receiver type function module.

This function module is called provided it is entered in the type linkage table. It returns the receiver type established. The check and receiver function modules are then called with this receiver type.