SAP ABAP Class CL_POC_PROCESS_ACCESS (Process instance access class)

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_PROCESS_ACCESS
Short Description	Process instance access class
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	20101210	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_POC_MAIN_C	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_POC_PROCESS_ACCESS has no interface implemented.

Friends

Class CL_POC_PROCESS_ACCESS has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GO_PROCESS_ACCESS	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_POC_PROCESS_ACCESS		Process instance access class	20101210
2	GT_PROC_INSTANCES	Static Attribute	Private	☐	Type reference (TYPE)	POC_T_PRC_INSTANCES		Process Instances	20110214

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_BSANLY_MESSAGE_TO_APPL_LOG	Instance method	Private	Method		20101221
2	CHECK_STEP_INST_OCCURANCE	Instance method	Private	Method	check step instance occurance	20111027
3	CONSTRUCTOR	Instance method	Private	Constructor		20101210
4	DETERMINE_EXT_EVT_SRCSYS	Instance method	Private	Method	Determines source system info for external events	20110726
5	DETERMINE_KPI_STATUS	Instance method	Private	Method	Determines the kpi_status for given KPI's	20110721
6	GET_ACTIVITIES	Instance method	Public	Method	Get the Business activities	20110926
7	GET_FEDERATED_PROCESS	Instance method	Public	Method	Search for local / federated process instances	20101215
8	GET_INSTANCE	Static method	Public	Method	Get instance of this class	20101210
9	GET_INSTANCE_INFO	Instance method	Public	Method	Gets the Instance information given the BO ID	20121130
10	GET_KPIS	Instance method	Public	Method	Get the KPIs	20120503
11	GET_LOCAL_PROCESS	Instance method	Public	Method	Search for local process instances	20101210
12	GET_PROCESS_DATA	Instance method	Public	Method	Gets the Process Data : Activities and KPIs	20121108
13	GET_STEP_INSTANCES	Instance method	Public	Method	Get the process step instances	20110927
14	PRC_DEF_ID_WITH_KPI_THR	Instance method	Private	Method	Process Def Id's with KPI Threshold maintained	20110716
15	PRC_INSTANCE_WITH_KPI_THR	Instance method	Private	Method	Process instances with KPI Threshold maintained	20110715
16	READ_PROCESS_DETAILS	Instance method	Private	Method	Read process instance details	20101213
17	VALIDATE_SEARCH_CRITERIA	Instance method	Private	Method	Validates the search criteria	20110105

Events

Class CL_POC_PROCESS_ACCESS has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	S_INSTANCE_INFO	Public	See coding			20121130	BEGIN OF s_instance_info, process_id TYPE poc_process_id, process_type_id TYPE poc_process_type_id, process_version TYPE poc_process_version, process_type_name TYPE poc_proc_typ_name_100, start_time TYPE poc_time, start_date TYPE poc_date, start_ba_name TYPE poc_ba_name, start_bo_id TYPE poc_bo_id, END OF s_instance_info
2	T_INSTANCE_INFO	Public	See coding			20121130	t_instance_info TYPE TABLE OF s_instance_info

Method Signatures

Method ADD_BSANLY_MESSAGE_TO_APPL_LOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_MESSAGES	Call by reference	☐	Type reference (TYPE)	POC_T_APPL_LOG_MSG		Application Log Message Data	20101221
2	Importing	IT_MESSAGES	Call by reference	☐	Type reference (TYPE)	BSANLY_T_MESSAGE		Analytics: Messages	20101221

Method ADD_BSANLY_MESSAGE_TO_APPL_LOG on class CL_POC_PROCESS_ACCESS has no exception.

Method CHECK_STEP_INST_OCCURANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_KPI_VALUES	Call by reference	☑	Type reference (TYPE)	POC_S_KPI_VALUES		KPI: Count	20111116
2	Importing	IT_PROCESS_STEP_INSTANCE	Call by reference	☐	Type reference (TYPE)	POC_T_STP_INSTANCE_EXT		POC Step instance ext	20111027
3	Importing	IV_BA_TYPE	Call by reference	☐	Type reference (TYPE)	POC_BA_TYPE		Task Type ID	20111027
4	Importing	IV_BO_TYPE	Call by reference	☐	Type reference (TYPE)	POC_BO_TYPE		Business Object Type	20111027
5	Importing	IV_IS_ITEM	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL		Item flag	20111116
6	Importing	IV_PROCESS_ID	Call by reference	☐	Type reference (TYPE)	POC_PROCESS_ID		Process ID	20111027
7	Importing	IV_PROCESS_TYPE_ID	Call by reference	☐	Type reference (TYPE)	POC_PROCESS_TYPE_ID		Process Definition ID	20111027
8	Importing	IV_PROCESS_VERSION	Call by reference	☐	Type reference (TYPE)	POC_PROCESS_VERSION		Process Version	20111027
9	Importing	IV_PS_TYPE_ID	Call by reference	☐	Type reference (TYPE)	POC_PROCESS_STEP_TYPE_ID		Activity Definition ID	20111027
10	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20111027

