SAP ABAP Class CL_STCTM_UTILITIES (Task List Run/Variant Utilities)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-INS-TC-RT (Application Component) Runtime for ABAP based automated TC
     ⤷ STC_TM (Package) Technical Configuration Task Management

Properties

Class	CL_STCTM_UTILITIES
Short Description	Task List Run/Variant Utilities
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class	STC_TM
Program status
Category	0
Package	STC_TM	Technical Configuration Task Management
Created	20110307	SAP
Last change	20141121
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)

Interfaces

Class CL_STCTM_UTILITIES has no interface implemented.

Friends

Class CL_STCTM_UTILITIES has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_BAL_STC	Constant	Public	☐	Type reference (TYPE)	BALOBJ_D	'STC'	TC Application Log Object	20120216
2	C_BAL_STC_SUBOBJECT	Constant	Public	☐	See coding			Sub-Objects for TC Application Log Object	20120216
3	C_BASIC_SCEN_TRANSP_OBJ	Constant	Public	☐	Type reference (TYPE)	TROBJTYPE	'STCB'	Transport object for Task List Group	20131106
4	C_EXEC_ACTIVITY	Constant	Public	☐	See coding			Possible Execution Activities for Task List Runs	20110824
5	C_EXEC_PERIOD	Constant	Public	☐	See coding			Possible Execution Periods for Task List Runs	20110824
6	C_SCENARIO_TRANS_OBJ	Constant	Public	☐	Type reference (TYPE)	TROBJTYPE	'STCS'	Transport object for Task Lists	20130311
7	C_SESSION_CHECK_STATUS	Constant	Public	☐	See coding			Check Status Values for Task List Runs	20110815
8	C_SESSION_FINALIZED	Constant	Public	☐	See coding			Task List Run Finalization Values	20130528
9	C_SESSION_LOG_FORMAT	Constant	Public	☐	See coding			Task List Run Log formats	20121107
10	C_SESSION_MAINTAINED	Constant	Public	☐	See coding			Maintenance Status Values for Task List Run	20121218
11	C_SESSION_SEP	Constant	Public	☐	Type reference (TYPE)	C	'_'	Task List / Run Separator	20110407
12	C_SESSION_STATUS	Constant	Public	☐	See coding			Execution Status Values for Task List Runs	20110307
13	C_TASK_MANAGER_USER	Constant	Public	☐	Type reference (TYPE)	SY-UNAME	''	Generic Task Manager User	20130315
14	C_TEMPLATE_TRANSP_NS	Constant	Public	☐	See coding			Transport Namespaces for Task List Variants	20120216
15	C_TEMPLATE_TRANSP_OBJ	Constant	Public	☐	Type reference (TYPE)	TROBJTYPE	'STCV'	Transport object for Task List Variants	20120216
16	PT_SESSION_DESCR_STATUS	Static Attribute	Private	☐	Type reference (TYPE)	TT_SESSION_DESCR_STATUS		Buffer for Task List Run Status for Description	20130122
17	PT_SESSION_FINALIZED_DESCR	Static Attribute	Private	☐	Type reference (TYPE)	TT_SESSION_FINALIZED_DESCR		Buffer for Task List Run Description for Finalization Status	20130531
18	PT_SESSION_STATUS_DESCR	Static Attribute	Private	☐	Type reference (TYPE)	TT_SESSION_STATUS_DESCR		Buffer for Task List Run Description for Status	20130122

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_SESSION_LOG_FORM_SUPP	Static method	Public	Method	Check if given Task List Run Log Format is supported	20121107
2	CHECK_TEMPLATE_NAME	Static method	Public	Method	Check Task List Variant ID	20110418
3	CHECK_TEMPLATE_TRANSPORTABLE	Static method	Public	Method	Check if Task List Variant can be added to transport request	20120217
4	GENERATE_SESSION_ID	Static method	Public	Method	Generate Task List Run ID	20110411
5	GET_DATAELEMENT_TEXTS	Static method	Public	Method	Get UI texts data elements	20130125
6	GET_EXEC_ACTIVITY	Static method	Public	Method	Get current Execution Activity	20110824
7	GET_EXEC_ID	Static method	Public	Method	Get current Execution Identifier	20110823
8	GET_SCENARIO_FOR_SESSION	Static method	Public	Method	Get Task List used in Task List Run	20110407
9	GET_SESSION_DESCR_STATUS	Static method	Public	Method	Get status for description	20110307
10	GET_SESSION_FINALIZED_DESCR	Static method	Public	Method	Get description for finalization status	20130531
11	GET_SESSION_FINALIZED_ICON	Static method	Public	Method	Get icon for finalization status	20130531
12	GET_SESSION_ICON_FINALIZED	Static method	Public	Method	Get finalization flag for icon	20130531
13	GET_SESSION_ICON_STATUS	Static method	Public	Method	Get status for icon	20110307
14	GET_SESSION_LOGTEXTS	Static method	Public	Method	Get UI texts for task list run entities	20130125
15	GET_SESSION_LOG_FORMATS	Static method	Public	Method	Get all supported Task List Run Log Formats	20121107
16	GET_SESSION_STATUS_DESCR	Static method	Public	Method	Get description for status	20110307
17	GET_SESSION_STATUS_ICON	Static method	Public	Method	Get icon for status	20110307
18	GET_VERSION	Static method	Public	Method	Get Version of Task Manager Framework	20130213
19	SET_EXEC_ACTIVITY	Static method	Public	Method	Set Execution Activity	20110824
20	SET_EXEC_ID	Static method	Public	Method	Set Execution Identifier	20110823
21	SHOW_APPLICATION_HELP	Static method	Public	Method	Show Application Help	20110502
22	SHOW_SCENARIO_DOCU	Static method	Public	Method	Show Task List documenation	20110517
23	TRANSFORM_SESSION_LOG	Static method	Public	Method	Transform Task List Run from XML to different format	20121107
24	_SHOW_COMP_SCENARIO_DOCU	Static method	Private	Method	Show Composite Task List documenation	20130315

