SAP ABAP Class CL_RSRD_PRODUCER_RA (Produces Documents Using the Reporting Agent Engine)

Hierarchy

☛ SAP_BW (Software Component) SAP Business Warehouse
   ⤷ BW-BEX-ET (Application Component) End User Technology
     ⤷ RSRD (Package) BW: Broadcasting

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_RSRD_F_PRODUCER_ROOT	Root Class for Document Producer Classes	20030723
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_RSRA_BC_REMOTE_CONTROL	Interface for Remote Control of Web Template Precalculation	20030723
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_RSRD_FILTER_DIALOG_PROVIDER	Basis for Filter Dialog Using Producer/Distributor	20040614

Properties

Class	CL_RSRD_PRODUCER_RA
Short Description	Produces Documents Using the Reporting Agent Engine
Super Class	CL_RSRD_F_PRODUCER_ROOT	Root Class for Document Producer Classes
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class	RSRD
Program status	P	SAP Standard Production Program
Category	0
Package	RSRD	BW: Broadcasting
Created	20030723	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)
2	RSRD1	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
3	RZX2	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_RSRA_BC_REMOTE_CONTROL	☐	☐	Interface for Remote Control of Web Template Precalculation	20030723
2	IF_RSRD_FILTER_DIALOG_PROVIDER	☐	☐	Basis for Filter Dialog Using Producer/Distributor	20040614

Friends

#	Friend	Modeled only	Created on	Description
1	CL_RSRA_KWF_PAGE	☐	20040202	Logical InfoObject for Template

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_PARAMETER_CHARACTERISTIC	Constant	Public	☐	Type reference (TYPE)	RSRPARAMETERID	'PR_CHARACTERISTIC'	Parameter ID for Characteristic When Filtering	20040414
2	C_PARAMETER_CONTROL_QUERY	Constant	Public	☐	Type reference (TYPE)	RSRPARAMETERID	'PR_CONTROL_QUERY'	Parameter ID for Control Query When Filtering	20040414
3	C_PARAMETER_CONTROL_QUERY_VAR	Constant	Public	☐	Type reference (TYPE)	RSRPARAMETERID	'PR_CONTROL_QUERY_VARIANT'	Parameter ID for Variants of the Control Query	20040414
4	C_PARAMETER_FILTER_IOBJNM	Constant	Public	☐	Type reference (TYPE)	RSRPARAMETERID	'PR_FILTER_IOBJNM'	Parameter ID for Characteristic When Filtering (Internal)	20040414
5	C_PARAMETER_FILTER_STRING	Constant	Public	☐	Type reference (TYPE)	RSRPARAMETERID	'PR_FILTER_STRING'	Parameter ID for Filter String	20040414
6	C_PARAMETER_FILTER_TYPE	Constant	Public	☐	Type reference (TYPE)	RSRPARAMETERID	'PR_FILTER_TYPE'	Parameter ID for Type of Filtering	20040414
7	C_PARAMETER_WITH_SUMS	Constant	Public	☐	Type reference (TYPE)	RSRPARAMETERID	'PR_WITH_SUMS'	Parameter ID for Inserting Unfiltered Values	20040414
8	C_RA_DUMMY_PACKAGENM	Constant	Private	☐	Type reference (TYPE)	RSRA_PACKAGENM	'BR_DUMMY_PACKAGE'	Dummy Package Name for Reporting Agent	20030723
9	C_RA_DUMMY_SETTINGNM	Constant	Private	☐	Type reference (TYPE)	RSRA_SETTINGNM	'BR_DUMMY_SETTING'	Dummy Setting Name for Reporting Agent	20030723
10	P_ATTR_BUFFER_FILLED	Static Attribute	Private	☐	Type reference (TYPE)	RS_BOOL		Attribute Description from DB in Buffer	20030905
11	P_COMPID	Instance attribute	Private	☐	Type reference (TYPE)	RSZCOMPID		CompID of Control Query	20031010
12	P_INCLUDE_XLS_IN_HTML	Instance attribute	Private	☐	Type reference (TYPE)	RS_BOOL		Adds to HTML Data in XLS	20051202
13	P_INFOCUBE	Instance attribute	Private	☐	Type reference (TYPE)	RSINFOCUBE		InfoCube for Object	20030731
14	P_R_ATTRIBUTES	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_RSR_PARAMETER		Document Attributes	20030930
15	P_SX_ATTRIBUTE_DB	Static Attribute	Private	☐	Type reference (TYPE)	RSRD_SX_CLASS_DT		Buffered Attribute Description from DB	20030905
16	P_SX_DOCUMENT	Instance attribute	Private	☐	Type reference (TYPE)	RSRD_SX_DOCUMENT		Broadcasting Document	20030723
17	P_S_RECIPIENT	Instance attribute	Private	☐	Type reference (TYPE)	RSRD_S_RECIPIENT		Current Recipient (Recipient-Specific Creation of Documents)	20040628
18	P_TRANSIENT_QUERY_COUNTER	Static Attribute	Private	☐	Type reference (TYPE)	I		Counter for Producing Transient Control Queries	20031010
19	P_TX_RA_OUTPUT	Instance attribute	Private	☐	Type reference (TYPE)	TP_TX_RA_OUTPUT			20030723
20	P_T_FILTER_IOBJNM_DT	Instance attribute	Private	☐	Type reference (TYPE)	TP_T_IOBJNM_DT		List of Characteristics Relevant for Filtering	20031008

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADAPT_HTML_FOR_MHTML_MAIL	Instance method	Private	Method	Adapts the HTML for MHTML Mail	20040910
2	ADD_RECIPIENT_FILTERING	Instance method	Private	Method	Include Recipient-Specific Filtering	20040628
3	ADD_RECIPIENT_VARIABLES	Instance method	Private	Method	Include Variables for Recipients in the Variable String	20040628
4	AUTO_UPDATE	Static method	Public	Method	Match to Current Version	20040721
5	BUILD_DOCUMENT_CSV	Instance method	Private	Method	Adjust Document for CSV Output	20051202
6	BUILD_DOCUMENT_FROM_RA_OUTPUT	Instance method	Private	Method	Recursive Structure of Broadcasting Documents from RA Output	20030723
7	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20030905
8	DELETE_UNUSED_MIMES	Instance method	Private	Method	Deletion of All Unneccessary MIMEs	20031121
9	GENERATE_CONTROL_QUERY	Static method	Private	Method	Generates Control Query	20031010
10	GET_CHAR_FOR_INDEX_DT	Instance method	Public	Method	Determines Filter Characteristic for Index	20031008
11	GET_FILTER_FROM_CONTAINER	Static method	Private	Method	Produces Intermediate Structure from Filter Container	20031008
12	GET_INFOCUBE_FOR_CONTROLQUERY	Static method	Private	Method	Determines InfoCube for Building Control Query	20031009
13	GET_KEYFIGURE_FOR_CONTROLQUERY	Static method	Public	Method	Determines Key Figure for Producing Control Query	20031010
14	GET_TEMPLATE_QUERY_BROADCAST	Instance method	Private	Method	Determines the Standard Template for Query Broadcasting	20030731
15	GET_VAR_STRING_FOR_VARIANT	Instance method	Private	Method	Generates a Variable String for the Variants of a Query	20040630

