SAP ABAP Class CL_SWF_XI_INBOUND (XI: Inbound Processing for BPE)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-XI-IS-BPE (Application Component) Business Process Engine
     ⤷ SWF_XI_INBOUND (Package) XI: Inbound Processing for XI Messages to BPE

Properties

Class	CL_SWF_XI_INBOUND
Short Description	XI: Inbound Processing for BPE
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SWF_XI_INBOUND	XI: Inbound Processing for XI Messages to BPE
Created	20060206	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_SWF_XI_SP_MSG	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	SWFDF	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
3	SWFIB	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_SWF_XI_INBOUND has no interface implemented.

Friends

Class CL_SWF_XI_INBOUND has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_MODE_CAN_PARK	Constant	Public	☐	Type reference (TYPE)	SWFXIINBMODE	' '	XI Adapter: Inbound-Processing Mode	20060413
2	C_MODE_NO_PARK	Constant	Public	☐	Type reference (TYPE)	SWFXIINBMODE	'2'	XI Adapter: Inbound-Processing Mode	20060413
3	C_MODE_NO_PARK_OLD	Constant	Public	☐	Type reference (TYPE)	SWFXIINBMODE	'X'	XI Adapter: Inbound-Processing Mode	20060413
4	C_PF_MSECT_CORRELATION	Constant	Public	☐	Type reference (TYPE)	SWFPFMSECTID	3	Measuring Section Correlation Evaluation	20070213
5	C_PF_MSECT_DELIVERY	Constant	Public	☐	Type reference (TYPE)	SWFPFMSECTID	2	Measuring Section Message Delivery	20070213
6	C_PF_MSECT_START_PROCESS	Constant	Public	☐	Type reference (TYPE)	SWFPFMSECTID	1	Measuring Section Process Start	20070213
7	C_QMODE_CHAINING	Constant	Public	☐	Type reference (TYPE)	SWFXIINBQMODE	'3'	Multiple Queues: Chaining Semantic	20060707
8	C_QMODE_CONFIG	Constant	Public	☐	Type reference (TYPE)	SWFXIINBQMODE	'1'	A Configurable Queue	20060707
9	C_QMODE_SINGLE	Constant	Public	☐	Type reference (TYPE)	SWFXIINBQMODE	' '	A Queue	20060707
10	C_QMODE_START	Constant	Public	☐	Type reference (TYPE)	SWFXIINBQMODE	'2'	Multiple queues; start all messages	20060707
11	C_VERSION	Constant	Public	☐	Type reference (TYPE)	SWFXIINBVERSION	'0003'	Version of Inbound Processing	20060707
12	M_CRL_SETS	Instance attribute	Private	☐	Type reference (TYPE)	TT_CRL_SET		Correlations	20070124
13	M_EVENT	Instance attribute	Private	☐	Type reference (TYPE)	SIBFEVENT		Event for Message Proxy	20070124
14	M_LOG	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SWN_LOG		Application Log	20070124
15	M_MESSAGE	Instance attribute	Private	☐	Type reference (TYPE)	SIBFLPOR		XI Message-Proxy	20070124
16	M_PARKING_ALLOWED	Instance attribute	Private	☐	Type reference (TYPE)	XFLAG		Suspension of Messages Delivered by Instance Allowed	20070125
17	M_PP_DATA	Instance attribute	Private	☐	Type reference (TYPE)	SWFXIPPDATA		Application Data for Principal Propagation	20070524
18	M_QUEUE	Instance attribute	Private	☐	Type reference (TYPE)	TRFCQNAM		Queue Name	20070124
19	M_SP_DELIVERY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SWF_XI_INBOUND_SP_BPE		Service Provider	20070124
20	M_SP_MESSAGE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SWF_XI_SP_MSG		Service Provider	20070124
21	M_SP_START	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SWF_XI_INBOUND_SP_START		Service Provider	20070124
22	M_SP_WIM	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SWF_RUN_WIM_SP		Service Provider for Workitems	20080229
23	M_T100	Instance attribute	Private	☐	Type reference (TYPE)	SWF_T100MS			20070124
24	M_TASK	Instance attribute	Private	☐	Type reference (TYPE)	SWW_TASK		Process Type	20070124
25	M_TIMESTAMP	Instance attribute	Private	☐	Type reference (TYPE)	TIMESTAMPL			20070124
26	M_TSI_FACADE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_SWF_TSI			20060307
27	M_TSI_TRANSACTION	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_SWF_TSI_TRANSACTION			20070124
28	M_TSI_TRANSACTION_SAVED	Instance attribute	Private	☐	Type reference (TYPE)	XFELD			20110823
29	M_TXMGR	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SWF_RUN_TRANSACTION_MANAGER		Transaction Manager	20070124
30	M_UPDATE_STATUS	Instance attribute	Private	☐	Type reference (TYPE)	XFLAG		Update Status in Dispatch Table	20070213
31	M_USERINFO_GUID	Instance attribute	Private	☐	Type reference (TYPE)	USERINFO_GUID		Unique Identifier for Storing USERINFO Metadata	20070524

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_PRECONDITIONS	Instance method	Private	Method	Check prerequisites	20070124
2	CLEANUP	Instance method	Private	Method	Clean-Up Work in Event of Error	20070124
3	CLOSE_TRANSACTION	Instance method	Private	Method	Close Transaction	20070124
4	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20060207
5	CONTINUE_PROCESSES	Instance method	Private	Method	Continue Execution of Process Instances	20070124
6	CREATE_MESSAGE_SP	Instance method	Private	Method	Create Service Provider for Message	20070124
7	CREATE_SP_DELIVERY	Instance method	Private	Method	Service Provider for Message Delivery	20070124
8	CREATE_SP_START	Instance method	Private	Method	Service Provider to Start New Process	20070124
9	CREATE_SP_WIM	Instance method	Private	Method	Create Service Provider for WIM	20080229
10	DELIVER_MESSAGE	Instance method	Private	Method	Deliver Message to Process Instances	20070124
11	EXECUTE	Instance method	Public	Method	Deliver XI Message to Process Instances	20060207
12	GET_ACTIVE_CORRELATIONS	Instance method	Private	Method	Determine Active Correlation for Message	20070124
13	GET_ACTIVE_TRACE	Static method	Private	Method	Activates Package Trace for Package SWF_INB	20060321
14	GET_CX_MERGE_SPLIT_FROM_STACK	Instance method	Private	Method	Retrieve cx_merge_split from exception stack	20100503
15	GET_MSG_PROPERTIES	Instance method	Private	Method		20070124
16	OPEN_TRANSACTION	Instance method	Private	Method	Open Transaction	20070124
17	ROLLBACK_TRANSACTION	Instance method	Private	Method	Scroll Down Transaction	20070124
18	SET_ERROR_INFO	Instance method	Private	Method	Set Enhanced Error Information	20070124
19	SET_MSGPROCREL	Instance method	Private	Method	Write Process Instance/Message Relation	20070817
20	SET_STATUS_DELIVERED	Instance method	Private	Method	Flag Message as 'Delivered'	20070124
21	SIMULATE_EXECUTE	Instance method	Public	Method	Simulated Delivery of a Message	20060707
22	START_NEW_PROCESS	Instance method	Private	Method	Start New Process	20070124
23	UPDATE_DISPATCH_STATUS	Instance method	Private	Method	Update Message Status in Dispatch Table	20070213
24	WRITE_TRACE	Instance method	Private	Method	Write Trace Output	20070124