Events

Class CL_STCTM_UTILITIES has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TS_LOG_FORMAT	Public	See coding		Log Format	20121107	BEGIN OF ts_log_format, format TYPE stc_session_log_format, descr TYPE text128, END OF ts_log_format
2	TS_SESSION_DESCR_STATUS	Private	See coding		Task List Run Status for Description	20130122	BEGIN OF ts_session_descr_status, descr TYPE stc_session_status_descr, langu TYPE langu, status TYPE stc_session_status, END OF ts_session_descr_status
3	TS_SESSION_FINALIZED_DESCR	Private	See coding		Task List Run Description for Finalization Status	20130531	BEGIN OF ts_session_finalized_descr, finalized TYPE stc_session_finalized, langu TYPE langu, descr TYPE ddtext, END OF ts_session_finalized_descr
4	TS_SESSION_STATUS_DESCR	Private	See coding		Task List Run Description for Status	20130122	BEGIN OF ts_session_status_descr, status TYPE stc_session_status, langu TYPE langu, descr TYPE stc_session_status_descr, END OF ts_session_status_descr
5	TT_LOG_FORMAT	Public	See coding		List of Log Formats	20121107	tt_log_format TYPE STANDARD TABLE OF ts_log_format
6	TT_SESSION_DESCR_STATUS	Private	See coding		Task List Run Status for Description	20130122	tt_session_descr_status TYPE HASHED TABLE OF ts_session_descr_status WITH UNIQUE KEY descr langu
7	TT_SESSION_FINALIZED_DESCR	Private	See coding		Task List Run Description for Finalization Status	20130531	tt_session_finalized_descr TYPE HASHED TABLE OF ts_session_finalized_descr WITH UNIQUE KEY finalized langu
8	TT_SESSION_STATUS_DESCR	Private	See coding		Task List Run Description for Status	20130122	tt_session_status_descr TYPE HASHED TABLE OF ts_session_status_descr WITH UNIQUE KEY status langu
9	T_CTIMESTAMP	Public	See coding		Timestamp (short)	20120126	T_CTIMESTAMP(19) type c
10	T_CTIMESTAMPL	Public	See coding		Timestamp (long)	20120126	T_CTIMESTAMPL(27) type c