Events

Class CL_RSRD_PRODUCER_RA has no event.

Types

Class CL_RSRD_PRODUCER_RA has no local type.

Method Signatures

Method ADAPT_HTML_FOR_MHTML_MAIL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_R_SETTING	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSRD_SETTING		Broadcast Einstellungen	20040910

Method ADAPT_HTML_FOR_MHTML_MAIL on class CL_RSRD_PRODUCER_RA has no exception.

Method ADD_RECIPIENT_FILTERING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_R_PARAMETER	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSR_PARAMETER		Parameter	20040628

Method ADD_RECIPIENT_FILTERING on class CL_RSRD_PRODUCER_RA has no exception.

Method ADD_RECIPIENT_VARIABLES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_R_PARAMETER	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSR_PARAMETER		Parameter	20040628

Method ADD_RECIPIENT_VARIABLES on class CL_RSRD_PRODUCER_RA has no exception.

Method AUTO_UPDATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_T_MESSAGE	Call by reference	☑	Type reference (TYPE)	RSRD_T_MESSAGE		Tabellentyp für RRX_MESG	20040721
2	Exporting	E_CHANGED	Call by reference	☐	Type reference (TYPE)	RS_BOOL			20040721
3	Importing	I_R_PARAMETER	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSR_PARAMETER		Parameter	20040721
4	Importing	I_S_SETTING_DT	Call by reference	☐	Type reference (TYPE)	RSRD_S_SETTING_DT		Settingparameter zur Designtime	20040910

Method AUTO_UPDATE on class CL_RSRD_PRODUCER_RA has no exception.

Method BUILD_DOCUMENT_CSV Signature

Method BUILD_DOCUMENT_CSV on class CL_RSRD_PRODUCER_RA has no parameter.
Method BUILD_DOCUMENT_CSV on class CL_RSRD_PRODUCER_RA has no exception.

