SAP ABAP Class CL_POC_LOG_MANAGER (Log Manager)

Hierarchy

☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ CA-EPT-POC (Application Component) Process Orchestration for Built-In Processes
     ⤷ BS_POC_MAIN (Package) Process Orchestration - Runtime

Properties

Class	CL_POC_LOG_MANAGER
Short Description	Log Manager
Super Class
Instantiability of a Class	0	Private
Final	☐

General Data

Message Class
Program status
Category	0
Package	BS_POC_MAIN	Process Orchestration - Runtime
Created	20100428	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	IF_FDT_TYPES	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
3	IF_POC_MAIN_C	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_POC_LOG_MANAGER has no interface implemented.

Friends

Class CL_POC_LOG_MANAGER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GO_LOG_MANAGER	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_POC_LOG_MANAGER		Log Manager	20100428
2	MO_APPL_LOG	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_POC_APPLICATION_LOG		Application Log	20101130
3	MT_PRC_BINDING_LOG	Instance attribute	Private	☐	Type reference (TYPE)	T_PROCESS_BINDING_LOG		Process/Activity Log Details	20110818
4	MV_BA_CREATION_LIMIT	Instance attribute	Private	☐	Type reference (TYPE)	TZNTSTMPL		BA Creation Limit in Seconds	20100901

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_RELATED_TASK_EXISTENCE	Instance method	Private	Method	Check related task existence	20110822
2	CONSTRUCTOR	Instance method	Private	Constructor	CONSTRUCTOR	20100809
3	CREATE_LOG_ENTRIES	Instance method	Public	Method	Creates a Log Entry(ies)	20100428
4	CREATE_METRICS_LOG_ENTRIES	Instance method	Private	Method	Create the Log Entries for METRICS Engine	20100628
5	GET_DATA	Instance method	Public	Method	Get BA Log Data	20100616
6	GET_INSTANCE	Static method	Public	Method	Gets an Instance	20100428
7	INSERT_LOG_ENTRIES	Instance method	Private	Method	Insert Log Entries in to the BA Log	20100712
8	MAP_PRC_STATUS2SYS_STATUS	Instance method	Private	Method	Maps a Process Status to System Status	20100716
9	PROCESS_STATUS_CHECK	Instance method	Private	Method	Process Status Check with rule processing	20120120
10	RETRIEVE_BINDINGS_FROM_DB	Instance method	Private	Method	Retrieve BA's from DB	20101019
11	SET_LOCAL_BUFFER_DATA	Instance method	Private	Method	Set local buffer data	20101026
12	SET_STATUS	Instance method	Public	Method	Set Process Status and System Status for a Process	20100719
13	SET_SYSTEM_STATUS_PROCESS	Instance method	Private	Method	Set System Status for a Process	20100716

Events

Class CL_POC_LOG_MANAGER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	S_PRE_BA	Protected	See coding			20100528	BEGIN OF s_pre_ba, ba_id TYPE poc_ba_id, process_id TYPE poc_process_id, process_step_id TYPE poc_process_step_id, process_start TYPE poc_process_start, bo_id TYPE poc_bo_id, item_id TYPE poc_item_id, ** BA Log timestamp TYPE timestampl, ba_type TYPE poc_ba_type, bo_type TYPE poc_bo_type, cbe_category TYPE poc_cbe_category, cbe_type TYPE poc_cbe_type, transaction_id TYPE poc_transaction_id, ** Previous BA pre_ba_id TYPE poc_ba_id, pre_bo_id TYPE poc_bo_id, pre_item_id TYPE poc_item_id, pre_bo_type TYPE poc_bo_type, END OF s_pre_ba
2	S_PROCESS_BINDING_LOG	Protected	See coding			20100429	BEGIN OF s_process_binding_log, ba_id TYPE poc_ba_id, process_id TYPE poc_process_id, process_step_id TYPE poc_process_step_id, process_start TYPE poc_process_start, ** Process Instance process_type_id TYPE poc_process_type_id, process_version TYPE poc_process_version, process_status TYPE poc_process_status, prc_sys_status TYPE poc_process_system_status, ** Process Step Instance pro_step_type_id TYPE poc_process_step_type_id, ** BA Log timestamp TYPE timestampl, ba_type TYPE poc_ba_type, bo_type TYPE poc_bo_type, bo_id TYPE poc_bo_id, item_id TYPE poc_item_id, cbe_category TYPE poc_cbe_category, cbe_type TYPE poc_cbe_type, transaction_id TYPE poc_transaction_id, prc_end_date_tim TYPE poc_process_end_time, changed_at TYPE poc_changed_time, END OF s_process_binding_log
3	T_PRE_BA	Protected	See coding			20100528	t_pre_ba TYPE STANDARD TABLE OF s_pre_ba
4	T_PROCESS_BINDING_LOG	Protected	See coding			20100429	t_process_binding_log TYPE STANDARD TABLE OF s_process_binding_log

