SAP ABAP Class /SCMB/CL_DF_DOCUMENT_TYPE (Document Flow: Description)

Hierarchy

☛ PI_BASIS (Software Component) Basis Plug-In
   ⤷ SCM-BAS-DF (Application Component) Cross-System and Cross-Partner Document Flow
     ⤷ /SCMB/FLOW_CUSTOMIZING (Package) Document Flow, Customizing

Properties

Class	/SCMB/CL_DF_DOCUMENT_TYPE
Short Description	Document Flow: Description
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	/SCMB/FLOW_CUSTOMIZING	Document Flow, Customizing
Created	20020813	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class /SCMB/CL_DF_DOCUMENT_TYPE has no forward declaration.

Interfaces

Class /SCMB/CL_DF_DOCUMENT_TYPE has no interface implemented.

Friends

Class /SCMB/CL_DF_DOCUMENT_TYPE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_FALSE	Constant	Public	☐	Type reference (TYPE)	FLAG	' '	General Flag	20021219
2	GC_HEADER	Constant	Public	☐	Type reference (TYPE)	/SCMB/DF_LEVEL	'H'	Document Flow: Document Level (Header or Item)	20021219
3	GC_INDEX	Constant	Public	☐	Type reference (TYPE)	DBINDEX_D	'I01'	Name of a Database Index	20030526
4	GC_INDEX_DESCRIPTION	Constant	Public	☐	Type reference (TYPE)	CHAR27	'Generierte Indextabelle: '	Character Field with Length 27	20030526
5	GC_ITEM	Constant	Public	☐	Type reference (TYPE)	/SCMB/DF_LEVEL	'I'	Document Flow: Document Level (Header or Item)	20021219
6	GC_MSG_ID	Constant	Public	☐	Type reference (TYPE)	SYMSGID	'/SCMB/DOCFLOW'	Message Class ID	20070905
7	GC_TABNAME_PREFIX	Constant	Public	☐	Type reference (TYPE)	/SCMB/DF_PATTERN	'/1DF/'	Document Flow Table Name Prefix	20070905
8	GC_TRUE	Constant	Public	☐	Type reference (TYPE)	FLAG	'X'	General Flag	20021219
9	GT_CHARACTERISTIC_BUFFER	Static Attribute	Private	☐	Type reference (TYPE)	/SCMB/DF_CHARACTERISTIC_TBL		Technical Detail Characteristics for Document	20060920
10	GT_DETAIL_BUFFER	Static Attribute	Private	☐	Type reference (TYPE)	/SCMB/DF_DETAIL_TBL		Table Type for Document Type Details	20060920

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CREATE_DDIC_TABLE	Static method	Private	Method	Create DDIC Table and Perform All Attached Operations	20070905
2	GET	Static method	Public	Method	Delivers Document Categories	20021029
3	GET_DETAIL	Static method	Public	Method	Delivers Characteristics of a Document Category	20021029
4	GET_DETAIL_MULTI	Static method	Public	Method	Gets Technical Details for Requested Categories	20080919
5	GET_TYPEG	Static method	Public	Method	Delivers Characteristics of a Document Category	20070905
6	STRUCTURE_EXISTS	Static method	Public	Method	Checks Whether the Structure Exists	20070905
7	TABLE_ACTIVATE	Static method	Private	Method	Activates Table	20021127
8	TABLE_CREATE	Static method	Public	Method	Generates Charact. Table According to Charact. Structure	20021030
9	TABLE_CREATE_NEW	Static method	Private	Method	Creates Table to Be Regenerated, On Database	20021118
10	TABLE_DATA_SAVE	Static method	Public	Method	Enters Generated Table in Document Administration	20021126
11	TABLE_DDIC_CHECK	Static method	Public	Method	Checks Agreement of Generated Tables and Customizing	20021111
12	TABLE_DELETE	Static method	Public	Method	Deletes Transferred Database Table	20021112
13	TABLE_FIELD_LIST_CREATE	Static method	Private	Method	Manages the Fields of the Characteristics Table	20021114
14	TABLE_INDEX_CREATE	Static method	Private	Method	Creates Index for Generated Table	20030526
15	TABLE_NAME_CREATE	Static method	Public	Method	Creates Table Name According to Convention	20021113
16	TABLE_TADIR_INSERT	Static method	Private	Method	Includes New TADIR Entry for the Table	20021119
17	TABLE_TECHNICAL_ACTIVATE	Static method	Private	Method	Activates Technical Settings of Table	20021125
18	TABLE_TECHNICAL_CREATE	Static method	Private	Method	Creates Technical Settings of Table	20021118
19	TABLE_TEXT_SET	Static method	Private	Method	Sets Text for Table Description	20021119

