SAP ABAP Class CL_MDG_EXTR_UI_ASSIST (Extractor Framework UI Assistance class)

Hierarchy

☛

SAP_BS_FND (Software Component) SAP Business Suite Foundation
⤷

CA-MDG-ML (Application Component) Mass Load
⤷

MDG_BS_EXTRACTOR (Package) Master Data Processes Data Extraction

Properties

Class	CL_MDG_EXTR_UI_ASSIST
Short Description	Extractor Framework UI Assistance class
Super Class
Instantiability of a Class	2	Public
Final

General Data

Message Class
Program status
Category	0
Package	MDG_BS_EXTRACTOR	Master Data Processes Data Extraction
Created	20090911	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_WD_SELECT_OPTIONS	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
3	RSDS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
4	SLIS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
5	SSCR	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_MDG_EXTR_UI_ASSIST has no interface implemented.

Friends

Class CL_MDG_EXTR_UI_ASSIST has no friend class.

Attributes

#	Attribute	Level	Visibility	Typing	Associated Type	Initial Value	Description	Created on
1	GC_TABNAME_FIELDNAME_DELIMITER	Constant	Public	Type reference (TYPE)	C	'_'	Delimiter to concatenate Tab- & Fieldname for the WD Element	20100614
2	GT_MID_FIELDNAME	Instance attribute	Private	See coding				20100614
3	MC_MESSAGE_CLASS	Constant	Private	Type reference (TYPE)	STRING	'MDP_BS_EXTRACTOR'	Message Class name	20091111
4	MO_APPL	Instance attribute	Public	Object reference (TYPE REF TO)	CL_MDG_EXTR_APPL		This class contains application logic	20090911
5	MO_BADI	Static Attribute	Public	Object reference (TYPE REF TO)	BADI_MDG_EXTR			20100506
6	MO_LOG_HELPER	Instance attribute	Public	Object reference (TYPE REF TO)	CL_MDP_IL_LOG_HELPER		Single logger instance used throughout the application	20090924
7	MS_HEADER	Instance attribute	Private	Type reference (TYPE)	MDG_EXTR_UI_HEAD		Initial Load Object Screen Header	20090911
8	MS_VARIANT	Instance attribute	Private	Type reference (TYPE)	MDG_EXTR_S_EXVARIANT		MDG Extractor: Extraction Variant	20091001
9	MV_EHP6_ACTIVE	Instance attribute	Private	Type reference (TYPE)	BOOLEAN	SPACE	Failsafe value to be set from the UI	20100622

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_MESSAGE_TO_LOG	Instance method	Public	Method	Adds a message to the log	20090927
2	AUTHORITY_CHECK_EXPORT	Static method	Public	Method	Authority Check for Data Export	20110712
3	CHECK_DESTINATION	Instance method	Public	Method	Checks the existence of the destination directory	20100220
4	CHECK_EXPORT_TYPE	Instance method	Public	Method	Checks the validity of selected export type	20091123
5	CHECK_VARIANT	Instance method	Public	Method	Checks existence of selected variant for given object type	20090915
6	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20090924
7	DELETE_VARIANT	Instance method	Public	Method	Deletes a Variant	20091002
8	DETERMINE_ID	Instance method	Public	Method	Determines an ID for a WD element.	20100614
9	DISPLAY_MESSAGE	Instance method	Public	Method	To display the messages on the UI.	20100614
10	EXTRACT_OBJECTS	Instance method	Public	Method	Extracts objects of the selected type	20090911
11	GET_LOG_EXTERNAL_ID	Static method	Public	Method	Get an External ID for the Log	20101203
12	GET_LOG_HANDLE	Instance method	Public	Method	Gets the Extract Logs	20090911
13	GET_OBJECT_TYPES	Static method	Public	Method	Gets the Object types registered in Customizing	20100806
14	GET_OBJECT_TYPE_CODE	Static method	Public	Method	Gets for an uploader type the object type code	20110803
15	GET_OBJECT_TYPE_DESC	Static method	Public	Method	Gets for an object type the description	20110803
16	GET_RECEIVER_SYSTEMS	Instance method	Public	Method	Returns the list of receiver systems	20091023
17	GET_TABNAME_FIELDNAME	Instance method	Public	Method	To get the table name and field name for the variant fields.	20100614
18	GET_VARIANTS	Instance method	Public	Method	Returns the list of variants for given object type	20090923
19	GET_VARIANTS_SEL_FIELDS	Instance method	Public	Method	Gets fields for the dynamic variants selection screen	20091007
20	GET_VARIANT_DATA	Instance method	Public	Method	Gets the data for a given variant	20090923
21	INITIALIZE_LOG_INSTANCE	Instance method	Public	Method	Create & initialize log instance	20091008
22	MOVE_TO_STRUCTURE	Instance method	Public	Method	Move to structure	20100614
23	REMOVE_TRAILING_ZEROS	Static method	Public	Method	Remove Trailing Zeros from the end of the extracted file	20100521
24	SAVE_VARIANT	Instance method	Public	Method	Persists Variant data	20090923
25	SELECT_OBJECTS	Instance method	Public	Method	Gets the number of selected objects & pre-selects IDs	20090916
26	SET_RESTRICTIONS	Instance method	Public	Method	Sets the WD restrictions	20100614
27	SET_UI_PARAMETERS	Instance method	Public	Method	Provides the data selected by the user to the back-end	20090925
28	VALIDATE_INPUT	Instance method	Public	Method	Validates User Input	20100702

