SAP ABAP Class CL_ESH_TAU_TOOLS (Test Automation Tools (General, EPM, ...))

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_TST_AUTOMATION (Package) Test Automation

Properties

Class	CL_ESH_TAU_TOOLS
Short Description	Test Automation Tools (General, EPM, ...)
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	S_ESH_TST_AUTOMATION	Test Automation
Created	20090902	SAP
Last change	20140121	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	CL_ESH_TAU_TOOLS	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_ESH_TAU_TOOLS has no interface implemented.

Friends

Class CL_ESH_TAU_TOOLS has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	SC_COMPLETE	Constant	Private	☐	See coding		'C'		20091204
2	SC_CONN_DESC_EPM	Constant	Private	☐	Type reference (TYPE)	SEFS_D_OBJ_TYPE_DESCR	`Procurement(EPM)_file`		20091207
3	SC_ERROR	Constant	Private	☐	See coding		'E'		20091204
4	SC_GOS_OBJTYP	Constant	Public	☐	Type reference (TYPE)	SWO_OBJTYP	'ESH_EPMPD'	Object type	20110217
5	SC_INITIAL	Constant	Private	☐	See coding		'I'		20091204
6	SC_SAPSCRIPT_ID_INT_INFO	Constant	Public	☐	Type reference (TYPE)	TDID	'INTI'	Internal info	20110217
7	SC_SAPSCRIPT_ID_SECU_INFO	Constant	Public	☐	Type reference (TYPE)	TDID	'SECI'	Security info	20110217
8	SC_SAPSCRIPT_LINE_LENGTH	Constant	Public	☐	Type reference (TYPE)	INT1	72	Dummy for B20 int1 (local everywhere)	20110217
9	SC_SAPSCRIPT_OBJECT	Constant	Public	☐	Type reference (TYPE)	TDOBJECT	'ESH_TAU'	Texts: Application object	20110217
10	SC_SAP_BASIS	Static Attribute	Public	☐	Type reference (TYPE)	STRING	'SAP_BASIS'		20100520
11	SC_SAP_COMPONENT_ESH	Static Attribute	Public	☐	Type reference (TYPE)	STRING	'BC-EIM-ESH'		20100520
12	SC_TEMPLATE_ID	Constant	Private	☐	Type reference (TYPE)	SESH_D_TEMPLATE_ID	'FILE_SEARCH'		20091204
13	SC_TEXT_EPM_N_A	Static Attribute	Public	☐	Type reference (TYPE)	STRING	'EPM_NOT_AVAILABLE'		20100223
14	SC_TEXT_EPM_N_S	Static Attribute	Public	☐	Type reference (TYPE)	STRING	'EPM_NOT_SEARCHABLE'		20100224
15	SR_EPM_AUTOTEST	Static Attribute	Private	☐	Object reference (TYPE REF TO)	IF_ESH_TAU_EPM_SWC		EPM software component	20091006
16	ST_FS_STATUS	Static Attribute	Private	☐	Type reference (TYPE)	ESH_T_SMOKETEST_STATUS		Table type for smoke test status information	20091204
17	SV_FORCE_EXCEPTION_ACTIVE	Static Attribute	Public	☐	Type reference (TYPE)	ABAP_BOOL			20100924
18	SV_LOCAL_CONNECTION_GUID	Static Attribute	Private	☐	Type reference (TYPE)	ESH_E_ADM_CONNECTION_GUID		Local connection GUID	20091204

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ACTIVATE_FORCE_EXCEPTION	Static method	Public	Method	Force exception during indexing/preparing	20100924
2	CLASS_CONSTRUCTOR	Static method	Public	Constructor		20091006
3	EPM_ACTIVATE_MOCKING	Static method	Public	Method	Activate mocking (external APIs, RFCs, ...)	20090902
4	EPM_CHANGE_SWITCH_STATE	Static method	Public	Method	Change the state of the BF to which switches are assigned	20101126
5	EPM_CREATE_CONNECTORS	Static method	Public	Method	Create EPM connectors	20090902
6	EPM_DELETE_CONNECTORS	Static method	Public	Method	Delete EPM connectors	20090902
7	EPM_FS_CREATE_AND_CRAWL	Static method	Public	Method	Create file-search connector and indexing (crawl)	20091204
8	EPM_FS_DELETE	Static method	Public	Method	Delete EPM file-search connector	20091204
9	EPM_FS_PROCESS_ERR_TAB	Static method	Private	Method		20091204
10	EPM_IMPORT_SWC	Static method	Public	Method	Import EPM software component to ESH modeler	20090902
11	EPM_INDEX_CONNECTORS	Static method	Public	Method	Index EPM connectors	20090902
12	EPM_INDEX_REALTIME	Static method	Public	Method	Real-time indexing (create change pointers)	20091024
13	EPM_IS_AVAILABLE	Static method	Public	Method	Check if EPM is available (software component)	20090909
14	EPM_IS_INDEXABLE	Static method	Public	Method	Check if EPM is indexable (connectors)	20090930
15	EPM_IS_SEARCHABLE	Static method	Public	Method	Check if EPM is searchable (connectors)	20090909
16	EPM_IS_SWITCH_AVAILABLE	Static method	Public	Method	Check if business function/switches are available	20090925
17	EXPORT_EPM	Static method	Public	Method		20100520
18	FILL_RTI_OBJECT	Static method	Private	Method	Fill real-time indexing object	20091025
19	GENERATE_SWC_EPM_CLASS	Static method	Public	Method		20100520
20	GET_BASE_URL	Static method	Public	Method		20091204
21	GET_GEO_COORDINATES	Static method	Public	Method	Get Geo Coordinates from Address	20130409
22	GET_LINETAB72_FROM_STRING	Static method	Public	Method	Split the string into line table of length 72 char	20110218
23	GET_MESSAGE_TEXT	Static method	Public	Method	Get general EPM message texts	20100223
24	GOS_DISPLAY_DATA	Static method	Public	Method	Display GOS data	20110217
25	NWESH_IS_AVAILABLE	Static method	Public	Method	Check if SAP NetWeaver Enterprise Search is available	20090928
26	SAPSCRIPT_MODIFY_TEXT	Static method	Public	Method	Modify (insert/update) a SAPscript text	20110217
27	SAPSCRIPT_READ_TEXT	Static method	Public	Method	Read a SAPscript text	20110217
28	SET_FOREGROUND_PROCESSING	Static method	Public	Method		20100520

