SAP ABAP Class CL_RSR_WORKBOOK_FILE_UTIL (File Utility Class)

Hierarchy

☛ SAP_BW (Software Component) SAP Business Warehouse
   ⤷ BW-BEX-ET (Application Component) End User Technology
     ⤷ RSR_EXCEL_RUNTIME (Package) Excel Runtime Objects

Properties

Class	CL_RSR_WORKBOOK_FILE_UTIL
Short Description	File Utility Class
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	RSR_EXCEL_RUNTIME	Excel Runtime Objects
Created	20110406	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	RS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_RSR_WORKBOOK_FILE_UTIL has no interface implemented.

Friends

Class CL_RSR_WORKBOOK_FILE_UTIL has no friend class.

Attributes

Class CL_RSR_WORKBOOK_FILE_UTIL has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONVERT_XSTRING_TO_RAWTAB	Static method	Public	Method	Convert an xstring into a raw table	20111228
2	DOWNLOAD	Static method	Public	Method	Download Workbooks to Directory	20110408
3	DOWNLOAD_WORKBOOKS	Static method	Public	Method	Download Workbooks to Directory	20110408
4	GET_FILENAME_FROM_WORKBOOKINFO	Static method	Public	Method	Download Workbooks to Directory	20110408
5	GET_WORKBOOKINFO_FROM_FILENAME	Static method	Public	Method	Download Workbooks to Directory	20110408
6	SELECT_FOR_UPLOAD	Static method	Public	Method	Select Workbooks from Directory for Upload	20110408
7	UPLOAD	Static method	Public	Method	Upload Workbooks from Directory	20110408
8	UPLOAD_WORKBOOKS	Static method	Public	Method	Upload Workbooks from Directory	20110408

Events

Class CL_RSR_WORKBOOK_FILE_UTIL has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TN_S_RAW	Public	See coding		Raw Line	20111228	begin of tn_s_raw, line(255) type x, end of tn_s_raw
2	TN_T_RAW	Public	See coding		Raw Table	20111228	tn_t_raw type standard table of tn_s_raw with default key initial size 1

Method Signatures

Method CONVERT_XSTRING_TO_RAWTAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_LENGTH	Call by reference	☐	Type reference (TYPE)	I			20111228
2	Exporting	E_T_RAW	Value transfer	☐	Type reference (TYPE)	TN_T_RAW		Raw Table	20111228
3	Importing	I_XSTRING	Call by reference	☐	Type reference (TYPE)	XSTRING			20111228

Method CONVERT_XSTRING_TO_RAWTAB on class CL_RSR_WORKBOOK_FILE_UTIL has no exception.

Method DOWNLOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_AUTHORITY_CHECK	Call by reference	☑	Type reference (TYPE)	RS_BOOL	RS_C_TRUE	Boolean	20110408
2	Importing	I_DIRECTORY	Call by reference	☐	Type reference (TYPE)	STRING		Directory	20110408
3	Importing	I_OBJVERS	Call by reference	☑	Type reference (TYPE)	RSRWBINDEX-OBJVERS	RS_C_OBJVERS-ACTIVE	Objektversion	20110408
4	Importing	I_WORKBOOK_ID	Call by reference	☑	Type reference (TYPE)	RSRWBINDEX-WORKBOOKID		BW Generierungs-Tool: GUID in komprimierter Form (CHAR25)	20110408

#	Exception	Resumable	Description	Created on
1	ERROR	☐		20110408
2	NOT_AUTHORIZED	☐		20110408
3	NOT_FOUND	☐		20110408

Method DOWNLOAD_WORKBOOKS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_O_MESSAGE_LOG	Call by reference	☐	Object reference (TYPE REF TO)	IF_RSR_WORKBOOK_MESSAGE_LOG		Message Log	20110408
2	Exporting	E_T_WORKBOOKS	Call by reference	☐	Type reference (TYPE)	IF_RSR_T_WORKBOOK=>T_WORKBOOK		Workbook Information incl. Title	20110408
3	Importing	I_AUTHORITY_CHECK	Call by reference	☑	Type reference (TYPE)	RS_BOOL	RS_C_TRUE	Boolean	20110408
4	Importing	I_DIRECTORY	Call by reference	☐	Type reference (TYPE)	STRING		Directory	20110408
5	Importing	I_EXTENSION	Call by reference	☑	Type reference (TYPE)	RSRWBINDEX-EXTENSION		Workbook FileExtension	20110408
6	Importing	I_MAX	Call by reference	☑	Type reference (TYPE)	I			20110408
7	Importing	I_OBJVERS	Call by reference	☑	Type reference (TYPE)	RSRWBINDEX-OBJVERS	RS_C_OBJVERS-ACTIVE	Objektversion	20110408
8	Importing	I_OWNER	Call by reference	☑	Type reference (TYPE)	RSRWBINDEX-OWNER		Besitzer (Verantwortlicher)	20110408
9	Importing	I_RANGE_EXTENSION	Call by reference	☑	Type reference (TYPE)	IF_RSR_T_WORKBOOK=>T_RANGE_EXTENSION		Range of Workbook File Extension	20110408
10	Importing	I_RANGE_OBJVERS	Call by reference	☑	Type reference (TYPE)	IF_RSR_T_WORKBOOK=>T_RANGE_OBJVERS		Range of Workbook Object Version	20110408
11	Importing	I_RANGE_OWNER	Call by reference	☑	Type reference (TYPE)	IF_RSR_T_WORKBOOK=>T_RANGE_OWNER		Range of Workbook Owner	20110408
12	Importing	I_RANGE_TITLE	Call by reference	☑	Type reference (TYPE)	IF_RSR_T_WORKBOOK=>T_RANGE_TITLE		Range of Workbook Titles	20110408
13	Importing	I_RANGE_WORKBOOK_ID	Call by reference	☑	Type reference (TYPE)	IF_RSR_T_WORKBOOK=>T_RANGE_WORKBOOKID		Range of Workbook ID's	20110408
14	Importing	I_TITLE	Call by reference	☑	Type reference (TYPE)	RSRWBINDEXT-TITLE		Beschreibung lang	20110408
15	Importing	I_WORKBOOK_ID	Call by reference	☑	Type reference (TYPE)	RSRWBINDEX-WORKBOOKID		BW Generierungs-Tool: GUID in komprimierter Form (CHAR25)	20110408