Method Signatures

Method CHECK_SESSION_LOG_FORM_SUPP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FORMAT	Call by reference	☐	Type reference (TYPE)	STC_SESSION_LOG_FORMAT		Format of Task List Run Log	20121107

#	Exception	Resumable	Description	Created on
1	NOT_SUPPORTED	☐	Given format is not supported	20121107

Method CHECK_TEMPLATE_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_SCENARIO_ID	Call by reference	☐	Type reference (TYPE)	STC_SCENARIO_ID		TC Task List	20110418
2	Importing	I_TEMPLATE_ID	Call by reference	☐	Type reference (TYPE)	STC_TEMPLATE_ID		TC Task List Variant	20110418

#	Exception	Resumable	Description	Created on
1	INVALID	☐	Name/ID not valid	20110418

Method CHECK_TEMPLATE_TRANSPORTABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_BEFORE_ADDING	Call by reference	☐	Type reference (TYPE)	SAP_BOOL	'X'	'X' = Check before adding, ' ' = TLV is in TR	20120217
2	Importing	I_SCENARIO_ID	Call by reference	☐	Type reference (TYPE)	STC_SCENARIO_ID		Task List	20120217
3	Importing	I_TEMPLATE_ID	Call by reference	☐	Type reference (TYPE)	STC_TEMPLATE_ID		Task List Variant	20120217

#	Exception	Resumable	Description	Created on
1	NOT_TRANSPORTABLE	☐	Task List Variant can not be added to request	20120217

Method GENERATE_SESSION_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_SCENARIO_ID	Call by reference	☐	Type reference (TYPE)	STC_SCENARIO_ID		TC Task List	20110411
2	Returning	R_SESSION_ID	Value transfer	☐	Type reference (TYPE)	STC_SESSION_ID		TC Task List Run	20110411

Method GENERATE_SESSION_ID on class CL_STCTM_UTILITIES has no exception.

Method GET_DATAELEMENT_TEXTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_DDTEXT	Call by reference	☐	Type reference (TYPE)	CLIKE		Short Description of Repository Objects	20130125
2	Exporting	E_REPTEXT	Call by reference	☐	Type reference (TYPE)	CLIKE		Text to be returned	20130125
3	Exporting	E_SCRTEXT_L	Call by reference	☐	Type reference (TYPE)	CLIKE		Long Field Label	20130125
4	Exporting	E_SCRTEXT_M	Call by reference	☐	Type reference (TYPE)	CLIKE		Medium Field Label	20130125
5	Exporting	E_SCRTEXT_S	Call by reference	☐	Type reference (TYPE)	CLIKE		Short Field Label	20130125
6	Importing	I_LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU		ABAP System Field: Language Key of Text Environment	20130125
7	Importing	I_NAME	Call by reference	☐	Type reference (TYPE)	DDOBJNAME		Name of ABAP Dictionary Object	20130125

Method GET_DATAELEMENT_TEXTS on class CL_STCTM_UTILITIES has no exception.

Method GET_EXEC_ACTIVITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ACTIVITY	Call by reference	☐	Type reference (TYPE)	STC_EXEC_ACTIVITY		Execution Activity	20110824

Method GET_EXEC_ACTIVITY on class CL_STCTM_UTILITIES has no exception.

Method GET_EXEC_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_API	Call by reference	☐	Type reference (TYPE)	SAP_BOOL		'X' = triggered by API	20110823
2	Exporting	E_BATCH	Call by reference	☐	Type reference (TYPE)	SY-BATCH		'X' = Background Processing	20130221
3	Exporting	E_EXEC_ID	Call by reference	☐	Type reference (TYPE)	STC_EXEC_ID		Execution Identifier	20110823
4	Exporting	E_PERIOD	Call by reference	☐	Type reference (TYPE)	STC_EXEC_PERIOD		Execution Period	20110824