Method Signatures

Method CHECK_RELATED_TASK_EXISTENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_RELATED_TASK_FOUND	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Related Task Exists(X= TRUE) or (''= FALSE)	20110822
2	Importing	IS_BA	Call by reference	☐	Type reference (TYPE)	POC_S_BA_DATA		Task Data	20110822
3	Importing	IS_PROC_DEF	Call by reference	☐	Type reference (TYPE)	POC_S_PROC_DEF_PRE_BO		Process Definition and Previous Business Object	20110822
4	Importing	IV_PROCESS_ID	Call by reference	☐	Type reference (TYPE)	POC_PROCESS_ID		Process ID	20110822

Method CHECK_RELATED_TASK_EXISTENCE on class CL_POC_LOG_MANAGER has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_POC_LOG_MANAGER has no parameter.
Method CONSTRUCTOR on class CL_POC_LOG_MANAGER has no exception.

Method CREATE_LOG_ENTRIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_BA	Call by reference	☐	Type reference (TYPE)	POC_T_BA		Business Activities	20100428
2	Importing	IT_PROCESS_HEADER_BAREA	Call by reference	☐	Type reference (TYPE)	POC_T_BUS_AREA		Process Header	20110118
3	Importing	IT_PROC_DEF	Call by reference	☐	Type reference (TYPE)	POC_T_PROC_DEF_PRE_BO		Process Definition and Pre BO	20100429

Method CREATE_LOG_ENTRIES on class CL_POC_LOG_MANAGER has no exception.

Method CREATE_METRICS_LOG_ENTRIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_KPI_ACT_INS	Call by reference	☑	Type reference (TYPE)	POC_T_KPI_ACT		KPI Activity Log	20110819
2	Importing	IT_KPI_LOG_INS	Call by reference	☑	Type reference (TYPE)	POC_T_KPI_LOG		KPI Log Entry	20110819
3	Importing	IT_KPI_LOG_UPD	Call by reference	☑	Type reference (TYPE)	POC_T_KPI_LOG		KPI Log Entry	20110819

Method CREATE_METRICS_LOG_ENTRIES on class CL_POC_LOG_MANAGER has no exception.

Method GET_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_BA_DETAILS	Call by reference	☐	Type reference (TYPE)	POC_T_BA_DETAILS		Business Activities and their details	20100616
2	Exporting	ET_BA_TEXT	Call by reference	☐	Type reference (TYPE)	POC_T_BA_T		Table type for Task Definition Description	20100928
3	Exporting	ET_BA_TYPE_TEXT	Call by reference	☐	Type reference (TYPE)	POC_T_BA_TYPE_TEXT		Business Activity Text	20100921
4	Exporting	ET_BO_TYPE_TEXT	Call by reference	☐	Type reference (TYPE)	POC_T_BO_TYPE_TEXT		Business Object Type Text	20100921
5	Exporting	ET_CBE_TEXT	Call by reference	☐	Type reference (TYPE)	POC_T_CBE_TEXT		Callable Business Entity Text	20100921
6	Exporting	ET_PRC_BA_BIND_DETAILS	Call by reference	☐	Type reference (TYPE)	POC_T_BIND_DETAILS		Process to Business Activities Binding Details	20100616
7	Exporting	ET_PRE_BA_DETAILS	Call by reference	☐	Type reference (TYPE)	POC_T_PRE_BA_DETAILS		Previous/Predecessor Business Activities and their Details	20100616
8	Exporting	ET_PROCESS_STATUS_TEXT	Call by reference	☐	Type reference (TYPE)	POC_T_PRC_STATUS_TEXT		Process Status Text	20100921
9	Exporting	ET_PROCESS_STEP_TEXT	Call by reference	☐	Type reference (TYPE)	POC_T_PROCESS_STEP_TEXT		Process Step Text	20100921
10	Exporting	ET_PROCESS_TEXT	Call by reference	☐	Type reference (TYPE)	POC_T_PROCESS_TEXT		Process Text	20100921
11	Importing	IS_PARAMETERS	Call by reference	☑	Type reference (TYPE)	POC_S_BA_LOG_PARAMS		BA Log Parameters	20100616
12	Importing	IV_READ_ALL_STEPS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Read all steps of the result process instances	20101004
13	Importing	IV_TEXTS_REQUIRED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	(=X)TRUE if texts are required else(=' ')False	20100921