Events

Class /SCMB/CL_DF_DOCUMENT_TYPE has no event.

Types

Class /SCMB/CL_DF_DOCUMENT_TYPE has no local type.

Method Signatures

Method CREATE_DDIC_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EF_LEVEL	Call by reference	☐	Type reference (TYPE)	/SCMB/DF_LEVEL		Level indicator	20070905
2	Exporting	EF_TAB_CREATED	Call by reference	☐	Type reference (TYPE)	FLAG		Table created indicator	20070905
3	Exporting	ET_RETURN	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with errors	20070905
4	Importing	IV_CATEGORY	Call by reference	☐	Type reference (TYPE)	/SCMB/DF_CATEGORY		DF document category	20070905
5	Importing	IV_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	/SCMB/DESCR_DOC_TYPE		Document Category Description	20070905
6	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	SPRAS		Language Key	20070905
7	Importing	IV_STRUCTURE	Call by reference	☐	Type reference (TYPE)	TABNAME		DF table structure	20070905
8	Importing	IV_TABLENAME	Call by reference	☐	Type reference (TYPE)	TABNAME		DF table name	20070905

Method CREATE_DDIC_TABLE on class /SCMB/CL_DF_DOCUMENT_TYPE has no exception.

Method GET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CATEGORY	Call by reference	☐	Type reference (TYPE)	/SCMB/DF_CATEGORY_TBL		Document Flow: Document Category	20021029
2	Exporting	ET_CATEGORY_DESCR	Call by reference	☐	Type reference (TYPE)	/SCMB/DF_CATEGORY_DESCR_TBL		Document Flow: Document Category, Text	20021029
3	Importing	IR_CATEGORY	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_CATEGORY_RANGE_TBL		Document Flow: Document Category, Range	20021029
4	Importing	IV_CATEGORY	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_CATEGORY		Document Flow: Document Category	20021029
5	Importing	IV_LANGUAGE	Call by reference	☑	Type reference (TYPE)	DDLANGUAGE		Language Key	20021029

Method GET on class /SCMB/CL_DF_DOCUMENT_TYPE has no exception.

Method GET_DETAIL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CHARACTERISTIC	Call by reference	☐	Type reference (TYPE)	/SCMB/DF_FIELDLIST_TBL		Document Flow: Structure Description/Table Description	20021029
2	Exporting	ET_CHARACTERISTIC_DESCR	Call by reference	☐	Type reference (TYPE)	/SCMB/DF_DESCRIPTION_TBL		Document Flow: Description	20021029
3	Exporting	EV_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	/SCMB/DESCR_DOC_TYPE		Document Category Description	20021119
4	Exporting	EV_LEVEL	Call by reference	☐	Type reference (TYPE)	/SCMB/DF_LEVEL		Document Level (Header or Item)	20021029
5	Exporting	EV_NEW	Call by reference	☐	Type reference (TYPE)	FLAG		Entry does not exist in Typeb	20070905
6	Exporting	EV_STRUCTURE	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20021029
7	Exporting	EV_TABLENAME	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20021029
8	Importing	IV_CATEGORY	Call by reference	☐	Type reference (TYPE)	/SCMB/DF_CATEGORY		Document Flow: Document Category	20021029
9	Importing	IV_CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT	SY-MANDT	System Client for processing	20070905
10	Importing	IV_LANGUAGE	Call by reference	☑	Type reference (TYPE)	DDLANGUAGE		Language Key	20021029

#	Exception	Resumable	Description	Created on
1	/SCMB/CX_DFI_DOCUMENT_SETUP	☐	Document Flow: Error in Document Administration	20021029

Method GET_DETAIL_MULTI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DETAIL	Call by reference	☐	Type reference (TYPE)	/SCMB/DF_DETAIL_TBL		Technical details of categories	20080919
2	Importing	IR_CATEGORY	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_CATEGORY_RANGE_TBL		Range of categories to be read	20080919
3	Importing	IV_CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT	SY-MANDT	Client for data read	20080919
4	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	DDLANGUAGE	SY-LANGU	Language of category description	20080919