Method GET_EXEC_ID on class CL_STCTM_UTILITIES has no exception.

Method GET_SCENARIO_FOR_SESSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SESSION_ID	Call by reference	☐	Type reference (TYPE)	STC_SESSION_ID		TC Task List Run	20110407
2	Returning	RV_SCENARIO_ID	Value transfer	☐	Type reference (TYPE)	STC_SCENARIO_ID		TC Task List	20110407

Method GET_SCENARIO_FOR_SESSION on class CL_STCTM_UTILITIES has no exception.

Method GET_SESSION_DESCR_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DESCR	Value transfer	☐	Type reference (TYPE)	STC_SESSION_STATUS_DESCR		Technical Configuration Status	20110307
2	Importing	IV_LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU	SY-LANGU	Language Key of Current Text Environment	20110307
3	Returning	RV_STATUS	Value transfer	☐	Type reference (TYPE)	STC_SESSION_STATUS			20110307

Method GET_SESSION_DESCR_STATUS on class CL_STCTM_UTILITIES has no exception.

Method GET_SESSION_FINALIZED_DESCR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FINALIZED	Call by reference	☐	Type reference (TYPE)	STC_SESSION_FINALIZED		Task List Run Finalized	20130531
2	Importing	IV_LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU	SY-LANGU	Language Key of Current Text Environment	20130531
3	Returning	RV_DESCR	Value transfer	☐	Type reference (TYPE)	DDTEXT		Explanatory Short Text	20130531

Method GET_SESSION_FINALIZED_DESCR on class CL_STCTM_UTILITIES has no exception.

Method GET_SESSION_FINALIZED_ICON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FINALIZED	Call by reference	☐	Type reference (TYPE)	STC_SESSION_FINALIZED		Task List Run Finalized	20130531
2	Returning	RV_ICON	Value transfer	☐	Type reference (TYPE)	ICON-ID		Icon in text fields (substitute display, alias)	20130531

Method GET_SESSION_FINALIZED_ICON on class CL_STCTM_UTILITIES has no exception.

Method GET_SESSION_ICON_FINALIZED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ICON	Call by reference	☐	Type reference (TYPE)	ICON-ID		Icon in text fields (substitute display, alias)	20130531
2	Returning	RV_FINALIZED	Value transfer	☐	Type reference (TYPE)	STC_SESSION_FINALIZED		Task List Run Finalized	20130531

Method GET_SESSION_ICON_FINALIZED on class CL_STCTM_UTILITIES has no exception.

Method GET_SESSION_ICON_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ICON	Call by reference	☐	Type reference (TYPE)	ICON-ID		Icon in text fields (substitute display, alias)	20110307
2	Returning	RV_STATUS	Value transfer	☐	Type reference (TYPE)	STC_SESSION_STATUS			20110307

Method GET_SESSION_ICON_STATUS on class CL_STCTM_UTILITIES has no exception.

Method GET_SESSION_LOGTEXTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_LANGU	Call by reference	☐	Type reference (TYPE)	SYLANGU	SY-LANGU	ABAP System Field: Language Key of Text Environment	20130201
2	Returning	RT_LOGTEXTS	Value transfer	☐	Type reference (TYPE)	ABAP_TRANS_PARMBIND_TAB			20130125

Method GET_SESSION_LOGTEXTS on class CL_STCTM_UTILITIES has no exception.

Method GET_SESSION_LOG_FORMATS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_FORMAT	Call by reference	☐	Type reference (TYPE)	TT_LOG_FORMAT		List of Log Formats	20121107

Method GET_SESSION_LOG_FORMATS on class CL_STCTM_UTILITIES has no exception.

Method GET_SESSION_STATUS_DESCR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU	SY-LANGU	Language Key of Current Text Environment	20110307
2	Importing	IV_STATUS	Call by reference	☐	Type reference (TYPE)	STC_SESSION_STATUS		Task List Run Status	20110307
3	Returning	RV_DESCR	Value transfer	☐	Type reference (TYPE)	STC_SESSION_STATUS_DESCR		Task List Run Status Description	20110307

