SAP ABAP Class IDREPFW_CL_USR_ADD_SOURCE (Rep.Framework: Processing Additional Data Source)

Hierarchy

☛ SAP_FIN (Software Component) SAP_FIN
   ⤷ FI-LOC (Application Component) Localization
     ⤷ ID-REP_FRWK (Package) International Development: Reporting Framework

Properties

Class	IDREPFW_CL_USR_ADD_SOURCE
Short Description	Rep.Framework: Processing Additional Data Source
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	ID-REP_FRWK	International Development: Reporting Framework
Created	20130809	SAP
Last change	20131127	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)

Interfaces

Class IDREPFW_CL_USR_ADD_SOURCE has no interface implemented.

Friends

Class IDREPFW_CL_USR_ADD_SOURCE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CON_FILETYPE_ASC	Constant	Public	☐	Type reference (TYPE)	CHAR10	'ASC'	File Type - ASCII	20130812
2	CON_FILETYPE_BIN	Constant	Public	☐	Type reference (TYPE)	CHAR10	'BIN'	File Type - Binary	20130812
3	CON_FILETYPE_TXT	Constant	Public	☐	Type reference (TYPE)	CHAR3	'TXT'	File Type - TXT	20130812
4	CON_FILETYPE_XML	Constant	Public	☐	Type reference (TYPE)	CHAR3	'XML'	File Type - XML	20130812

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_MESSAGE	Static method	Private	Method	Add Message Into BAPI Return Structure	20130812
2	CREATE_TABLE_FROM_LINES	Static method	Public	Method	Create internal table from Text File lines	20130812
3	CREATE_TABLE_FROM_XML	Static method	Public	Method	Create internal table from XML File	20130812
4	OPEN_LOCAL_FILE	Static method	Private	Method	Open local file	20130812
5	OPEN_TEXT_FILE	Static method	Public	Method	Open text file and store it into internal table	20130812
6	OPEN_XML_FILE	Static method	Public	Method	Open XML file and store it into internal table	20130812
7	RNG2TAB_USRADDFIELDS	Static method	Public	Method	Range -> Table for User Additional Fields	20130813
8	SPLIT_FILE_NAME	Static method	Private	Method	Split Local File Name into 4 Parts (by 50 Chars)	20130812
9	TAB2RNG_USRADDFIELDS	Static method	Public	Method	Table -> Range for User Additional Fields	20130813

Events

Class IDREPFW_CL_USR_ADD_SOURCE has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_RNG_USR_ADDFIELDS	Public	See coding		Range of Additional User Fields (1154 Characters Long)	20130813	TY_RNG_USR_ADDFIELDS TYPE RANGE OF idrepfw_usr_addfield
2	TY_STR_FILE_BY_LINES	Public	See coding		Single Line of Text File Separated into Columns w/ Line No	20130812	BEGIN OF ty_str_file_by_lines, line_no TYPE int4, columns TYPE STANDARD TABLE OF string WITH NON-UNIQUE DEFAULT KEY, END OF ty_str_file_by_lines
3	TY_STR_TEXT_FILES	Public	See coding		Single Line of Text Files for Events 0025->0030 Move	20130812	BEGIN OF ty_str_text_files, file_name TYPE idrepfw_localfile, file_type TYPE char3, structure TYPE tabname, tab_file_by_lines TYPE ty_tab_file_by_lines, END OF ty_str_text_files
4	TY_STR_XML_FILES	Public	See coding		Single Line of XML Files for Events 0025->0030 Move	20130812	BEGIN OF ty_str_xml_files, file_name TYPE idrepfw_localfile, file_type TYPE char3, structure TYPE tabname, xml_versn TYPE idrepfw_xml_versn, tab_xml_x TYPE et_xml_x_tabtype, END OF ty_str_xml_files
5	TY_TAB_FILE_BY_LINES	Public	See coding		Int. Table with Text File Separated into Columns w/ Line No	20130812	ty_tab_file_by_lines TYPE TABLE OF ty_str_file_by_lines WITH NON-UNIQUE DEFAULT KEY
6	TY_TAB_TEXT_FILES	Public	See coding		Int. Table with Text Files for Events 0025->0030 Move	20130812	ty_tab_text_files TYPE TABLE OF ty_str_text_files
7	TY_TAB_XML_FILES	Public	See coding		Int. Table with XML Files for Events 0025->0030 Move	20130812	ty_tab_xml_files TYPE TABLE OF ty_str_xml_files

Method Signatures

Method ADD_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_MSG_TEXT	Call by reference	☐	Type reference (TYPE)	STRING		Message Text	20130812
2	Returning	RE_BAPI_RETURN	Value transfer	☐	Type reference (TYPE)	BAPIRET2		Return Parameter	20130812

Method ADD_MESSAGE on class IDREPFW_CL_USR_ADD_SOURCE has no exception.

Method CREATE_TABLE_FROM_LINES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_TABLE	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		Created Table for Text Contents	20130812
2	Importing	IM_STRUCTURE	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20130812
3	Importing	IM_TAB_FILE_BY_LINES	Call by reference	☐	Type reference (TYPE)	TY_TAB_FILE_BY_LINES		Int. Table with Text File Separated into Columns w/ Line No	20130812

Method CREATE_TABLE_FROM_LINES on class IDREPFW_CL_USR_ADD_SOURCE has no exception.