Events

Class CL_SWF_XI_INBOUND has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	T_MSG_PROPS	Private	See coding			20070124	BEGIN OF t_msg_props, start TYPE flag, consume TYPE flag, END OF t_msg_props

Method Signatures

Method CHECK_PRECONDITIONS Signature

Method CHECK_PRECONDITIONS on class CL_SWF_XI_INBOUND has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SWF_INBOUND_OBSOLETE	☐	Nachricht soll nicht verarbeitet werden	20070124
2	CX_SWF_INBOUND_PERMANENT	☐	Permanenter Fehler in Eingangsverarbeitung für BPE	20070124
3	CX_SWF_INBOUND_TEMPORARY	☐	Temporärer Fehler in Eingangsverarbeitung für BPE	20070124

Method CLEANUP Signature

Method CLEANUP on class CL_SWF_XI_INBOUND has no parameter.
Method CLEANUP on class CL_SWF_XI_INBOUND has no exception.

Method CLOSE_TRANSACTION Signature

Method CLOSE_TRANSACTION on class CL_SWF_XI_INBOUND has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SWF_INBOUND_PERMANENT	☐	Permanenter Fehler in Eingangsverarbeitung für BPE	20070124

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_EVENT	Value transfer	☐	Type reference (TYPE)	SIBFEVENT			20060321
2	Importing	I_MESSAGE	Value transfer	☐	Type reference (TYPE)	SIBFLPOR			20060207
3	Importing	I_PARKING_ALLOWED	Value transfer	☐	Type reference (TYPE)	XFLAG	SPACE	Message wird geparkt, falls erforderlich	20070125
4	Importing	I_PP_DATA	Value transfer	☑	Type reference (TYPE)	SWFXIPPDATA		Anwendungsdaten der Weitergabe von Benutzeridentitäten	20070524
5	Importing	I_QUEUE	Value transfer	☐	Type reference (TYPE)	TRFCQNAM		Name der qRFC-Queue	20060707
6	Importing	I_TASK	Value transfer	☐	Type reference (TYPE)	SWW_TASK			20060207
7	Importing	I_UPDATE_STATUS	Value transfer	☐	Type reference (TYPE)	XFLAG	SPACE	Status in Dispatch-Tabelle aktualisieren	20070213
8	Importing	I_USERINFO_GUID	Value transfer	☑	Type reference (TYPE)	USERINFO_GUID		Eindeutiger Identifier für die Ablage von USERINFO-Metadaten	20070524