Method BUILD_DOCUMENT_FROM_RA_OUTPUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FOLDER	Call by reference	☐	Type reference (TYPE)	RSRD_FOLDER			20030723
2	Importing	I_LOIO_PARENT	Call by reference	☐	Type reference (TYPE)	SDOK_DOCID			20030723

Method BUILD_DOCUMENT_FROM_RA_OUTPUT on class CL_RSRD_PRODUCER_RA has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_RSRD_PRODUCER_RA has no parameter.
Method CONSTRUCTOR on class CL_RSRD_PRODUCER_RA has no exception.

Method DELETE_UNUSED_MIMES Signature

Method DELETE_UNUSED_MIMES on class CL_RSRD_PRODUCER_RA has no parameter.
Method DELETE_UNUSED_MIMES on class CL_RSRD_PRODUCER_RA has no exception.

Method GENERATE_CONTROL_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_COMPID	Call by reference	☐	Type reference (TYPE)	RSZCOMPID			20031010
2	Exporting	E_INFOCUBE	Call by reference	☐	Type reference (TYPE)	RSINFOCUBE			20031010
3	Exporting	E_SUBRC	Call by reference	☐	Type reference (TYPE)	SYSUBRC			20031010
4	Exporting	E_T_MESSAGE	Call by reference	☐	Type reference (TYPE)	RSZA_T_MESG			20031010
5	Importing	I_EXECUTABLE	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_FALSE	Generierung für spätere Ausführung	20040614
6	Importing	I_R_PARAMETER	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSR_PARAMETER			20031010
7	Importing	I_S_SETTING	Call by reference	☐	Type reference (TYPE)	RSRD_V_SETTING			20031010

Method GENERATE_CONTROL_QUERY on class CL_RSRD_PRODUCER_RA has no exception.

Method GET_CHAR_FOR_INDEX_DT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_INFOCUBE	Call by reference	☐	Type reference (TYPE)	RSINFOCUBE			20031008
2	Exporting	E_IOBJNM	Call by reference	☐	Type reference (TYPE)	RSIOBJNM			20031008
3	Importing	I_INDEX	Call by reference	☐	Type reference (TYPE)	RSRPARAMETERINDEX			20031008

Method GET_CHAR_FOR_INDEX_DT on class CL_RSRD_PRODUCER_RA has no exception.

Method GET_FILTER_FROM_CONTAINER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_T_FILTER	Call by reference	☐	Type reference (TYPE)	RSZA_T_FILTER			20031008
2	Importing	I_INFOCUBE	Call by reference	☐	Type reference (TYPE)	RSINFOCUBE			20031008
3	Importing	I_IOBJNM	Call by reference	☐	Type reference (TYPE)	RSIOBJNM			20031008
4	Importing	I_R_PARAMETER	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSR_PARAMETER			20031008

Method GET_FILTER_FROM_CONTAINER on class CL_RSRD_PRODUCER_RA has no exception.

Method GET_INFOCUBE_FOR_CONTROLQUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_R_PARAMETER	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSR_PARAMETER			20031010
2	Importing	I_T_FILTER_IOBJNM	Call by reference	☐	Type reference (TYPE)	TP_T_IOBJNM_DT			20031010
3	Returning	R_INFOCUBE	Value transfer	☐	Type reference (TYPE)	RSINFOCUBE			20031009

Method GET_INFOCUBE_FOR_CONTROLQUERY on class CL_RSRD_PRODUCER_RA has no exception.

Method GET_KEYFIGURE_FOR_CONTROLQUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_INFOCUBE	Call by reference	☐	Type reference (TYPE)	RSINFOCUBE			20031010
2	Returning	R_IOBJNM_KEYFIGURE	Value transfer	☐	Type reference (TYPE)	RSIOBJNM			20031010

Method GET_KEYFIGURE_FOR_CONTROLQUERY on class CL_RSRD_PRODUCER_RA has no exception.

Method GET_TEMPLATE_QUERY_BROADCAST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_TEMPLATE_ID	Value transfer	☐	Type reference (TYPE)	RSZWOBJID			20030731

Method GET_TEMPLATE_QUERY_BROADCAST on class CL_RSRD_PRODUCER_RA has no exception.

Method GET_VAR_STRING_FOR_VARIANT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_COMPID	Call by reference	☐	Type reference (TYPE)	RSZCOMPID		Name (ID) einer Reporting-Komponete	20040630
2	Importing	I_VARIANT	Call by reference	☐	Type reference (TYPE)	RSRPARAMETERVALUE		Variantenname	20040630
3	Returning	R_VARIABLE_STRING	Value transfer	☐	Type reference (TYPE)	STRING			20040630

Method GET_VAR_STRING_FOR_VARIANT on class CL_RSRD_PRODUCER_RA has no exception.

History

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