Method DOWNLOAD_WORKBOOKS on class CL_RSR_WORKBOOK_FILE_UTIL has no exception.

Method GET_FILENAME_FROM_WORKBOOKINFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DIRECTORY	Call by reference	☑	Type reference (TYPE)	STRING			20110408
2	Importing	I_EXTENSION	Call by reference	☐	Type reference (TYPE)	RSRWBINDEX-EXTENSION		Workbook FileExtension	20110408
3	Importing	I_OBJVERS	Call by reference	☑	Type reference (TYPE)	RSRWBINDEX-OBJVERS	RS_C_OBJVERS-ACTIVE	Objektversion	20110408
4	Importing	I_WORKBOOKID	Call by reference	☐	Type reference (TYPE)	RSRWBINDEX-WORKBOOKID		BW Generierungs-Tool: GUID in komprimierter Form (CHAR25)	20110408
5	Returning	VALUE	Value transfer	☐	Type reference (TYPE)	STRING			20110408

Method GET_FILENAME_FROM_WORKBOOKINFO on class CL_RSR_WORKBOOK_FILE_UTIL has no exception.

Method GET_WORKBOOKINFO_FROM_FILENAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_EXTENSION	Call by reference	☐	Type reference (TYPE)	RSRWBINDEX-EXTENSION			20110408
2	Exporting	E_OBJVERS	Call by reference	☐	Type reference (TYPE)	RSRWBINDEX-OBJVERS			20110408
3	Exporting	E_WORKBOOKID	Call by reference	☐	Type reference (TYPE)	RSRWBINDEX-WORKBOOKID			20110408
4	Importing	I_FILENAME	Call by reference	☐	Type reference (TYPE)	CSEQUENCE			20110408

Method GET_WORKBOOKINFO_FROM_FILENAME on class CL_RSR_WORKBOOK_FILE_UTIL has no exception.

Method SELECT_FOR_UPLOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_AUTHORITY_CHECK	Call by reference	☑	Type reference (TYPE)	RS_BOOL	RS_C_TRUE	Boolean	20110408
2	Importing	I_DIRECTORY	Call by reference	☐	Type reference (TYPE)	STRING			20110408
3	Importing	I_EXTENSION	Call by reference	☑	Type reference (TYPE)	RSRWBINDEX-EXTENSION		Workbook FileExtension	20110408
4	Importing	I_MAX	Call by reference	☑	Type reference (TYPE)	I			20110408
5	Importing	I_OBJVERS	Call by reference	☑	Type reference (TYPE)	RSRWBINDEX-OBJVERS	RS_C_OBJVERS-ACTIVE	Objektversion	20110408
6	Importing	I_OWNER	Call by reference	☑	Type reference (TYPE)	RSRWBINDEX-OWNER		Besitzer (Verantwortlicher)	20110408
7	Importing	I_RANGE_EXTENSION	Call by reference	☑	Type reference (TYPE)	IF_RSR_T_WORKBOOK=>T_RANGE_EXTENSION		Range of Workbook File Extension	20110408
8	Importing	I_RANGE_OBJVERS	Call by reference	☑	Type reference (TYPE)	IF_RSR_T_WORKBOOK=>T_RANGE_OBJVERS		Range of Workbook Object Version	20110408
9	Importing	I_RANGE_OWNER	Call by reference	☑	Type reference (TYPE)	IF_RSR_T_WORKBOOK=>T_RANGE_OWNER		Range of Workbook Owner	20110408
10	Importing	I_RANGE_TITLE	Call by reference	☑	Type reference (TYPE)	IF_RSR_T_WORKBOOK=>T_RANGE_TITLE		Range of Workbook Titles	20110408
11	Importing	I_RANGE_WORKBOOK_ID	Call by reference	☑	Type reference (TYPE)	IF_RSR_T_WORKBOOK=>T_RANGE_WORKBOOKID		Range of Workbook ID's	20110408
12	Importing	I_TITLE	Call by reference	☑	Type reference (TYPE)	RSRWBINDEXT-TITLE		Beschreibung lang	20110408
13	Importing	I_WORKBOOK_ID	Call by reference	☑	Type reference (TYPE)	RSRWBINDEX-WORKBOOKID		BW Generierungs-Tool: GUID in komprimierter Form (CHAR25)	20110408
14	Returning	VALUE	Value transfer	☐	Type reference (TYPE)	IF_RSR_T_WORKBOOK=>T_WORKBOOK		Workbook Information incl. Title	20110408