Method CONSTRUCTOR on class CL_SWF_XI_INBOUND has no exception.

Method CONTINUE_PROCESSES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_COMPLETED_ITEMS	Call by reference	☐	Type reference (TYPE)	SWWTWIID			20070124

#	Exception	Resumable	Description	Created on
1	CX_SWF_INBOUND_PERMANENT	☐	Permanenter Fehler in Eingangsverarbeitung für BPE	20070124
2	CX_SWF_INBOUND_TEMPORARY	☐	Temporärer Fehler in Eingangsverarbeitung für BPE	20070124

Method CREATE_MESSAGE_SP Signature

Method CREATE_MESSAGE_SP on class CL_SWF_XI_INBOUND has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SWF_INBOUND_PERMANENT	☐	Permanenter Fehler in Eingangsverarbeitung für BPE	20070124

Method CREATE_SP_DELIVERY Signature

Method CREATE_SP_DELIVERY on class CL_SWF_XI_INBOUND has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SWF_INBOUND_PERMANENT	☐	Permanenter Fehler in Eingangsverarbeitung für BPE	20070124

Method CREATE_SP_START Signature

Method CREATE_SP_START on class CL_SWF_XI_INBOUND has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SWF_INBOUND_PERMANENT	☐	Permanenter Fehler in Eingangsverarbeitung für BPE	20070124

Method CREATE_SP_WIM Signature

Method CREATE_SP_WIM on class CL_SWF_XI_INBOUND has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SWF_INBOUND_PERMANENT	☐	Permanenter Fehler in Eingangsverarbeitung für BPE	20080229