Method GET_DETAIL_MULTI on class /SCMB/CL_DF_DOCUMENT_TYPE has no exception.

Method GET_TYPEG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CHARACTERISTIC	Call by reference	☐	Type reference (TYPE)	/SCMB/DF_FIELDLIST_TBL		Document Flow: Structure Description/Table Description	20070905
2	Exporting	ET_CHARACTERISTIC_DESCR	Call by reference	☐	Type reference (TYPE)	/SCMB/DF_DESCRIPTION_TBL		Document Flow: Description	20070905
3	Exporting	EV_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	/SCMB/DESCR_DOC_TYPE		Document Category Description	20070905
4	Exporting	EV_LEVEL	Call by reference	☐	Type reference (TYPE)	/SCMB/DF_LEVEL		Document Level (Header or Item)	20070905
5	Exporting	EV_STRUCTURE	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20070905
6	Exporting	EV_TABLENAME	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20070905
7	Importing	IV_CATEGORY	Call by reference	☐	Type reference (TYPE)	/SCMB/DF_CATEGORY		Document Flow: Document Category	20070905
8	Importing	IV_CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT	SY-MANDT	System Client for processing	20070905
9	Importing	IV_LANGUAGE	Call by reference	☑	Type reference (TYPE)	DDLANGUAGE		Language Key	20070905

#	Exception	Resumable	Description	Created on
1	/SCMB/CX_DFI_DOCUMENT_SETUP	☐	Document Flow: Error in Document Administration	20070905

Method STRUCTURE_EXISTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STRUCTURE	Call by reference	☐	Type reference (TYPE)	TABNAME		Name of structure	20070905
2	Returning	RV_EXISTS	Value transfer	☐	Type reference (TYPE)	XFLAG		Existence indicator	20070905

Method STRUCTURE_EXISTS on class /SCMB/CL_DF_DOCUMENT_TYPE has no exception.

Method TABLE_ACTIVATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CF_SUCCESS	Call by reference	☐	Type reference (TYPE)	FLAG		General Flag	20070905
2	Importing	IV_TABLENAME	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20021127

Method TABLE_ACTIVATE on class /SCMB/CL_DF_DOCUMENT_TYPE has no exception.

Method TABLE_CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EF_TAB_CREATED	Call by reference	☐	Type reference (TYPE)	FLAG		General Flag	20021111
2	Exporting	ET_RETURN	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Fehler- und Erfolgsmeldungen	20070905
3	Exporting	EV_TABLENAME	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20021031
4	Importing	IV_CATEGORY	Call by reference	☐	Type reference (TYPE)	/SCMB/DF_CATEGORY		Document Flow: Document Category	20021030
5	Importing	IV_CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT		Mandant zur Bearbeitung	20070905
6	Importing	IV_FORCE_GENERATION	Call by reference	☑	Type reference (TYPE)	FLAG		Generierung erzwingen	20050930

Method TABLE_CREATE on class /SCMB/CL_DF_DOCUMENT_TYPE has no exception.

Method TABLE_CREATE_NEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CF_SUCCESS	Call by reference	☐	Type reference (TYPE)	FLAG		General Flag	20070905
2	Importing	IS_HEADER	Call by reference	☐	Type reference (TYPE)	DD02V		Generated Table for View DD02V	20021118
3	Importing	IT_FIELDTAB	Call by reference	☐	Type reference (TYPE)	DD03TTYP		Table Type for Structure DD03P	20021118
4	Importing	IV_TABLENAME	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20021118

Method TABLE_CREATE_NEW on class /SCMB/CL_DF_DOCUMENT_TYPE has no exception.

Method TABLE_DATA_SAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_LEVEL	Call by reference	☐	Type reference (TYPE)	/SCMB/DF_LEVEL		Level indicator	20070905
2	Importing	IF_NEW	Call by reference	☐	Type reference (TYPE)	FLAG		Is it a new customizing entry?	20070905
3	Importing	IV_CATEGORY	Call by reference	☐	Type reference (TYPE)	/SCMB/DF_CATEGORY		Document Flow: Document Category	20021126
4	Importing	IV_CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT		Mandant zur Modifikation	20070905
5	Importing	IV_TABLENAME	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20021126

Method TABLE_DATA_SAVE on class /SCMB/CL_DF_DOCUMENT_TYPE has no exception.