Method CHECK_STEP_INST_OCCURANCE on class CL_POC_PROCESS_ACCESS has no exception.

Method CONSTRUCTOR Signature

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

Method DETERMINE_EXT_EVT_SRCSYS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_PROCESS_STEP_INSTANCE	Call by reference	☐	Type reference (TYPE)	POC_T_PRC_LOG		Process Log	20110726
2	Importing	IT_PROCESS_INSTANCES	Call by reference	☐	Type reference (TYPE)	POC_T_PRC_INSTANCES		Process Instances	20110726

Method DETERMINE_EXT_EVT_SRCSYS on class CL_POC_PROCESS_ACCESS has no exception.

Method DETERMINE_KPI_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_KPI_VALUES	Call by reference	☐	Type reference (TYPE)	POC_T_KPI_VALUES		KPI details	20110721
2	Importing	IT_PROCESS_INSTANCES	Call by reference	☐	Type reference (TYPE)	POC_T_PRC_INSTANCES		Process Instances	20110721
3	Importing	IT_PROCESS_STEP_INSTANCE	Call by reference	☐	Type reference (TYPE)	POC_T_STP_INSTANCE_EXT		Activity Instance	20110721

Method DETERMINE_KPI_STATUS on class CL_POC_PROCESS_ACCESS has no exception.

Method GET_ACTIVITIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_PARAMETERS	Call by reference	☑	Type reference (TYPE)	POC_S_PROCESS_ACCESS		Task Log Parameters	20110926
2	Importing	IV_MAX_HITS	Call by reference	☐	Type reference (TYPE)	I	100		20110926

Method GET_ACTIVITIES on class CL_POC_PROCESS_ACCESS has no exception.

Method GET_FEDERATED_PROCESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_KPI_DATA	Call by reference	☐	Type reference (TYPE)	POC_T_KPI_VALUES		KPI details	20101215
2	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	POC_T_APPL_LOG_MSG		Application Log Message Data	20101215
3	Exporting	ET_PRC_INSTANCES	Call by reference	☐	Type reference (TYPE)	POC_T_PRC_INSTANCES		Process Instances	20101215
4	Exporting	ET_PRC_STEP_INSTANCES	Call by reference	☐	Type reference (TYPE)	POC_T_PRC_LOG		Process Log / Process step instances	20101215
5	Exporting	ET_PRE_BA_INSTANCES	Call by reference	☐	Type reference (TYPE)	POC_T_PRE_BA_DETAILS		Previous/Predecessor Task	20110208
6	Exporting	ET_VERIFIED_PR_INTR_POINTS	Call by reference	☐	Type reference (TYPE)	POC_T_VERIFIED_PR_INTR_POINTS		Verified Process Integration Points	20101215
7	Importing	IS_PARAMETERS	Call by reference	☑	Type reference (TYPE)	POC_S_PROCESS_ACCESS		Search parameters	20101215
8	Importing	IV_E2E_PROCESS_DEF_ID	Call by reference	☑	Type reference (TYPE)	POC_E2E_PROC_DEF_ID		Realized Process Chain Definition ID	20111117
9	Importing	IV_GET_ACTIVITIES	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Flag: Whether to read process step details	20101215
10	Importing	IV_GET_FEDERATED_LOGS	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Flag: Whether to get logs for connected processes	20101215
11	Importing	IV_GET_KPIS	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Flag: Whether to read KPIs	20101215
12	Importing	IV_MAX_HITS	Call by reference	☐	Type reference (TYPE)	I	100	Maximum number of results	20101215
13	Importing	IV_PRE_BA_REQ	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Flag:Whether to get PRE BA instances	20110208
14	Importing	IV_READ_TEXTS	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Flag: Whether to read descriptions	20101215
15	Importing	IV_SORT	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Flag: Whether to get most recent process instances in result	20101215
16	Importing	IV_START_LOGSYS	Call by reference	☑	Type reference (TYPE)	POC_LOGSYS		Logical System ID on which to perform the search	20101215