Method GET_DATA on class CL_POC_LOG_MANAGER has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_LOG_MANAGER	Call by reference	☐	Object reference (TYPE REF TO)	CL_POC_LOG_MANAGER		Log Manager	20100428

Method GET_INSTANCE on class CL_POC_LOG_MANAGER has no exception.

Method INSERT_LOG_ENTRIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_BA	Call by reference	☐	Type reference (TYPE)	POC_T_BA		Tasks	20100714
2	Importing	IT_BA_LOG	Call by reference	☐	Type reference (TYPE)	POC_T_BA_LOG_DB		Task Log	20100712
3	Importing	IT_BA_SOURCE_SYSTEM	Call by reference	☐	Type reference (TYPE)	POC_T_BA_SRCSYS_DB		Source System for a Task/Event	20110713
4	Importing	IT_PRE_BA	Call by reference	☐	Type reference (TYPE)	POC_T_PRE_BA_DB		Previous/Predecessor Tasks	20100712
5	Importing	IT_PROCESS_BINDING	Call by reference	☐	Type reference (TYPE)	POC_T_PRC_BIND_DB		Process Binding	20100712
6	Importing	IT_PROCESS_HEADER	Call by reference	☐	Type reference (TYPE)	POC_T_BUS_AREA		Process Header	20110117
7	Importing	IT_PROCESS_INSTANCE	Call by reference	☐	Type reference (TYPE)	POC_T_PRC_IN_DB		Process Instance	20100712
8	Importing	IT_PROCESS_STEP_INSTANCE	Call by reference	☐	Type reference (TYPE)	POC_T_PRC_STP_IN_DB		Process Activity Instances	20100712

Method INSERT_LOG_ENTRIES on class CL_POC_LOG_MANAGER has no exception.

Method MAP_PRC_STATUS2SYS_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_ERROR_OCCURED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		if error then TRUE(=X) else FALSE(='')	20100809
2	Exporting	EV_PROCESS_SYSTEM_STATUS	Call by reference	☐	Type reference (TYPE)	POC_PROCESS_SYSTEM_STATUS		System Status for Process	20100716
3	Importing	IV_PROCESS_STATUS	Call by reference	☐	Type reference (TYPE)	POC_PROCESS_STATUS		Process Status	20100716
4	Importing	IV_PROCESS_TYPE_ID	Call by reference	☐	Type reference (TYPE)	POC_PROCESS_TYPE_ID		Process Definition ID	20110602

Method MAP_PRC_STATUS2SYS_STATUS on class CL_POC_LOG_MANAGER has no exception.

Method PROCESS_STATUS_CHECK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_PROCESS_STATUS_EXIST	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		=X if Rule ID is provided else =space	20120120
2	Importing	IV_USER_STATUS_BINDING_RULE	Call by reference	☐	Type reference (TYPE)	POC_STAT_BRF_RULE_ID		Status Rule ID	20120120

Method PROCESS_STATUS_CHECK on class CL_POC_LOG_MANAGER has no exception.

Method RETRIEVE_BINDINGS_FROM_DB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_BINDING_LOG	Call by reference	☐	Type reference (TYPE)	T_PROCESS_BINDING_LOG			20101019
2	Importing	IV_BO_ID	Call by reference	☐	Type reference (TYPE)	POC_BO_ID		Business Object Instance ID	20101019
3	Importing	IV_BO_TYPE	Call by reference	☐	Type reference (TYPE)	POC_BO_TYPE		Business Object Type	20101019
4	Importing	IV_ITEM_ID	Call by reference	☑	Type reference (TYPE)	POC_ITEM_ID		Item ID	20111206
5	Importing	IV_PROCESS_TYPE_ID	Call by reference	☐	Type reference (TYPE)	POC_PROCESS_TYPE_ID		Process Definition ID	20101019
6	Importing	IV_PROCESS_VERSION	Call by reference	☐	Type reference (TYPE)	POC_PROCESS_VERSION		Process Version	20101019

Method RETRIEVE_BINDINGS_FROM_DB on class CL_POC_LOG_MANAGER has no exception.