Events

Class CL_ESH_TAU_TOOLS has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TT_DATA_RTI	Public	See coding			20091025	tt_data_rti TYPE TABLE OF ty_data_rti WITH KEY node_type_id
2	TT_LINETAB	Public	See coding			20110217	tt_linetab TYPE STANDARD TABLE OF tline
3	TY_DATA_RTI	Public	See coding			20091025	BEGIN OF ty_data_rti, node_type_id TYPE esh_e_om_node_name, data_ref TYPE REF TO data, modification_mode TYPE c LENGTH 1, END OF ty_data_rti

Method Signatures

Method ACTIVATE_FORCE_EXCEPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_LOG_MESSAGE	Value transfer	☐	Type reference (TYPE)	CHAR100		Character 100	20100924

Method ACTIVATE_FORCE_EXCEPTION on class CL_ESH_TAU_TOOLS has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_ESH_TAU_TOOLS has no parameter.
Method CLASS_CONSTRUCTOR on class CL_ESH_TAU_TOOLS has no exception.

Method EPM_ACTIVATE_MOCKING Signature

Method EPM_ACTIVATE_MOCKING on class CL_ESH_TAU_TOOLS has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_ESH_TAU	☐	Test Automation	20090902

Method EPM_CHANGE_SWITCH_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	ET_MESSAGE	Call by reference	☑	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20101223
2	Changing	EV_SUCCESS	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20101129
3	Importing	IV_STATE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	To 'ON' the BF / Switches 'ABAP_TRUE'	20101126

Method EPM_CHANGE_SWITCH_STATE on class CL_ESH_TAU_TOOLS has no exception.

Method EPM_CREATE_CONNECTORS Signature

Method EPM_CREATE_CONNECTORS on class CL_ESH_TAU_TOOLS has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_ESH_TAU	☐	Test Automation	20090902

Method EPM_DELETE_CONNECTORS Signature