Events

Class CL_MDG_EXTR_UI_ASSIST has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	GTYS_MID_FIELDNAME	Private	See coding			20100614	`BEGIN OF gtys_mid_fieldname, id TYPE string, tabname TYPE tabname, fieldname TYPE fieldname, END OF gtys_mid_fieldname`

Method Signatures

Method ADD_MESSAGE_TO_LOG Signature

Method ADD_MESSAGE_TO_LOG on class CL_MDG_EXTR_UI_ASSIST has no parameter.
Method ADD_MESSAGE_TO_LOG on class CL_MDG_EXTR_UI_ASSIST has no exception.

Method AUTHORITY_CHECK_EXPORT Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	EV_SUBRC	Call by reference	Type reference (TYPE)	SY-SUBRC	Return Value of ABAP Statements	20110712
2	Importing	IV_ACTVT	Call by reference	Type reference (TYPE)	ACTIV_AUTH	Activity	20110712
3	Importing	IV_OBJTYP	Call by reference	Type reference (TYPE)	MDG_OBJECT_TYPE_CODE_BS	Business Object Type	20110712

Method AUTHORITY_CHECK_EXPORT on class CL_MDG_EXTR_UI_ASSIST has no exception.

Method CHECK_DESTINATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_MESSAGE	Call by reference		Type reference (TYPE)	BAPIRET2_T		Return parameter table	20100220

Method CHECK_DESTINATION on class CL_MDG_EXTR_UI_ASSIST has no exception.

Method CHECK_EXPORT_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_MESSAGE	Call by reference		Type reference (TYPE)	BAPIRET2_T		Return parameter table	20091123

Method CHECK_EXPORT_TYPE on class CL_MDG_EXTR_UI_ASSIST has no exception.

Method CHECK_VARIANT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_MESSAGE	Call by reference		Type reference (TYPE)	BAPIRET2_T		Return parameter table	20090915

Method CHECK_VARIANT on class CL_MDG_EXTR_UI_ASSIST has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_OBJECT_TYPE	Call by reference		Type reference (TYPE)	MDP_IL_OBJECT_TYPE		MDG Extractor: Object Types	20090924

#	Exception	Resumable	Description	Created on
1	CX_MDG_EXTR_APPL		Exception class for Extractor	20101118

Method DELETE_VARIANT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_VARIANT	Call by reference		Type reference (TYPE)	MDG_EXTR_EXVARIANT		MDG Extractor: Extraction Variant	20091007

Method DELETE_VARIANT on class CL_MDG_EXTR_UI_ASSIST has no exception.

Method DETERMINE_ID Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IV_FIELDNAME	Call by reference	Type reference (TYPE)	FIELDNAME	Field Name	20100614
2	Importing	IV_TABNAME	Call by reference	Type reference (TYPE)	TABNAME	Table Name	20100614
3	Returning	RV_ID	Value transfer	Type reference (TYPE)	STRING		20100614