Method GET_FEDERATED_PROCESS on class CL_POC_PROCESS_ACCESS has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_PROCESS_ACCESS	Call by reference	☐	Object reference (TYPE REF TO)	CL_POC_PROCESS_ACCESS		Process instance access class	20101210

Method GET_INSTANCE on class CL_POC_PROCESS_ACCESS has no exception.

Method GET_INSTANCE_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_INSTANCE_INFO	Call by reference	☐	Type reference (TYPE)	T_INSTANCE_INFO		Instance Information	20121130
2	Importing	IV_BO_ID	Call by reference	☐	Type reference (TYPE)	POC_BO_ID		Business Object ID	20121130
3	Importing	IV_BO_TYPE	Call by reference	☐	Type reference (TYPE)	POC_BO_TYPE		Business Object Type	20121130

Method GET_INSTANCE_INFO on class CL_POC_PROCESS_ACCESS has no exception.

Method GET_KPIS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_KPI_DATA	Call by reference	☐	Type reference (TYPE)	POC_T_KPI_VALUES		table type : KPI values	20120504
2	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	POC_T_APPL_LOG_MSG		Application Log Message Data	20120504
3	Importing	IS_PARAMETERS	Call by reference	☑	Type reference (TYPE)	POC_S_PROCESS_ACCESS		Task Log Parameters	20120503
4	Importing	IV_CHECK_AUTHORITY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20120503
5	Importing	IV_MAX_HITS	Call by reference	☐	Type reference (TYPE)	I	100		20120503

Method GET_KPIS on class CL_POC_PROCESS_ACCESS has no exception.

Method GET_LOCAL_PROCESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_KPI_DATA	Call by reference	☐	Type reference (TYPE)	POC_T_KPI_VALUES		KPI details	20101210
2	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	POC_T_APPL_LOG_MSG		Application Log Message Data	20101216
3	Exporting	ET_PRC_INSTANCES	Call by reference	☐	Type reference (TYPE)	POC_T_PRC_INSTANCES		Process Instances	20101210
4	Exporting	ET_PRC_STEP_INSTANCES	Call by reference	☐	Type reference (TYPE)	POC_T_PRC_LOG		Process Log / Process step instances	20101210
5	Exporting	ET_PRE_BA_INSTANCES	Call by reference	☐	Type reference (TYPE)	POC_T_PRE_BA_DETAILS		Previous/Predecessor Task	20110208
6	Importing	IS_PARAMETERS	Call by reference	☑	Type reference (TYPE)	POC_S_PROCESS_ACCESS		Search parameters	20101210
7	Importing	IV_CHECK_AUTHORITY	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_TRUE	Flag: Whether to carry out authorization checks	20101210
8	Importing	IV_GET_ACTIVITIES	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Flag: Whether to read process step details	20101210
9	Importing	IV_GET_KPIS	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Flag: Whether to read KPIs	20101210
10	Importing	IV_MAX_HITS	Call by reference	☐	Type reference (TYPE)	I	100	Maximum number of results	20101210
11	Importing	IV_POC_USER_ACTIVITY	Call by reference	☐	Type reference (TYPE)	POC_AUTH_ACTIVITY	IF_POC_MAIN_C=>GS_POC_AUTH_ACTIVITY-POC_AUTH_ACTIVITY_MONITORING	POC Authorization Activity	20101210
12	Importing	IV_PRE_BA_REQ	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Flag: Whether to get Pre BA instances	20110208
13	Importing	IV_READ_TEXTS	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Flag: Whether to read descriptions	20101210
14	Importing	IV_SORT	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Flag: Whether to get most recent process instances in result	20101210

Method GET_LOCAL_PROCESS on class CL_POC_PROCESS_ACCESS has no exception.

Method GET_PROCESS_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_KPI_VALUES	Call by reference	☐	Type reference (TYPE)	POC_T_KPI_VALUES			20121108
2	Exporting	ET_PROCESS_LOG	Call by reference	☐	Type reference (TYPE)	POC_T_PRC_LOG			20121108
3	Importing	IV_PROCESS_ID	Call by reference	☐	Type reference (TYPE)	POC_PROCESS_ID			20121108
4	Importing	IV_PROCESS_TYPE_ID	Call by reference	☐	Type reference (TYPE)	POC_PROCESS_TYPE_ID			20121108