Method EPM_DELETE_CONNECTORS on class CL_ESH_TAU_TOOLS has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_ESH_TAU	☐	Test Automation	20090902

Method EPM_FS_CREATE_AND_CRAWL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTEXT	Call by reference	☐	Type reference (TYPE)	STRING		Details about file shares to be crawled	20091207

Method EPM_FS_CREATE_AND_CRAWL on class CL_ESH_TAU_TOOLS has no exception.

Method EPM_FS_DELETE Signature

Method EPM_FS_DELETE on class CL_ESH_TAU_TOOLS has no parameter.
Method EPM_FS_DELETE on class CL_ESH_TAU_TOOLS has no exception.

Method EPM_FS_PROCESS_ERR_TAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_STATUS	Call by reference	☐	Type reference (TYPE)	ESH_S_SMOKETEST_STATUS			20091204
2	Importing	IT_RET	Call by reference	☐	Type reference (TYPE)	SESH_T_RETURN_CODES			20091204

Method EPM_FS_PROCESS_ERR_TAB on class CL_ESH_TAU_TOOLS has no exception.

Method EPM_IMPORT_SWC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20090928

#	Exception	Resumable	Description	Created on
1	CX_ESH_TAU	☐	Test Automation	20090902

Method EPM_INDEX_CONNECTORS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FORCE_FULL_INDEXING	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20091002
2	Importing	IV_RUN_IN_BACKGROUND	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20090928

#	Exception	Resumable	Description	Created on
1	CX_ESH_TAU	☐	Test Automation	20090902

Method EPM_INDEX_REALTIME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_RTI_DATA	Call by reference	☐	Type reference (TYPE)	TT_DATA_RTI		Real-Time Indexing Data	20091025
2	Importing	IV_CHANGE_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_E_CO_CHANGE_TYPE		Change Type: I = Insert; U = Update; D = Delete	20091024
3	Importing	IV_OBJECT_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20091024
4	Importing	IV_SW_COMP_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_SYSREL		Software Component	20091024

#	Exception	Resumable	Description	Created on
1	CX_ESH_TAU	☐	Test Automation	20091025

Method EPM_IS_AVAILABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_AVAILABLE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		EPM is available (abap_true / 'X')	20090909

#	Exception	Resumable	Description	Created on
1	CX_ESH_TAU	☐	Test Automation	20090909

Method EPM_IS_INDEXABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_AVAILABLE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		EPM is available (abap_true / 'X')	20090930

#	Exception	Resumable	Description	Created on
1	CX_ESH_TAU	☐	Test Automation	20090930

Method EPM_IS_SEARCHABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_AVAILABLE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		EPM is available (abap_true / 'X')	20090909

#	Exception	Resumable	Description	Created on
1	CX_ESH_TAU	☐	Test Automation	20090909

Method EPM_IS_SWITCH_AVAILABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SWF_BF	Call by reference	☐	Type reference (TYPE)	SFW_BFUNCTION		Business Function	20101130
2	Importing	IV_SWF_SWITCH_NAME	Call by reference	☐	Type reference (TYPE)	SFW_SWITCH_ID		Id of a Switch in Switch Framework	20101130
3	Returning	RV_AVAILABLE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20090925

Method EPM_IS_SWITCH_AVAILABLE on class CL_ESH_TAU_TOOLS has no exception.

Method EXPORT_EPM Signature

Method EXPORT_EPM on class CL_ESH_TAU_TOOLS has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_ESH_TAU	☐		20100520

Method FILL_RTI_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_PUSH_PROVIDER	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_IF_DATA_PROVIDER_PUSH		Push Interface for Changed Data	20091025
2	Importing	IS_DATA_TABLE	Call by reference	☐	Type reference (TYPE)	TY_DATA_RTI			20091025
3	Importing	IT_RTI_DATA	Call by reference	☐	Type reference (TYPE)	TT_DATA_RTI			20091025
4	Importing	IV_CHANGE_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_E_CO_CHANGE_TYPE		Change Type: I = Insert; U = Update; D = Delete	20091025
5	Importing	IV_OBJECT_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20091025
6	Importing	IV_SW_COMP_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_SYSREL		Software Component	20091025

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20091025

Method GENERATE_SWC_EPM_CLASS Signature