Method SET_LOCAL_BUFFER_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_PRC_BINDING_LOG	Call by reference	☐	Type reference (TYPE)	T_PROCESS_BINDING_LOG		Process/Activity Log Details	20101026
2	Importing	IS_BA_LOG	Call by reference	☐	Type reference (TYPE)	POC_D_BA_LOG		Task Log Header	20101026
3	Importing	IS_PRC_BINDING	Call by reference	☐	Type reference (TYPE)	POC_D_PRC_BIND		Task Log Process Binding	20101026
4	Importing	IS_PRC_IN	Call by reference	☐	Type reference (TYPE)	POC_D_PRC_IN		Task Log Process Instance	20101026
5	Importing	IS_PRC_STEP_IN	Call by reference	☐	Type reference (TYPE)	POC_D_PRC_STP_IN		Task Log Process Step Instance	20101026

Method SET_LOCAL_BUFFER_DATA on class CL_POC_LOG_MANAGER has no exception.

Method SET_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_NEW_PRC_STATUS	Call by reference	☐	Type reference (TYPE)	POC_PROCESS_STATUS		New Process Status	20100719
2	Exporting	EV_NEW_SYSTEM_PRC_STATUS	Call by reference	☐	Type reference (TYPE)	POC_PROCESS_SYSTEM_STATUS		New System Status for Process	20100719
3	Exporting	EV_RULE_PROCESSED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		TRUE(=X) if rule processed else False(='')	20100719
4	Importing	IO_BADI_STATUS_DET	Call by reference	☑	Object reference (TYPE REF TO)	POC_MAIN_PROCESS_STATUS		Reference to Status BAdI Instance	20120322
5	Importing	IT_ACT_TASK_NOT_LOGGED	Call by reference	☑	Type reference (TYPE)	POC_T_RB_PROC_STEP		Not yet Logged Activity/Task details	20121128
6	Importing	IV_BA_ID	Call by reference	☑	Type reference (TYPE)	POC_BA_ID		Task Instance ID	20120903
7	Importing	IV_CURRENT_PRC_STATUS	Call by reference	☐	Type reference (TYPE)	POC_PROCESS_STATUS		Current Process Status	20100719
8	Importing	IV_CURRENT_PRC_SYSTEM_STATUS	Call by reference	☐	Type reference (TYPE)	POC_PROCESS_SYSTEM_STATUS		Current System Status for a Process	20100719
9	Importing	IV_PROCESS_END	Call by reference	☐	Type reference (TYPE)	POC_PROCESS_END		Process End Flag	20100719
10	Importing	IV_PROCESS_ID	Call by reference	☑	Type reference (TYPE)	POC_PROCESS_ID		Process ID	20120903
11	Importing	IV_PROCESS_START	Call by reference	☐	Type reference (TYPE)	POC_PROCESS_START		Process Start Flag	20100719
12	Importing	IV_PROCESS_STATUS_EXIST	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Customer defined Process Status Exists	20100719
13	Importing	IV_PROCESS_STEP_ID	Call by reference	☑	Type reference (TYPE)	POC_PROCESS_STEP_ID		Activity Instance ID	20120903
14	Importing	IV_PROCESS_STEP_TYPE_ID	Call by reference	☐	Type reference (TYPE)	POC_PROCESS_STEP_TYPE_ID		Process Step Type ID	20100719
15	Importing	IV_PROCESS_TYPE_ID	Call by reference	☐	Type reference (TYPE)	POC_PROCESS_TYPE_ID		Process Type ID	20100719
16	Importing	IV_PROCESS_VERSION	Call by reference	☐	Type reference (TYPE)	POC_PROCESS_VERSION		Process Version	20100719

Method SET_STATUS on class CL_POC_LOG_MANAGER has no exception.

Method SET_SYSTEM_STATUS_PROCESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_NEW_PRC_SYSTEM_STATUS	Call by reference	☐	Type reference (TYPE)	POC_PROCESS_SYSTEM_STATUS		New System Status for Process	20100716
2	Importing	IV_CURRENT_PRC_SYSTEM_STATUS	Call by reference	☐	Type reference (TYPE)	POC_PROCESS_SYSTEM_STATUS		Current System Status for Process	20100716
3	Importing	IV_PROCESS_END	Call by reference	☐	Type reference (TYPE)	POC_PROCESS_END		Process End Flag	20100716
4	Importing	IV_PROCESS_START	Call by reference	☐	Type reference (TYPE)	POC_PROCESS_START		Process Start Flag	20100716

Method SET_SYSTEM_STATUS_PROCESS on class CL_POC_LOG_MANAGER has no exception.

History

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