Method GET_PROCESS_DATA on class CL_POC_PROCESS_ACCESS has no exception.

Method GET_STEP_INSTANCES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	POC_T_APPL_LOG_MSG		Application Log Message Data	20110927
2	Exporting	ET_STEP_INSTANCES	Call by reference	☐	Type reference (TYPE)	POC_T_STP_INSTANCE_EXT		POC Step instance ext	20110927
3	Importing	IS_PARAMETERS	Call by reference	☑	Type reference (TYPE)	POC_S_PROCESS_ACCESS		Task Log Parameters	20110927
4	Importing	IV_MAX_HITS	Call by reference	☐	Type reference (TYPE)	I	100	Max Number of hits	20110927

Method GET_STEP_INSTANCES on class CL_POC_PROCESS_ACCESS has no exception.

Method PRC_DEF_ID_WITH_KPI_THR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_R_PROCESS_TYPE_ID	Call by reference	☐	Type reference (TYPE)	POC_R_PROCESS_TYPE_ID		Process Definition ID	20110716

Method PRC_DEF_ID_WITH_KPI_THR on class CL_POC_PROCESS_ACCESS has no exception.

Method PRC_INSTANCE_WITH_KPI_THR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_PRC_INSTANCES	Call by reference	☐	Type reference (TYPE)	POC_T_PRC_INSTANCES		Process Instances	20110716
2	Importing	IV_THR_EXCEED_FLAG	Call by reference	☐	Type reference (TYPE)	POC_THRESHOLD		Threshold Exceeded Parameter	20110823

Method PRC_INSTANCE_WITH_KPI_THR on class CL_POC_PROCESS_ACCESS has no exception.

Method READ_PROCESS_DETAILS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_PROCESS_INSTANCES	Call by reference	☐	Type reference (TYPE)	POC_T_PRC_INSTANCES		Process Instances	20101213
2	Exporting	ET_KPI_DATA	Call by reference	☐	Type reference (TYPE)	POC_T_KPI_VALUES		KPI UI Display	20101213
3	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	POC_T_APPL_LOG_MSG		Application Log Message Data	20101221
4	Exporting	ET_PRC_STEP_INSTANCES	Call by reference	☐	Type reference (TYPE)	POC_T_PRC_LOG		Process Log	20101213
5	Exporting	ET_PRE_BA_INSTANCES	Call by reference	☐	Type reference (TYPE)	POC_T_PRE_BA_DETAILS		Previous/Predecessor Task	20110208
6	Importing	IT_AUTHORIZATION_DETAILS	Call by reference	☑	Type reference (TYPE)	POC_T_AUTHORIZATION_DETAILS		Table of authorization details for processes	20101213
7	Importing	IT_PROCESS_KPI_TYPE	Call by reference	☑	Type reference (TYPE)	POC_R_PROCESS_KPI_TYPE		Range table for Key Performance Indicator Definition ID	20110225
8	Importing	IV_CHECK_AUTHORITY	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_TRUE	Boolean Variable (X=True, -=False, Space=Unknown)	20101213
9	Importing	IV_GET_ACTIVITIES	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Boolean Variable (X=True, -=False, Space=Unknown)	20101213
10	Importing	IV_GET_KPIS	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Boolean Variable (X=True, -=False, Space=Unknown)	20101213
11	Importing	IV_PRE_BA_REQ	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Flag: whether to read Pre BA instances	20110208
12	Importing	IV_READ_TEXTS	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Boolean Variable (X=True, -=False, Space=Unknown)	20101213
13	Importing	IV_TIME_ZONE	Call by reference	☑	Type reference (TYPE)	TIMEZONE		Time Zone	20101214

Method READ_PROCESS_DETAILS on class CL_POC_PROCESS_ACCESS has no exception.

Method VALIDATE_SEARCH_CRITERIA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	POC_T_APPL_LOG_MSG		Application Log Message Data	20110105
2	Exporting	EV_SUCCESS	Call by reference	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20110105
3	Importing	IS_PARAMETERS	Call by reference	☐	Type reference (TYPE)	POC_S_PROCESS_ACCESS		Task Log Parameters	20110105

Method VALIDATE_SEARCH_CRITERIA on class CL_POC_PROCESS_ACCESS has no exception.

History

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