Method GENERATE_SWC_EPM_CLASS on class CL_ESH_TAU_TOOLS has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_ESH_TAU	☐		20100520

Method GET_BASE_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	STRING			20091204

Method GET_BASE_URL on class CL_ESH_TAU_TOOLS has no exception.

Method GET_GEO_COORDINATES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_LATITUDE	Call by reference	☐	Type reference (TYPE)	STRING			20130409
2	Changing	CV_LONGITUDE	Call by reference	☐	Type reference (TYPE)	STRING			20130409
3	Importing	IV_CITY	Call by reference	☐	Type reference (TYPE)	STRING			20130409
4	Importing	IV_COUNTRY	Call by reference	☐	Type reference (TYPE)	STRING			20130409
5	Importing	IV_POSTAL_CODE	Call by reference	☐	Type reference (TYPE)	STRING			20130409
6	Importing	IV_STREET	Call by reference	☐	Type reference (TYPE)	STRING			20130409

Method GET_GEO_COORDINATES on class CL_ESH_TAU_TOOLS has no exception.

Method GET_LINETAB72_FROM_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_LINETAB	Call by reference	☐	Type reference (TYPE)	CL_ESH_TAU_TOOLS=>TT_LINETAB		SAPscript: Text Lines	20110218
2	Importing	IV_LINE_SIZE	Call by reference	☐	Type reference (TYPE)	I	132	72 Chracters, in ESH_EPM SAPscript	20110218
3	Importing	IV_LONGTEXT	Call by reference	☐	Type reference (TYPE)	STRING			20110218

Method GET_LINETAB72_FROM_STRING on class CL_ESH_TAU_TOOLS has no exception.

Method GET_MESSAGE_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	STRING			20100223
2	Returning	RV_MESSAGE	Value transfer	☐	Type reference (TYPE)	STRING			20100223

Method GET_MESSAGE_TEXT on class CL_ESH_TAU_TOOLS has no exception.

Method GOS_DISPLAY_DATA Signature

Method GOS_DISPLAY_DATA on class CL_ESH_TAU_TOOLS has no parameter.
Method GOS_DISPLAY_DATA on class CL_ESH_TAU_TOOLS has no exception.

Method NWESH_IS_AVAILABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_AVAILABLE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		NW Enterprise Search is available	20090928
2	Exporting	EV_RETURN_TEXT	Call by reference	☐	Type reference (TYPE)	STRING		Return Text	20090928

Method NWESH_IS_AVAILABLE on class CL_ESH_TAU_TOOLS has no exception.

Method SAPSCRIPT_MODIFY_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_LINETAB	Call by reference	☑	Type reference (TYPE)	TT_LINETAB		72 characters	20110217
2	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	TDID	SC_SAPSCRIPT_ID_SECU_INFO	Text ID	20110217
3	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	TDOBNAME		Name	20110217
4	Importing	IV_OBJECT	Call by reference	☐	Type reference (TYPE)	TDOBJECT	SC_SAPSCRIPT_OBJECT	Texts: application object	20110217

Method SAPSCRIPT_MODIFY_TEXT on class CL_ESH_TAU_TOOLS has no exception.

Method SAPSCRIPT_READ_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_LINETAB	Call by reference	☐	Type reference (TYPE)	TT_LINETAB			20110217
2	Exporting	EV_THEAD	Call by reference	☐	Type reference (TYPE)	THEAD		SAPscript: Text Header	20110217
3	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	TDID	SC_SAPSCRIPT_ID_SECU_INFO	Text ID	20110217
4	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	TDOBNAME		Name	20110217
5	Importing	IV_OBJECT	Call by reference	☐	Type reference (TYPE)	TDOBJECT	SC_SAPSCRIPT_OBJECT	Texts: application object	20110217

Method SAPSCRIPT_READ_TEXT on class CL_ESH_TAU_TOOLS has no exception.

Method SET_FOREGROUND_PROCESSING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DELETE_OLD_ENTRIES	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20100520
2	Importing	IV_USERNAME	Call by reference	☑	Type reference (TYPE)	SYUNAME			20100520

Method SET_FOREGROUND_PROCESSING on class CL_ESH_TAU_TOOLS has no exception.

History

Last changed by/on	SAP	20140121
SAP Release Created in	730