SAP ABAP Class CL_ESH_IF_SAP_SHORTCUT (SAP Shortcut)
Hierarchy
SAP_BASIS (Software Component) SAP Basis Component
   BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     S_ESH_ENG_INTERFACE (Package) Interface
Properties
Class CL_ESH_IF_SAP_SHORTCUT  
Short Description SAP Shortcut    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package S_ESH_ENG_INTERFACE   Interface 
Created 20061020   SAP 
Last change 20110908   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_IF_SAP_SHORTCUT Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
Interfaces
Class CL_ESH_IF_SAP_SHORTCUT has no interface implemented.
Friends
Class CL_ESH_IF_SAP_SHORTCUT has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 MT_FIELDS Instance attribute Public Type reference (TYPE) ESH_T_IF_DYNPRO_FIELD_VALUES Dynpro selection fields: Name-value pairs 20061031
2 MT_GATEWAY_HOSTS Instance attribute Public Type reference (TYPE) ESH_T_IF_GATEWAY_HOST Gateway host names and services 20061031
3 MV_APPLICATION_SERVER_NAME Instance attribute Public Type reference (TYPE) MSNAME2 Application server 20061031
4 MV_CLIENT_ID Instance attribute Public Type reference (TYPE) SYST-MANDT System client 20061025
5 MV_COMMAND Instance attribute Public Type reference (TYPE) STRING Command 20061023
6 MV_COMMAND_TYPE Instance attribute Public Type reference (TYPE) CHAR20 Command type 20061031
7 MV_GROUP Instance attribute Public Type reference (TYPE) RZLLI_APCL Logon group 20061023
8 MV_GUIPARM Instance attribute Public Type reference (TYPE) STRING GUI parameters 20061023
9 MV_GUI_SIZE Instance attribute Public Type reference (TYPE) CHAR20 GUI size 20061026
10 MV_LANGUAGE_CODE Instance attribute Public Type reference (TYPE) SYST-LANGU Language key 20061025
11 MV_LOGON_GROUP Instance attribute Public Type reference (TYPE) RFCLOAD Logon group for load-balancing mode 20061031
12 MV_MESSAGE_SERVER_NAME Instance attribute Public Type reference (TYPE) RFCHOST_EXT Message server 20061031
13 MV_PARAMETER_STRING Instance attribute Public Type reference (TYPE) STRING Dynpro selection fields in internal format 20081007
14 MV_PASSWORD Instance attribute Public Type reference (TYPE) CHAR12 Password 20061023
15 MV_REPORT_NAME Instance attribute Public Type reference (TYPE) PROGRAMM ABAP program name 20061025
16 MV_REPORT_VARIANT Instance attribute Public Type reference (TYPE) RALDB_VARI Variant name 20061025
17 MV_REUSE_EXISTING_CONNECTION Instance attribute Public Type reference (TYPE) ABAP_BOOL ABAP_TRUE Reuse connection 20061025
18 MV_SERVICE_PORT Instance attribute Public Type reference (TYPE) I Service port 20061031
19 MV_SKIP_INITIAL_SCREEN Instance attribute Public Type reference (TYPE) XFELD Skip initial screen of transaction 20061031
20 MV_SNC_PARTNER_NAME Instance attribute Public Type reference (TYPE) STRING SNC name 20061026
21 MV_SNC_QUALITY_OF_PROTECTION Instance attribute Public Type reference (TYPE) SNC_QOP SNC: Quality of protection 20061026
22 MV_SSO_COOKIE Instance attribute Private Type reference (TYPE) STRING SSO Cookie 20100928
23 MV_SYSNAME Instance attribute Public Type reference (TYPE) CHAR255 System name 20061023
24 MV_SYSTEM_COMMAND Instance attribute Public Type reference (TYPE) CHAR70 System command 20061031
25 MV_SYSTEM_DEF_TYPE Instance attribute Protected Type reference (TYPE) CHAR1 System definition type 20061031
26 MV_SYSTEM_DESCRIPTION Instance attribute Public Type reference (TYPE) TEXT80 System description 20061031
27 MV_SYSTEM_ID Instance attribute Public Type reference (TYPE) SYST-SYSID System ID 20061025
28 MV_SYSTEM_NUMBER Instance attribute Public Type reference (TYPE) NUMC2 System number 20061031
29 MV_TITLE Instance attribute Public Type reference (TYPE) STRING Title 20061023
30 MV_TRACE_LEVEL Instance attribute Public Type reference (TYPE) ESH_E_IF_NUMC1 Trace 20061025
31 MV_TRANSACTION_CODE Instance attribute Public Type reference (TYPE) TCODE Transaction code 20061031
32 MV_USER_ID Instance attribute Public Type reference (TYPE) SYST-UNAME User name 20061025
33 MV_WORK_DIRECTORY Instance attribute Public Type reference (TYPE) CHAR255 Work directory 20061031
34 SC_APOSTROPHE Constant Protected Type reference (TYPE) CHAR4 '''' Apostrophe 20061023
35 SC_COMMAND_TYPE_REPORT Constant Protected Type reference (TYPE) CHAR20 'Report' Function type report 20061031
36 SC_COMMAND_TYPE_SYSTEM_COMMAND Constant Protected Type reference (TYPE) CHAR20 'SystemCommand' Function type system command 20061031
37 SC_COMMAND_TYPE_TRANSACTION Constant Protected Type reference (TYPE) CHAR20 'Transaction' Function type transaction 20061031
38 SC_GUI_SIZE_MAXIMIZED Constant Public Type reference (TYPE) CHAR20 'Maximized' Maximized GUI size 20061026
39 SC_GUI_SIZE_NORMAL_WINDOW Constant Public Type reference (TYPE) CHAR20 'Normal Window' Normal GUI size 20061026
40 SC_HEADER_CONFIGURATION Constant Protected Type reference (TYPE) CHAR20 '[Configuration]' Header for configuration 20061031
41 SC_HEADER_FUNCTION Constant Protected Type reference (TYPE) CHAR20 '[Function]' Header for function 20061023
42 SC_HEADER_OPTIONS Constant Protected Type reference (TYPE) CHAR20 '[Options]' Header for options 20061023
43 SC_HEADER_SNC Constant Protected Type reference (TYPE) CHAR20 '[SNC]' Header for SNC 20061031
44 SC_HEADER_SYSTEM Constant Protected Type reference (TYPE) CHAR20 '[System]' Header for system 20061023
45 SC_HEADER_USER Constant Protected Type reference (TYPE) CHAR20 '[User]' Header for user 20061023
46 SC_LOCAL_SYSTEM Constant Public Type reference (TYPE) RFCDEST 'NONE' Local system as RFC destination 20070412
47 SC_NO_TRACE Constant Public Type reference (TYPE) ESH_E_IF_NUMC1 '0' Num1 20061025
48 SC_QUOTATION Constant Protected Type reference (TYPE) CHAR4 '"' Quotation 20070412
49 SC_SNC_QOP_MAXIMUM Constant Public Type reference (TYPE) SNC_QOP '9' SNC: Quality of protection 20061026
50 SC_SNC_QOP_NO Constant Public Type reference (TYPE) SNC_QOP '0' SNC: Quality of protection 20061026
51 SC_SYSTEM_DEF_APP_SERVER Constant Protected Type reference (TYPE) CHAR1 'A' System by application server and system number 20061031
52 SC_SYSTEM_DEF_GATEWAY_MSGSRV Constant Protected Type reference (TYPE) CHAR1 'R' System by gateway(s), message server, service, and group 20061031
53 SC_SYSTEM_DEF_GROUP Constant Protected Type reference (TYPE) CHAR1 'G' System by system ID and logon group 20061031
54 SC_SYSTEM_DEF_LOGON_ENTRY Constant Protected Type reference (TYPE) CHAR1 'L' System by SAP Logon entry 20061031
55 SC_SYSTEM_DEF_MSGSRV_GROUP Constant Protected Type reference (TYPE) CHAR1 'M' System by message server and logon group 20061031
Methods
# Method Level Visibility Method type Description Created on
1 CREATE_COMMAND Instance method Protected Method Create command string 20061031
2 CREATE_GUIPARM Instance method Protected Method Create GUI parameters 20061031
3 GET_SHORTCUT Instance method Public Method Get shortcut 20061031
4 GET_SYSTEM_NUMBER Static method Protected Method 20070412
5 SET_FUNCTION_REPORT Instance method Public Method Set report as target function 20061024
6 SET_FUNCTION_SYSTEM_COMMAND Instance method Public Method Set system command as target function 20061024
7 SET_FUNCTION_TRANSACTION Instance method Public Method Set transaction as target function 20061024
8 SET_LOGIN Instance method Public Method Set logon data 20061027
9 SET_LOGIN_WITH_RFC_DEST Instance method Public Method Set logon data 20070412
10 SET_OPTIONS Instance method Public Method Set general options 20061024
11 SET_SYSTEM_WITH_APP_SERVER Instance method Public Method Set system by application server and system number 20061024
12 SET_SYSTEM_WITH_GATEWAY_MSGSRV Instance method Public Method Set system by gateway(s), message server, service, and group 20061024
13 SET_SYSTEM_WITH_GROUP Instance method Public Method Set system by system ID and logon group 20061024
14 SET_SYSTEM_WITH_LOCAL_SYS Instance method Public Method Set system with R/3 RFC destination 20070412
15 SET_SYSTEM_WITH_LOGON_ENTRY Instance method Public Method Set system by an entry in SAP Logon 20061024
16 SET_SYSTEM_WITH_MSGSRV_GROUP Instance method Public Method Set system by message server and logon group 20061024
17 SET_SYSTEM_WITH_RFC_DEST Instance method Public Method Set system with R/3 RFC cestination 20061106
Events
Class CL_ESH_IF_SAP_SHORTCUT has no event.
Types
Class CL_ESH_IF_SAP_SHORTCUT has no local type.
Method Signatures

Method CREATE_COMMAND Signature

Method CREATE_COMMAND on class CL_ESH_IF_SAP_SHORTCUT has no parameter.
Method CREATE_COMMAND on class CL_ESH_IF_SAP_SHORTCUT has no exception.

Method CREATE_GUIPARM Signature

Method CREATE_GUIPARM on class CL_ESH_IF_SAP_SHORTCUT has no parameter.
Method CREATE_GUIPARM on class CL_ESH_IF_SAP_SHORTCUT has no exception.

Method GET_SHORTCUT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_SHORTCUT Call by reference Type reference (TYPE) STRING_TABLE Table of Strings 20061031

Method GET_SHORTCUT on class CL_ESH_IF_SAP_SHORTCUT has no exception.

Method GET_SYSTEM_NUMBER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_HOST Call by reference Type reference (TYPE) STUNHOST 20070412
2 Returning RV_SYSTEM_NUMBER Value transfer Type reference (TYPE) SAPWLSYSNO SAP Workload: instance number of an SAP instance 20070412

Method GET_SYSTEM_NUMBER on class CL_ESH_IF_SAP_SHORTCUT has no exception.

Method SET_FUNCTION_REPORT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_REPORT_NAME Call by reference Type reference (TYPE) PROGRAMM ABAP Program Name 20061031
2 Importing IV_REPORT_VARIANT Call by reference Type reference (TYPE) RALDB_VARI Variant Name 20061031
3 Importing IV_TITLE Call by reference Type reference (TYPE) STRING Title 20061031

Method SET_FUNCTION_REPORT on class CL_ESH_IF_SAP_SHORTCUT has no exception.

Method SET_FUNCTION_SYSTEM_COMMAND Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_SYSTEM_COMMAND Call by reference Type reference (TYPE) CHAR70 System Command 20061031
2 Importing IV_TITLE Call by reference Type reference (TYPE) STRING Title 20061031

Method SET_FUNCTION_SYSTEM_COMMAND on class CL_ESH_IF_SAP_SHORTCUT has no exception.

Method SET_FUNCTION_TRANSACTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_FIELDS Call by reference Type reference (TYPE) ESH_T_IF_DYNPRO_FIELD_VALUES Dynpro Selection Fields: Name-Value-Pairs 20061031
2 Importing IV_PARAMETER_STRING Call by reference Type reference (TYPE) STRING Dynpro Selection Fields in internal format 20081007
3 Importing IV_SKIP_INITIAL_SCREEN Call by reference Type reference (TYPE) XFELD ABAP_FALSE Skip initial screen of transaction 20061031
4 Importing IV_TITLE Call by reference Type reference (TYPE) STRING Title 20061031
5 Importing IV_TRANSACTION_CODE Call by reference Type reference (TYPE) TCODE Transaction Code 20061031

Method SET_FUNCTION_TRANSACTION on class CL_ESH_IF_SAP_SHORTCUT has no exception.

Method SET_LOGIN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_LANGUAGE_CODE Call by reference Type reference (TYPE) SYST-LANGU Language Key of Current Text Environment 20061027
2 Importing IV_PASSWORD Call by reference Type reference (TYPE) CHAR12 Password 20061027
3 Importing IV_REMOTE Call by reference Type reference (TYPE) ABAP_BOOL 20100929
4 Importing IV_SNC_PARTNER_NAME Call by reference Type reference (TYPE) SNC_PNAME SNC: Printable name 20061027
5 Importing IV_SNC_QUALITY_OF_PROTECTION Call by reference Type reference (TYPE) SNC_QOP SNC: Quality of protection 20061027
6 Importing IV_USER_ID Call by reference Type reference (TYPE) SYST-UNAME User Name 20061027

Method SET_LOGIN on class CL_ESH_IF_SAP_SHORTCUT has no exception.

Method SET_LOGIN_WITH_RFC_DEST Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_LANGUAGE_CODE Call by reference Type reference (TYPE) SYST-LANGU Language Key of Current Text Environment 20070412
2 Importing IV_PASSWORD Call by reference Type reference (TYPE) CHAR12 Password 20070412
3 Importing IV_RFC_DESTINATION Call by reference Type reference (TYPE) RFCDEST Logical Destination (Specified in Function Call) 20070412
4 Importing IV_USER_DEPENDENT_SNC Call by reference Type reference (TYPE) ABAP_BOOL Set SNC data only if user has SNC string 20090429
5 Importing IV_USER_ID Call by reference Type reference (TYPE) SYST-UNAME User Name 20070412

Method SET_LOGIN_WITH_RFC_DEST on class CL_ESH_IF_SAP_SHORTCUT has no exception.

Method SET_OPTIONS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_GUI_SIZE Call by reference Type reference (TYPE) CHAR20 CL_ESH_IF_SAP_SHORTCUT=>SC_GUI_SIZE_NORMAL_WINDOW Window Size of the GUI 20061026
2 Importing IV_REUSE_EXISTING_CONNECTION Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE Reuse an existing connection 20061024
3 Importing IV_TRACE_LEVEL Call by reference Type reference (TYPE) ESH_E_IF_NUMC1 CL_ESH_IF_SAP_SHORTCUT=>SC_NO_TRACE Diagnose the shortcut program 20061025
4 Importing IV_WORK_DIRECTORY Call by reference Type reference (TYPE) CHAR255 Work directory for the diagnose 20061031

Method SET_OPTIONS on class CL_ESH_IF_SAP_SHORTCUT has no exception.

Method SET_SYSTEM_WITH_APP_SERVER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_APPLICATION_SERVER_NAME Call by reference Type reference (TYPE) MSNAME2 Application Server Name 20061031
2 Importing IV_CLIENT_ID Call by reference Type reference (TYPE) SYST-MANDT System Client 20061026
3 Importing IV_SYSTEM_DESCRIPTION Call by reference Type reference (TYPE) TEXT80 System Description 20061026
4 Importing IV_SYSTEM_ID Call by reference Type reference (TYPE) SYST-SYSID System ID 20061026
5 Importing IV_SYSTEM_NUMBER Call by reference Type reference (TYPE) NUMC2 System Number 20061031

Method SET_SYSTEM_WITH_APP_SERVER on class CL_ESH_IF_SAP_SHORTCUT has no exception.

Method SET_SYSTEM_WITH_GATEWAY_MSGSRV Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_GATEWAY_HOSTS Call by reference Type reference (TYPE) ESH_T_IF_GATEWAY_HOST Gateway Host Names and Services 20061031
2 Importing IV_CLIENT_ID Call by reference Type reference (TYPE) SYST-MANDT System Client 20061026
3 Importing IV_LOGON_GROUP Call by reference Type reference (TYPE) RFCLOAD Logon Group for Load Balancing Mode 20061031
4 Importing IV_MESSAGE_SERVER_NAME Call by reference Type reference (TYPE) RFCHOST_EXT Name of Target Host 20061031
5 Importing IV_SERVICE_PORT Call by reference Type reference (TYPE) I Service Port 20061031
6 Importing IV_SYSTEM_DESCRIPTION Call by reference Type reference (TYPE) TEXT80 System Description 20061026
7 Importing IV_SYSTEM_ID Call by reference Type reference (TYPE) SYST-SYSID System ID 20061026

Method SET_SYSTEM_WITH_GATEWAY_MSGSRV on class CL_ESH_IF_SAP_SHORTCUT has no exception.

Method SET_SYSTEM_WITH_GROUP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_CLIENT_ID Call by reference Type reference (TYPE) SYST-MANDT System Client 20061026
2 Importing IV_LOGON_GROUP Call by reference Type reference (TYPE) RFCLOAD Logon Group for Load Balancing Mode 20061031
3 Importing IV_SYSTEM_DESCRIPTION Call by reference Type reference (TYPE) TEXT80 System Description 20061026
4 Importing IV_SYSTEM_ID Call by reference Type reference (TYPE) SYST-SYSID System ID 20061026

Method SET_SYSTEM_WITH_GROUP on class CL_ESH_IF_SAP_SHORTCUT has no exception.

Method SET_SYSTEM_WITH_LOCAL_SYS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_CLIENT_ID Call by reference Type reference (TYPE) SYST-MANDT System Client 20070412
2 Importing IV_SYSTEM_ID Call by reference Type reference (TYPE) SYST-SYSID System ID 20070412
# Exception Resumable Description Created on
1 CX_ESH_CO_ENGINE Common ESH Engine Exception 20070412

Method SET_SYSTEM_WITH_LOGON_ENTRY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_CLIENT_ID Call by reference Type reference (TYPE) SYST-MANDT System Client 20061025
2 Importing IV_SYSTEM_DESCRIPTION Call by reference Type reference (TYPE) TEXT80 System Description 20061026
3 Importing IV_SYSTEM_ID Call by reference Type reference (TYPE) SYST-SYSID System ID 20061025

Method SET_SYSTEM_WITH_LOGON_ENTRY on class CL_ESH_IF_SAP_SHORTCUT has no exception.

Method SET_SYSTEM_WITH_MSGSRV_GROUP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_CLIENT_ID Call by reference Type reference (TYPE) SYST-MANDT System Client 20061026
2 Importing IV_LOGON_GROUP Call by reference Type reference (TYPE) RFCLOAD Logon Group for Load Balancing Mode 20061031
3 Importing IV_MESSAGE_SERVER_NAME Call by reference Type reference (TYPE) RFCHOST_EXT Name of Target Host 20061031
4 Importing IV_SYSTEM_DESCRIPTION Call by reference Type reference (TYPE) TEXT80 System Description 20061026
5 Importing IV_SYSTEM_ID Call by reference Type reference (TYPE) SYST-SYSID System ID 20061026

Method SET_SYSTEM_WITH_MSGSRV_GROUP on class CL_ESH_IF_SAP_SHORTCUT has no exception.

Method SET_SYSTEM_WITH_RFC_DEST Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_CLIENT_ID Call by reference Type reference (TYPE) SYST-MANDT System Client 20061106
2 Importing IV_RFC_DESTINATION Call by reference Type reference (TYPE) RFCDEST Logical Destination (Specified in Function Call) 20061106
3 Importing IV_SYSTEM_ID Call by reference Type reference (TYPE) SYST-SYSID System ID 20061106
# Exception Resumable Description Created on
1 CX_ESH_CO_ENGINE Common ESH Engine Exception 20061106
History
Last changed by/on SAP  20110908 
SAP Release Created in 0.9