Method DELIVER_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_COMPLETED_ITEMS	Call by reference	☐	Type reference (TYPE)	SWWTWIID		Workitems, die beendet wurden	20070124
2	Importing	I_CORRELATIONS	Call by reference	☐	Type reference (TYPE)	CL_SWF_XI_SP_MSG=>T_WFCRLS_T		Aktive Korrelationen	20070124

#	Exception	Resumable	Description	Created on
1	CX_SWF_XI_INBOUND	☐	Fehler in Eingangsverarbeitung für BPE	20070124

Method EXECUTE Signature

Method EXECUTE on class CL_SWF_XI_INBOUND has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SWF_INBOUND_PERMANENT	☐	Permanenter Fehler in Eingangsverarbeitung für BPE	20070220
2	CX_SWF_INBOUND_TEMPORARY	☐	Temporärer Fehler in Eingangsverarbeitung für BPE	20070220

Method GET_ACTIVE_CORRELATIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_CORRELATION_SETS	Value transfer	☐	Type reference (TYPE)	CL_SWF_XI_SP_MSG=>T_WFCRLS_T		Prozesse und aktive Korrelationen	20070124

#	Exception	Resumable	Description	Created on
1	CX_SWF_INBOUND_PERMANENT	☐	Permanenter Fehler in Eingangsverarbeitung für BPE	20070124
2	CX_SWF_INBOUND_TEMPORARY	☐	Temporärer Fehler in Eingangsverarbeitung für BPE	20070124

Method GET_ACTIVE_TRACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	TRACE_HANDLE	Call by reference	☐	Object reference (TYPE REF TO)	CL_SWF_TRC_HANDLE		Logisches Trace-Handle	20060321

Method GET_ACTIVE_TRACE on class CL_SWF_XI_INBOUND has no exception.

Method GET_CX_MERGE_SPLIT_FROM_STACK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXCEPTION	Call by reference	☐	Object reference (TYPE REF TO)	CX_SWF_IFS_EXCEPTION		Workflow Ausnahme	20100503
2	Returning	RX_MERGE_SPLIT	Value transfer	☐	Object reference (TYPE REF TO)	CX_MERGE_SPLIT		Fehler im Merge-Split-Mapping	20100503

Method GET_CX_MERGE_SPLIT_FROM_STACK on class CL_SWF_XI_INBOUND has no exception.

Method GET_MSG_PROPERTIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_MSG_PROPERTIES	Value transfer	☐	Type reference (TYPE)	T_MSG_PROPS			20070124

#	Exception	Resumable	Description	Created on
1	CX_SWF_INBOUND_PERMANENT	☐		20070124

Method OPEN_TRANSACTION Signature

Method OPEN_TRANSACTION on class CL_SWF_XI_INBOUND has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SWF_INBOUND_PERMANENT	☐	Permanenter Fehler in Eingangsverarbeitung für BPE	20070124

Method ROLLBACK_TRANSACTION Signature

Method ROLLBACK_TRANSACTION on class CL_SWF_XI_INBOUND has no parameter.
Method ROLLBACK_TRANSACTION on class CL_SWF_XI_INBOUND has no exception.

Method SET_ERROR_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_MESSAGE_ID	Call by reference	☐	Type reference (TYPE)	SXMSMGUID		XI Message-ID	20070124
2	Importing	IM_QUEUE	Call by reference	☐	Type reference (TYPE)	TRFCQNAM		Queue-Name	20070124
3	Importing	IM_T100	Value transfer	☐	Type reference (TYPE)	SWF_T100MS		Struktur für T100 Meldung	20070124
4	Importing	IM_TRACE_ID	Value transfer	☐	Type reference (TYPE)	SWFTRACEID		ID des geschriebenen Trace-Eintrags	20070124

Method SET_ERROR_INFO on class CL_SWF_XI_INBOUND has no exception.