Method GET_SESSION_STATUS_DESCR on class CL_STCTM_UTILITIES has no exception.

Method GET_SESSION_STATUS_ICON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STATUS	Call by reference	☐	Type reference (TYPE)	STC_SESSION_STATUS		Task List Run Status	20110307
2	Returning	RV_ICON	Value transfer	☐	Type reference (TYPE)	ICON-ID		Icon in text fields (substitute display, alias)	20110307

Method GET_SESSION_STATUS_ICON on class CL_STCTM_UTILITIES has no exception.

Method GET_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_VERSION	Value transfer	☐	Type reference (TYPE)	CHAR10		Version of Task Manager Framework	20130213

Method GET_VERSION on class CL_STCTM_UTILITIES has no exception.

Method SET_EXEC_ACTIVITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ACTIVITY	Call by reference	☐	Type reference (TYPE)	STC_EXEC_ACTIVITY		Execution Activity	20110824

Method SET_EXEC_ACTIVITY on class CL_STCTM_UTILITIES has no exception.

Method SET_EXEC_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_API	Value transfer	☑	Type reference (TYPE)	SAP_BOOL		Triggered by API function	20110823
2	Importing	I_BATCH	Value transfer	☑	Type reference (TYPE)	SY-BATCH		Background Processing	20130220
3	Importing	I_CHECKRUN	Value transfer	☑	Type reference (TYPE)	STC_CHECKRUN		Use either I_CHECKRUN or I_PERIOD	20110823
4	Importing	I_EXEC_ID	Call by reference	☑	Type reference (TYPE)	STC_EXEC_ID		Execution Identifier	20111026
5	Importing	I_PERIOD	Value transfer	☐	Type reference (TYPE)	STC_EXEC_PERIOD	'M'	Use either I_CHECKRUN or I_PERIOD	20130418
6	Returning	R_EXEC_ID	Value transfer	☐	Type reference (TYPE)	STC_EXEC_ID		Execution Identifier	20111027

Method SET_EXEC_ID on class CL_STCTM_UTILITIES has no exception.

Method SHOW_APPLICATION_HELP Signature

Method SHOW_APPLICATION_HELP on class CL_STCTM_UTILITIES has no parameter.

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Failed to display application help	20120724

Method SHOW_SCENARIO_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_SCENARIO	Call by reference	☐	Object reference (TYPE REF TO)	IF_STC_SCENARIO		Task List Interface	20110517
2	Importing	IV_LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU	SY-LANGU	Language Key of Current Text Environment	20110517
3	Importing	IV_ORIGINAL_DOCU	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Show Original Docu	20130315

#	Exception	Resumable	Description	Created on
1	NOT_EXISTS	☐	No docu linked	20110517

Method TRANSFORM_SESSION_LOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_CONTENT_TYPE	Call by reference	☐	Type reference (TYPE)	W3CONTTYPE		MIME Content Type	20121108
2	Exporting	E_LOG	Call by reference	☐	Type reference (TYPE)	XSTRING		Task List Run in new format	20121108
3	Importing	I_FORMAT	Call by reference	☐	Type reference (TYPE)	STC_SESSION_LOG_FORMAT		Format of Task List Run Log	20121107
4	Importing	I_LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU	'E'	ABAP System Field: Language Key of Text Environment	20130201
5	Importing	I_LOG_XML	Call by reference	☐	Type reference (TYPE)	XSTRING		Task List Run Log in XML	20121107

#	Exception	Resumable	Description	Created on
1	NOT_SUPPORTED	☐	Task List Run format is not supported	20121107
2	TRANSFORMATION_FAILED	☐	Log tansformation failed	20121107

Method _SHOW_COMP_SCENARIO_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_SCENARIO	Call by reference	☐	Object reference (TYPE REF TO)	IF_STC_SCENARIO		Task List Interface	20130315

#	Exception	Resumable	Description	Created on
1	CX_STC_SCENARIO	☐	Task List Exception	20130315

History

Last changed by/on	SAP	20141121
SAP Release Created in	731