Method DETERMINE_ID on class CL_MDG_EXTR_UI_ASSIST has no exception.

Method DISPLAY_MESSAGE Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IR_API_CONTROLLER	Call by reference	Object reference (TYPE REF TO)	IF_WD_CONTROLLER	Web Dynpro: Controller Interface	20100614
2	Importing	IV_MSG_NO	Call by reference	Type reference (TYPE)	SYST-MSGNO	To get the message number.	20100614
3	Importing	IV_MSG_TYPE	Call by reference	Type reference (TYPE)	SYST-MSGTY	To get the message type.	20100614
4	Importing	IV_VIEW	Call by reference	Type reference (TYPE)	STRING	To get the view name.	20100614

Method DISPLAY_MESSAGE on class CL_MDG_EXTR_UI_ASSIST has no exception.

Method EXTRACT_OBJECTS Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	ET_EXTRACTED_FILE	Call by reference	Type reference (TYPE)	MDG_TT_EXTRACTED_FILE	MDG_TT_EXTRACTED_FILE	20090923
2	Exporting	ET_LOGS	Call by reference	Type reference (TYPE)	BAL_T_LOGH	Application Log: Log Handle Table	20090927
3	Exporting	EV_LOG_RUN_NUMBER	Call by reference	Type reference (TYPE)	MDG_DATA_LOAD_LOG_EXT_ID	MDG Data Load: Run Number for Log	20110131

#	Exception	Resumable	Description	Created on
1	CX_MDG_EXTR_APPL		Exception class for Extractor	20090911

Method GET_LOG_EXTERNAL_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_EXTERNAL_ID	Value transfer		Type reference (TYPE)	MDG_DATA_LOAD_LOG_EXT_ID		MDG Data Load: External ID for Log	20101203

#	Exception	Resumable	Description	Created on
1	CX_MDG_EXTR_APPL		Exception class for Extractor	20101203

Method GET_LOG_HANDLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_LOGHNDL	Call by reference		Type reference (TYPE)	BAL_T_LOGH		Application Log: Log Handle Table	20090911
2	Importing	IS_DATE_TIME	Call by reference		Type reference (TYPE)	BAL_S_DTTM		Application Log: Date and time interval	20090911

Method GET_LOG_HANDLE on class CL_MDG_EXTR_UI_ASSIST has no exception.

Method GET_OBJECT_TYPES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_OBJECT_TYPES	Call by reference		Type reference (TYPE)	MDG_EXTR_TT_OBJECT_TYPE		MDG Extractor: Table of Object Types & Description	20100806

Method GET_OBJECT_TYPES on class CL_MDG_EXTR_UI_ASSIST has no exception.

Method GET_OBJECT_TYPE_CODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_OBJECT_TYPE_CODE	Call by reference		Type reference (TYPE)	MDG_OBJECT_TYPE_CODE_BS		Business Object Type	20110803
2	Importing	IV_EXTRACTOR	Call by reference		Type reference (TYPE)	MDP_IL_OBJECT_TYPE		Object Type	20110803

Method GET_OBJECT_TYPE_CODE on class CL_MDG_EXTR_UI_ASSIST has no exception.

Method GET_OBJECT_TYPE_DESC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_OBJECT_TYPE_DESC	Call by reference		Type reference (TYPE)	MDG_OBJECT_TYPE_CODE_DESC_BS		Business Object Type	20110803
2	Importing	IV_OBJECT_TYPE	Call by reference		Type reference (TYPE)	MDG_OBJECT_TYPE_CODE_BS		MDG Extractor: Object type & its Description	20110803

Method GET_OBJECT_TYPE_DESC on class CL_MDG_EXTR_UI_ASSIST has no exception.

Method GET_RECEIVER_SYSTEMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RECEIVER_SYS	Call by reference		Type reference (TYPE)	MDG_EXTR_TT_RECEIVER_SYS		MDG Extractor: Receiver Systems	20091023

Method GET_RECEIVER_SYSTEMS on class CL_MDG_EXTR_UI_ASSIST has no exception.

Method GET_TABNAME_FIELDNAME Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	EV_FIELDNAME	Call by reference	Type reference (TYPE)	FIELDNAME	Field Name	20100614
2	Exporting	EV_TABNAME	Call by reference	Type reference (TYPE)	TABNAME	Table Name	20100614
3	Importing	IV_ID	Call by reference	Type reference (TYPE)	STRING		20100614