Method SET_MSGPROCREL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_PROCESS_INSTANCES	Call by reference	☐	Type reference (TYPE)	SWWTWIID		Workflow: Tabelle mit Workitem-Ids	20070817
2	Importing	IM_TIMESTAMP	Call by reference	☑	Type reference (TYPE)	TIMESTAMPL		UTC-Zeitstempel in Langform (JJJJMMTThhmmssmmmuuun)	20070820

#	Exception	Resumable	Description	Created on
1	CX_SWF_TSI	☐	TSI: Ausnahme	20070817

Method SET_STATUS_DELIVERED Signature

Method SET_STATUS_DELIVERED on class CL_SWF_XI_INBOUND has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SWF_INBOUND_PERMANENT	☐	Permanenter Fehler in Eingangsverarbeitung für BPE	20070124

Method SIMULATE_EXECUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_COMPLETED_ITEMS	Call by reference	☐	Type reference (TYPE)	SWWTWIID		Durch Nachricht beendete Empfangsschritte	20060707
2	Exporting	EX_CORRELATIONS	Call by reference	☐	Type reference (TYPE)	CL_SWF_XI_SP_MSG=>T_WFCRLS_T		Verwendete Korrelationsinstanzen	20060707
3	Exporting	EX_FLOWS_PARKED_AT	Call by reference	☐	Type reference (TYPE)	SWWTWIID		Prozessinstanzen, an denen Message geparkt wird	20070125
4	Exporting	EX_START_NEW_INSTANCE	Call by reference	☐	Type reference (TYPE)	XFLAG		Würde eine neue Instanz gestartet?	20060707
5	Exporting	EX_T100_MSG	Call by reference	☐	Type reference (TYPE)	SWF_T100MS		T100-Meldung, die erzeugt werden würde	20060707

Method SIMULATE_EXECUTE on class CL_SWF_XI_INBOUND has no exception.

Method START_NEW_PROCESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_FLOWITEM	Call by reference	☐	Object reference (TYPE REF TO)	IF_SWF_RUN_WIM_INTERNAL			20080229
2	Exporting	EX_RESULT	Call by reference	☐	Object reference (TYPE REF TO)	CL_SWF_RUN_RESULT			20080229

#	Exception	Resumable	Description	Created on
1	CX_SWF_INBOUND_PERMANENT	☐	Permanenter Fehler in Eingangsverarbeitung für BPE	20070124

Method UPDATE_DISPATCH_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_INB_START_TS	Value transfer	☑	Type reference (TYPE)	TIMESTAMPL		UTC-Zeitstempel in Langform (JJJJMMTThhmmssmmmuuun)	20070315
2	Importing	IM_MSGPROCREL	Value transfer	☐	Type reference (TYPE)	SWFXIINBMSGPROCREL	SPACE		20070301
3	Importing	IM_PP_STATUS	Value transfer	☑	Type reference (TYPE)	SWFXIINBPPSTATUS			20070604
4	Importing	IM_PROCESS_ID	Value transfer	☑	Type reference (TYPE)	SWW_WIID			20070301
5	Importing	IM_STATUS	Value transfer	☐	Type reference (TYPE)	SWFXIDISPSTATUS			20070213

Method UPDATE_DISPATCH_STATUS on class CL_SWF_XI_INBOUND has no exception.

Method WRITE_TRACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXCEPTION	Call by reference	☑	Object reference (TYPE REF TO)	CX_SWF_IFS_EXCEPTION		Workflow Ausnahme	20070124
2	Importing	SINGLE_TRACES	Call by reference	☑	Type reference (TYPE)	XFLAG	''	'X' schreibe Attribute einzeln; '' schreibe gemeinsam	20070124
3	Returning	TRACE_ID	Value transfer	☐	Type reference (TYPE)	SWFTRACEID		ID des verwendeten Trace	20070124

Method WRITE_TRACE on class CL_SWF_XI_INBOUND has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	640