Method TABLE_DDIC_CHECK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EF_GEN_NECESS	Call by reference	☐	Type reference (TYPE)	FLAG		General Flag	20021111
2	Importing	IV_CATEGORY	Call by reference	☐	Type reference (TYPE)	/SCMB/DF_CATEGORY		Document Flow: Document Category	20021111
3	Importing	IV_CLIENT	Call by reference	☑	Type reference (TYPE)	MANDT		Client	20070905
4	Importing	IV_STRUCTURE	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20021111
5	Importing	IV_TABLENAME	Call by reference	☑	Type reference (TYPE)	TABNAME		Table Name	20021111

Method TABLE_DDIC_CHECK on class /SCMB/CL_DF_DOCUMENT_TYPE has no exception.

Method TABLE_DELETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_COMMIT	Call by reference	☐	Type reference (TYPE)	FLAG		General Flag	20021112
2	Importing	IV_TABLENAME	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20021112

Method TABLE_DELETE on class /SCMB/CL_DF_DOCUMENT_TYPE has no exception.

Method TABLE_FIELD_LIST_CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EF_LEVEL	Call by reference	☐	Type reference (TYPE)	/SCMB/DF_LEVEL		Level indicator	20070905
2	Exporting	ES_HEADER	Call by reference	☐	Type reference (TYPE)	DD02V		Generated Table for View DD02V	20021114
3	Exporting	ET_FIELDTAB	Call by reference	☐	Type reference (TYPE)	DD03TTYP		Table Type for Structure DD03P	20021114
4	Importing	IV_CATEGORY	Call by reference	☐	Type reference (TYPE)	/SCMB/DF_CATEGORY		Document Flow: Document Category	20021114
5	Importing	IV_STRUCTURE	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20021114
6	Importing	IV_TABLENAME	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20021114

Method TABLE_FIELD_LIST_CREATE on class /SCMB/CL_DF_DOCUMENT_TYPE has no exception.

Method TABLE_INDEX_CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_FIELDTAB	Call by reference	☐	Type reference (TYPE)	DD03TTYP		Table Type for Structure DD03P	20030526
2	Importing	IV_INDEX	Call by reference	☐	Type reference (TYPE)	DBINDEX_D		Name of a Database Index	20030526
3	Importing	IV_TABLENAME	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20030526

Method TABLE_INDEX_CREATE on class /SCMB/CL_DF_DOCUMENT_TYPE has no exception.

Method TABLE_NAME_CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_TABLENAME	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20021113
2	Importing	IV_CATEGORY	Call by reference	☐	Type reference (TYPE)	/SCMB/DF_CATEGORY		Document Flow: Document Category	20021113
3	Importing	IV_CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT	SY-MANDT	Client	20070905
4	Importing	IV_PATTERN	Call by reference	☐	Type reference (TYPE)	/SCMB/DF_PATTERN	GC_TABNAME_PREFIX	Namespace for Generated Tables in the Document Flow	20021113

Method TABLE_NAME_CREATE on class /SCMB/CL_DF_DOCUMENT_TYPE has no exception.

Method TABLE_TADIR_INSERT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TABLENAME	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20021119

Method TABLE_TADIR_INSERT on class /SCMB/CL_DF_DOCUMENT_TYPE has no exception.

Method TABLE_TECHNICAL_ACTIVATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CF_SUCCESS	Call by reference	☐	Type reference (TYPE)	FLAG		General Flag	20070905
2	Importing	IV_TABLENAME	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20021125

Method TABLE_TECHNICAL_ACTIVATE on class /SCMB/CL_DF_DOCUMENT_TYPE has no exception.

Method TABLE_TECHNICAL_CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CF_SUCCESS	Call by reference	☐	Type reference (TYPE)	FLAG		General Flag	20070905
2	Importing	IV_TABLENAME	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20021118

Method TABLE_TECHNICAL_CREATE on class /SCMB/CL_DF_DOCUMENT_TYPE has no exception.

Method TABLE_TEXT_SET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_TABLE_NAME_CREATED	Call by reference	☐	Type reference (TYPE)	FLAG		General Flag	20021119
2	Importing	IV_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	/SCMB/DESCR_DOC_TYPE		Document Category Description	20021119
3	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	SPRAS		Language Key	20021120
4	Importing	IV_TABLENAME	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20021119

Method TABLE_TEXT_SET on class /SCMB/CL_DF_DOCUMENT_TYPE has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in	401