Method SELECT_FOR_UPLOAD on class CL_RSR_WORKBOOK_FILE_UTIL has no exception.

Method UPLOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_S_HEADER	Call by reference	☐	Type reference (TYPE)	RSRWBINDEX		List of binary large objects (Excel workbooks)	20110408
2	Importing	I_AUTHORITY_CHECK	Call by reference	☑	Type reference (TYPE)	RS_BOOL	RS_C_TRUE	Boolean	20110408
3	Importing	I_DIRECTORY	Call by reference	☐	Type reference (TYPE)	STRING			20110408
4	Importing	I_S_FILE	Call by reference	☐	Type reference (TYPE)	FILE_INFO		File Info Struktur	20110408
5	Importing	I_TRANSPORT	Call by reference	☑	Type reference (TYPE)	RS_BOOL	RS_C_TRUE	Boolean	20110408

#	Exception	Resumable	Description	Created on
1	ERROR	☐		20110408
2	NOT_AUTHORIZED	☐		20110408
3	NOT_FOUND	☐		20110408
4	TRANSPORT_ERROR	☐		20110408

Method UPLOAD_WORKBOOKS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_O_MESSAGE_LOG	Call by reference	☐	Object reference (TYPE REF TO)	IF_RSR_WORKBOOK_MESSAGE_LOG		Message Log	20110408
2	Exporting	E_T_WORKBOOKS	Call by reference	☐	Type reference (TYPE)	IF_RSR_T_WORKBOOK=>T_WORKBOOK		Workbook Information incl. Title	20110408
3	Importing	I_AUTHORITY_CHECK	Call by reference	☑	Type reference (TYPE)	RS_BOOL	RS_C_TRUE	Boolean	20110408
4	Importing	I_BACKUP	Call by reference	☑	Type reference (TYPE)	RS_BOOL	RS_C_TRUE	Boolean	20110408
5	Importing	I_DIRECTORY	Call by reference	☐	Type reference (TYPE)	STRING			20110408
6	Importing	I_EXTENSION	Call by reference	☑	Type reference (TYPE)	RSRWBINDEX-EXTENSION		Workbook FileExtension	20110408
7	Importing	I_MAX	Call by reference	☑	Type reference (TYPE)	I			20110408
8	Importing	I_OBJVERS	Call by reference	☑	Type reference (TYPE)	RSRWBINDEX-OBJVERS	RS_C_OBJVERS-ACTIVE	Objektversion	20110408
9	Importing	I_OWNER	Call by reference	☑	Type reference (TYPE)	RSRWBINDEX-OWNER		Besitzer (Verantwortlicher)	20110408
10	Importing	I_RANGE_EXTENSION	Call by reference	☑	Type reference (TYPE)	IF_RSR_T_WORKBOOK=>T_RANGE_EXTENSION		Range of Workbook File Extension	20110408
11	Importing	I_RANGE_OBJVERS	Call by reference	☑	Type reference (TYPE)	IF_RSR_T_WORKBOOK=>T_RANGE_OBJVERS		Range of Workbook Object Version	20110408
12	Importing	I_RANGE_OWNER	Call by reference	☑	Type reference (TYPE)	IF_RSR_T_WORKBOOK=>T_RANGE_OWNER		Range of Workbook Owner	20110408
13	Importing	I_RANGE_TITLE	Call by reference	☑	Type reference (TYPE)	IF_RSR_T_WORKBOOK=>T_RANGE_TITLE		Range of Workbook Titles	20110408
14	Importing	I_RANGE_WORKBOOK_ID	Call by reference	☑	Type reference (TYPE)	IF_RSR_T_WORKBOOK=>T_RANGE_WORKBOOKID		Range of Workbook ID's	20110408
15	Importing	I_TITLE	Call by reference	☑	Type reference (TYPE)	RSRWBINDEXT-TITLE		Beschreibung lang	20110408
16	Importing	I_TRANSPORT	Call by reference	☑	Type reference (TYPE)	RS_BOOL	RS_C_TRUE	Boolean	20110408
17	Importing	I_WORKBOOK_ID	Call by reference	☑	Type reference (TYPE)	RSRWBINDEX-WORKBOOKID		BW Generierungs-Tool: GUID in komprimierter Form (CHAR25)	20110408

Method UPLOAD_WORKBOOKS on class CL_RSR_WORKBOOK_FILE_UTIL has no exception.

History

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