Method GET_TABNAME_FIELDNAME on class CL_MDG_EXTR_UI_ASSIST has no exception.

Method GET_VARIANTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_EXVARIANT	Call by reference		Type reference (TYPE)	MDG_EXTR_TT_EXVARIANT_F4		MDG Extractor: Extraction Variant F4 Help	20090923

Method GET_VARIANTS on class CL_MDG_EXTR_UI_ASSIST has no exception.

Method GET_VARIANTS_SEL_FIELDS Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	ES_RESTRICTION	Call by reference	Type reference (TYPE)	SSCR_RESTRICT_DS		20091007
2	Exporting	ET_GROUP_FIELDS	Call by reference	Type reference (TYPE)	MDG_EXTR_TT_GROUPS	MDG Extractor: Table of group descriptions	20091007
3	Exporting	ET_SEL_FIELDS	Call by reference	Type reference (TYPE)	RSDSFIELDS_T	Screen Selections: Table Type RSDSFIELDS	20091007

Method GET_VARIANTS_SEL_FIELDS on class CL_MDG_EXTR_UI_ASSIST has no exception.

Method GET_VARIANT_DATA Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	ET_FIELDS_NOT_SELECTED	Call by reference	Type reference (TYPE)	RSDSFIELDS_T	Screen Selections: Table Type RSDSFIELDS	20091018
2	Exporting	ET_FILTER	Call by reference	Type reference (TYPE)	SLIS_T_FILTER_ALV		20091220
3	Exporting	ET_SEL_CRITERIA_EXPR	Call by reference	Type reference (TYPE)	RSDS_TEXPR		20091008

#	Exception	Resumable	Description	Created on
1	CX_MDG_EXTR_APPL		Exception class for Extractor	20090924

Method INITIALIZE_LOG_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_LOG_HANDLE	Value transfer		Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20091008

Method INITIALIZE_LOG_INSTANCE on class CL_MDG_EXTR_UI_ASSIST has no exception.

Method MOVE_TO_STRUCTURE Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Created on
1	Changing	CS_STRUCTURE	Call by reference	Type reference (TYPE)	ANY	20100614
2	Importing	IV_FIELDNAME	Call by reference	Type reference (TYPE)	STRING	20100614
3	Importing	IV_VALUE	Call by reference	Type reference (TYPE)	ANY	20100614

Method MOVE_TO_STRUCTURE on class CL_MDG_EXTR_UI_ASSIST has no exception.

Method REMOVE_TRAILING_ZEROS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_OUT_XSTRING	Call by reference		Type reference (TYPE)	XSTRING			20100521
2	Importing	IV_IN_XSTRING	Call by reference		Type reference (TYPE)	XSTRING			20100521

Method REMOVE_TRAILING_ZEROS on class CL_MDG_EXTR_UI_ASSIST has no exception.

Method SAVE_VARIANT Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Changing	CT_MESSAGE	Call by reference	Type reference (TYPE)	BAPIRET2_T	Return parameter table	20091111
2	Importing	IS_VARIANT	Call by reference	Type reference (TYPE)	MDG_EXTR_S_EXVARIANT	MDG Extractor: Extraction Variant	20091006
3	Importing	IT_SEL_CRITERIA	Call by reference	Type reference (TYPE)	MDG_EXTR_TT_RSSELDYN	Table Type for RSSELDYN	20091001

#	Exception	Resumable	Description	Created on
1	CX_MDG_EXTR_APPL		Exception class for Extractor	20091001

Method SELECT_OBJECTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_LOGS	Call by reference		Type reference (TYPE)	BAL_T_LOGH		Application Log: Log Handle Table	20090927
2	Exporting	EV_NO_OF_SEL_OBJECTS	Call by reference		Type reference (TYPE)	INT4		Natural number	20090916

#	Exception	Resumable	Description	Created on
1	CX_MDG_EXTR_APPL		Exception class for Extractor	20090916