Method CREATE_TABLE_FROM_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_TABLE	Call by reference	☐	Type reference (TYPE)	IDREPFW_TAB_RUN_SECT		Rep.Framework: List of Run Sections	20130812
2	Importing	IM_FILE_NAME	Call by reference	☐	Type reference (TYPE)	IDREPFW_LOCALFILE		Local File for Upload (Used in Events 002x)	20130812
3	Importing	IM_STRUCTURE	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20130812
4	Importing	IM_STR_REP_KEY	Call by reference	☐	Type reference (TYPE)	IDREPFW_STR_REP_KEY		Rep.Framework: Combination of key fields: Group,ID,Versn	20130812
5	Importing	IM_TAB_XML_X	Call by reference	☐	Type reference (TYPE)	ET_XML_X_TABTYPE		Table of ET_XML_X, also of RAW(255)	20130812
6	Importing	IM_XML_VERSN	Call by reference	☐	Type reference (TYPE)	IDREPFW_XML_VERSN		XML Version	20130812

Method CREATE_TABLE_FROM_XML on class IDREPFW_CL_USR_ADD_SOURCE has no exception.

Method OPEN_LOCAL_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_TAB_FILE_DATA	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		Transfer Table for File Contents	20130812
2	Exporting	EX_TAB_RETURN	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20130812
3	Importing	IM_CODEPAGE	Call by reference	☑	Type reference (TYPE)	ABAP_ENCODING		Code Page	20130812
4	Importing	IM_FILETYPE	Call by reference	☐	Type reference (TYPE)	CHAR10	CON_FILETYPE_ASC	File Type (ASCII, Binary)	20130812
5	Importing	IM_FILE_NAME	Call by reference	☐	Type reference (TYPE)	IDREPFW_LOCALFILE		Local File for Upload (Used in Events 002x)	20130812
6	Importing	IM_READ_BY_LINE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	File Written Line-By-Line to the Internal Table	20130812

Method OPEN_LOCAL_FILE on class IDREPFW_CL_USR_ADD_SOURCE has no exception.

Method OPEN_TEXT_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_TAB_FILE_BY_LINES	Call by reference	☐	Type reference (TYPE)	TY_TAB_FILE_BY_LINES		Int. Table with Text File Separated into Columns w/ Line No	20130812
2	Exporting	EX_TAB_RETURN	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20130812
3	Importing	IM_CODEPAGE	Call by reference	☐	Type reference (TYPE)	ABAP_ENCODING	'1160'	Code Page	20130812
4	Importing	IM_FILE_NAME	Call by reference	☐	Type reference (TYPE)	IDREPFW_LOCALFILE		Local File for Upload (Used in Events 002x)	20130812
5	Importing	IM_SEPARATOR	Call by reference	☐	Type reference (TYPE)	IDREPFW_STR_SCR_ADDFILES-SEPARATOR		Character Separator	20130812

Method OPEN_TEXT_FILE on class IDREPFW_CL_USR_ADD_SOURCE has no exception.

Method OPEN_XML_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_TAB_RETURN	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20130812
2	Exporting	EX_TAB_XML_X	Call by reference	☐	Type reference (TYPE)	ET_XML_X_TABTYPE		Table of ET_XML_X, also of RAW(255)	20130812
3	Importing	IM_FILE_NAME	Call by reference	☐	Type reference (TYPE)	IDREPFW_LOCALFILE		Local File for Upload (Used in Events 002x)	20130812

Method OPEN_XML_FILE on class IDREPFW_CL_USR_ADD_SOURCE has no exception.

Method RNG2TAB_USRADDFIELDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_TAB_USR_ADDFIELDS	Call by reference	☐	Type reference (TYPE)	IDREPFW_TAB_USR_ADDFIELDS		Rep.Framework: Table of User Additional Fields	20130813
2	Importing	IM_RNG_USR_ADDFIELDS	Call by reference	☐	Type reference (TYPE)	TY_RNG_USR_ADDFIELDS		Range of Additional User Fields (1154 Characters Long)	20130813

Method RNG2TAB_USRADDFIELDS on class IDREPFW_CL_USR_ADD_SOURCE has no exception.

Method SPLIT_FILE_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_PART1	Call by reference	☐	Type reference (TYPE)	STRING		Part 1 (by 50 Chars)	20130812
2	Exporting	EX_PART2	Call by reference	☐	Type reference (TYPE)	STRING		Part 2 (by 50 Chars)	20130812
3	Exporting	EX_PART3	Call by reference	☐	Type reference (TYPE)	STRING		Part 3 (by 50 Chars)	20130812
4	Exporting	EX_PART4	Call by reference	☐	Type reference (TYPE)	STRING		Part 4 (by 50 Chars)	20130812
5	Importing	IM_LOCAL_FILE	Call by reference	☐	Type reference (TYPE)	STRING		Local File Name	20130812

Method SPLIT_FILE_NAME on class IDREPFW_CL_USR_ADD_SOURCE has no exception.

Method TAB2RNG_USRADDFIELDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_RNG_USR_ADDFIELDS	Call by reference	☐	Type reference (TYPE)	TY_RNG_USR_ADDFIELDS		Range of Additional User Fields (1154 Characters Long)	20130813
2	Importing	IM_TAB_USR_ADDFIELDS	Call by reference	☐	Type reference (TYPE)	IDREPFW_TAB_USR_ADDFIELDS		Rep.Framework: Table of User Additional Fields	20130813

Method TAB2RNG_USRADDFIELDS on class IDREPFW_CL_USR_ADD_SOURCE has no exception.

History

Last changed by/on	SAP	20131127
SAP Release Created in