Method SET_RESTRICTIONS Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	ES_WD_RESTRICTIONS	Call by reference	Type reference (TYPE)	IF_WD_SELECT_OPTIONS=>T_COMPLEX_RESTRICTIONS		20100614
2	Exporting	EV_NO_EXTENSION	Call by reference	Type reference (TYPE)	WDY_BOOLEAN	Single-Character Flag	20100614
3	Importing	IS_RESTRICTIONS	Call by reference	Type reference (TYPE)	SSCR_RESTRICT_DS		20100614
4	Importing	IV_FIELDNAME	Call by reference	Type reference (TYPE)	FIELDNAME	Field Name	20100614
5	Importing	IV_TABLENAME	Call by reference	Type reference (TYPE)	TABNAME	Table Name	20100614

Method SET_RESTRICTIONS on class CL_MDG_EXTR_UI_ASSIST has no exception.

Method SET_UI_PARAMETERS Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IV_ASYNC_JOB_STRT_DT	Call by reference	Type reference (TYPE)	DATS	Field of type DATS	20100617
2	Importing	IV_ASYNC_JOB_STRT_TM	Call by reference	Type reference (TYPE)	TIMS	Field of type TIMS	20100617
3	Importing	IV_BSKEY	Call by reference	Type reference (TYPE)	MDG_EXTR_BSKEY	MDG Extractor: Business System	20090925
4	Importing	IV_DELTA_EXTRACT	Call by reference	Type reference (TYPE)	MDG_EXTR_DELTA	MDG Extractor: Indicator for delta extraction	20090925
5	Importing	IV_DIRECTORY	Call by reference	Type reference (TYPE)	FILEINTERN	Logical file name	20100714
6	Importing	IV_EHP6_ACTIVE	Call by reference	Type reference (TYPE)	BOOLEAN	Boolean Variable (X=True, -=False, Space=Unknown)	20100622
7	Importing	IV_EXPORT_TYPE	Call by reference	Type reference (TYPE)	MDG_EXTR_EXPORT_TYPE	MDG Extractor: Export Types	20090925
8	Importing	IV_EXVARIANT	Call by reference	Type reference (TYPE)	MDG_EXTR_EXVARIANT	MDG Extractor: Extraction Variant	20090925
9	Importing	IV_FILENAME_PREFIX	Call by reference	Type reference (TYPE)	MDG_DATALOAD_FILE_PREFIX	Filename Prefix	20110323
10	Importing	IV_FILE_SYSTEM	Call by reference	Type reference (TYPE)	MDP_FILE_SYSTEM	MDG Extractor: File system type	20090925
11	Importing	IV_LOCALFILE	Call by reference	Type reference (TYPE)	MDG_EXTR_DIRECTORY	MDG Extractor: Name of Directory in file system	20090925
12	Importing	IV_LOG_ID	Call by reference	Type reference (TYPE)	BALNREXT	Application Log: External ID	20100829
13	Importing	IV_NUM_WRK_PROCESSES	Call by reference	Type reference (TYPE)	INT4	Maximum number of Parallel Processes allowed	20100623
14	Importing	IV_PACKAGE_SIZE	Call by reference	Type reference (TYPE)	MDG_EXTR_PACKAGE_SIZE	MDG Extractor: Package Size	20090925
15	Importing	IV_PROCESS_IN_PARALLEL	Call by reference	Type reference (TYPE)	BOOLEAN	Boolean Variable (X=True, -=False, Space=Unknown)	20100717
16	Importing	IV_QUEUE_NAME	Call by reference	Type reference (TYPE)	TRFCQNAM	Queue name	20110228
17	Importing	IV_REMARK	Call by reference	Type reference (TYPE)	TEXT120	Text (Length 120)	20090925

Method SET_UI_PARAMETERS on class CL_MDG_EXTR_UI_ASSIST has no exception.

Method VALIDATE_INPUT Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	ET_MESSAGE	Call by reference	Type reference (TYPE)	BAPIRET2_T	Return parameter table	20100702
2	Importing	IV_CHECK_NUM_PROCESSES	Call by reference	Type reference (TYPE)	ABAP_BOOL		20100804
3	Importing	IV_CHECK_PACKAGE_SIZE	Call by reference	Type reference (TYPE)	ABAP_BOOL		20100804

Method VALIDATE_INPUT on class CL_MDG_EXTR_UI_ASSIST has no exception.

History

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

Object Hierarchy

Using

Used by

Advertise Links