SAP ABAP Class CL_NWBC_SAPGUI_SHORTCUT (SAPGUI Shortcut)
Hierarchy
☛
SAP_UI (Software Component) User Interface Technology
⤷
BC-FES-BUS (Application Component) Netweaver Business Client
⤷
SAP_NWBC (Package) NetWeaver Business Client
⤷
⤷
Properties
| Class | CL_NWBC_SAPGUI_SHORTCUT | |
| Short Description | SAPGUI Shortcut | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SAP_NWBC | NetWeaver Business Client |
| Created | 20130318 | SAP |
| Last change | 20131127 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_NWBC_SAPGUI_SHORTCUT has no interface implemented.
Friends
Class CL_NWBC_SAPGUI_SHORTCUT has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Public | See coding | 20130412 | |||||
| 2 | Instance attribute | Protected | Type reference (TYPE) | T_GATEWAY_HOSTS | Gateway host names and services | 20130412 | |||
| 3 | Instance attribute | Protected | Type reference (TYPE) | TIHTTPNVP | Dynpro selection fields: Name-value pairs | 20130412 | |||
| 4 | Instance attribute | Protected | Type reference (TYPE) | RFCDISPLAY-RFCHOST | Application server | 20130412 | |||
| 5 | Instance attribute | Protected | Type reference (TYPE) | SYST-MANDT | System client | 20130412 | |||
| 6 | Instance attribute | Protected | Type reference (TYPE) | RZLLI_APCL | Logon group | 20130412 | |||
| 7 | Instance attribute | Protected | Type reference (TYPE) | CHAR20 | GUI size | 20130412 | |||
| 8 | Instance attribute | Protected | Type reference (TYPE) | SYST-LANGU | Language key | 20130412 | |||
| 9 | Instance attribute | Protected | Type reference (TYPE) | RFCLOAD | Logon group for load-balancing mode | 20130412 | |||
| 10 | Instance attribute | Protected | Type reference (TYPE) | RFCHOST_EXT | Message server | 20130412 | |||
| 11 | Instance attribute | Protected | Type reference (TYPE) | CHAR12 | Password | 20130412 | |||
| 12 | Instance attribute | Protected | Type reference (TYPE) | PROGRAMM | ABAP program name | 20130412 | |||
| 13 | Instance attribute | Protected | Type reference (TYPE) | RALDB_VARI | Variant name | 20130412 | |||
| 14 | Instance attribute | Protected | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Reuse connection | 20130412 | ||
| 15 | Instance attribute | Protected | Type reference (TYPE) | I | Service port | 20130412 | |||
| 16 | Instance attribute | Protected | Type reference (TYPE) | XFELD | Skip initial screen of transaction | 20130412 | |||
| 17 | Instance attribute | Protected | Type reference (TYPE) | STRING | SNC name | 20130412 | |||
| 18 | Instance attribute | Protected | Type reference (TYPE) | SNC_QOP | SNC: Quality of protection | 20130412 | |||
| 19 | Instance attribute | Private | Type reference (TYPE) | STRING | SSO Cookie | 20130412 | |||
| 20 | Instance attribute | Protected | Type reference (TYPE) | CHAR255 | System name | 20130412 | |||
| 21 | Instance attribute | Protected | Type reference (TYPE) | CHAR70 | System command | 20130412 | |||
| 22 | Instance attribute | Protected | Type reference (TYPE) | TEXT80 | System description | 20130412 | |||
| 23 | Instance attribute | Protected | Type reference (TYPE) | SYST-SYSID | System ID | 20130412 | |||
| 24 | Instance attribute | Protected | Type reference (TYPE) | RFCDISPLAY-RFCSERVICE | System number | 20130412 | |||
| 25 | Instance attribute | Protected | Type reference (TYPE) | STRING | Title | 20130412 | |||
| 26 | Instance attribute | Protected | Type reference (TYPE) | CHAR1 | Trace | 20130412 | |||
| 27 | Instance attribute | Protected | Type reference (TYPE) | TCODE | Transaction code | 20130412 | |||
| 28 | Instance attribute | Protected | Type reference (TYPE) | SYST-UNAME | User name | 20130412 | |||
| 29 | Instance attribute | Protected | Type reference (TYPE) | CHAR255 | Work directory | 20130412 | |||
| 30 | Constant | Protected | Type reference (TYPE) | CHAR4 | '''' | Apostrophe | 20130412 | ||
| 31 | Constant | Protected | Type reference (TYPE) | CHAR20 | 'Report' | Function type report | 20130412 | ||
| 32 | Constant | Protected | Type reference (TYPE) | CHAR20 | 'SystemCommand' | Function type system command | 20130412 | ||
| 33 | Constant | Protected | Type reference (TYPE) | CHAR20 | 'Transaction' | Function type transaction | 20130412 | ||
| 34 | Constant | Public | Type reference (TYPE) | CHAR20 | 'Maximized' | Maximized GUI size | 20130412 | ||
| 35 | Constant | Public | Type reference (TYPE) | CHAR20 | 'Normal Window' | Normal GUI size | 20130412 | ||
| 36 | Constant | Protected | Type reference (TYPE) | CHAR20 | 'Configuration' | Header for configuration | 20130412 | ||
| 37 | Constant | Protected | Type reference (TYPE) | CHAR20 | 'Function' | Header for function | 20130412 | ||
| 38 | Constant | Protected | Type reference (TYPE) | CHAR20 | 'Options' | Header for options | 20130412 | ||
| 39 | Constant | Protected | Type reference (TYPE) | CHAR20 | 'SNC' | Header for SNC | 20130412 | ||
| 40 | Constant | Protected | Type reference (TYPE) | CHAR20 | 'System' | Header for system | 20130412 | ||
| 41 | Constant | Protected | Type reference (TYPE) | CHAR20 | 'User' | Header for user | 20130412 | ||
| 42 | Constant | Protected | Type reference (TYPE) | RFCDEST | 'NONE' | Local system as RFC destination | 20130412 | ||
| 43 | Constant | Public | Type reference (TYPE) | N | '0' | Num1 | 20130412 | ||
| 44 | Constant | Protected | Type reference (TYPE) | CHAR4 | '"' | Quotation | 20130412 | ||
| 45 | Constant | Public | Type reference (TYPE) | SNC_QOP | '9' | SNC: Quality of protection | 20130412 | ||
| 46 | Constant | Public | Type reference (TYPE) | SNC_QOP | '0' | SNC: Quality of protection | 20130412 | ||
| 47 | Constant | Protected | Type reference (TYPE) | CHAR1 | 'A' | System by application server and system number | 20130412 | ||
| 48 | Constant | Protected | Type reference (TYPE) | CHAR1 | 'R' | System by gateway(s), message server, service, and group | 20130412 | ||
| 49 | Constant | Protected | Type reference (TYPE) | CHAR1 | 'G' | System by system ID and logon group | 20130412 | ||
| 50 | Constant | Protected | Type reference (TYPE) | CHAR1 | 'L' | System by SAP Logon entry | 20130412 | ||
| 51 | Constant | Protected | Type reference (TYPE) | CHAR1 | 'M' | System by message server and logon group | 20130412 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Protected | Method | Adds header to shortcut table | 20130412 | |
| 2 | Static method | Protected | Method | Adds new option to shortcut table | 20130412 | |
| 3 | Static method | Private | Method | Adds URL parameter to paramater table | 20130412 | |
| 4 | Instance method | Public | Constructor | CONSTRUCTOR | 20130412 | |
| 5 | Static method | Protected | Method | Create SAP GUI transaction string | 20130412 | |
| 6 | Instance method | Protected | Method | Constructs GUI command string | 20130412 | |
| 7 | Instance method | Protected | Method | Constructs GUI command type string | 20130412 | |
| 8 | Instance method | Protected | Method | Constructs GUI parameter string | 20130412 | |
| 9 | Instance method | Public | Method | Get shortcut | 20130412 | |
| 10 | Static method | Protected | Method | 20130412 | ||
| 11 | Static method | Protected | Method | Surround text by predefined symbols | 20130412 | |
| 12 | Static method | Public | Method | Generate SAPGUI Link url | 20130412 |
Events
Class CL_NWBC_SAPGUI_SHORTCUT has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | T_GATEWAY_HOST | Public | See coding | 20130412 | BEGIN OF t_gateway_host,
router TYPE rfcgwhost,
routerservice TYPE rfcgwserv,
END OF t_gateway_host
|
||
| 2 | T_GATEWAY_HOSTS | Public | See coding | 20130412 | t_gateway_hosts TYPE STANDARD TABLE OF t_gateway_host WITH KEY router
|
Method Signatures
Method ADD_HEADER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DATA | Call by reference | Type reference (TYPE) | STRING_TABLE | Shortcut data table | 20130412 | |||
| 2 | HEADER | Call by reference | Type reference (TYPE) | CSEQUENCE | Parameter value | 20130412 |
Method ADD_HEADER on class CL_NWBC_SAPGUI_SHORTCUT has no exception.
Method ADD_OPTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DATA | Call by reference | Type reference (TYPE) | STRING_TABLE | Shortcut data table | 20130412 | |||
| 2 | NAME | Call by reference | Type reference (TYPE) | CSEQUENCE | Parameter name | 20130412 | |||
| 3 | VALUE | Call by reference | Type reference (TYPE) | CSEQUENCE | Parameter value | 20130412 |
Method ADD_OPTION on class CL_NWBC_SAPGUI_SHORTCUT has no exception.
Method ADD_URL_PARAM Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DEFAULT | Call by reference | Type reference (TYPE) | CSEQUENCE | Default value | 20130412 | |||
| 2 | FIELDS | Call by reference | Type reference (TYPE) | TIHTTPNVP | Parameters table | 20130412 | |||
| 3 | NAME | Call by reference | Type reference (TYPE) | CSEQUENCE | Parameter name | 20130412 | |||
| 4 | VALUE | Call by reference | Type reference (TYPE) | CSEQUENCE | Paramater value | 20130412 |
Method ADD_URL_PARAM on class CL_NWBC_SAPGUI_SHORTCUT has no exception.
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_GATEWAY_HOSTS | Call by reference | Type reference (TYPE) | T_GATEWAY_HOSTS | Gateway Host Names and Services | 20130412 | |||
| 2 | IT_PARAMETERS | Call by reference | Type reference (TYPE) | TIHTTPNVP | Dynpro Selection Fields: Name-Value-Pairs | 20130412 | |||
| 3 | IV_APPLICATION_SERVER_NAME | Call by reference | Type reference (TYPE) | RFCDISPLAY-RFCHOST | Application Server Name | 20130412 | |||
| 4 | IV_CLIENT_ID | Call by reference | Type reference (TYPE) | SYST-MANDT | SY-MANDT | System Client | 20130412 | ||
| 5 | IV_GUI_SIZE | Call by reference | Type reference (TYPE) | CHAR20 | CL_NWBC_SAPGUI_SHORTCUT=>SC_GUI_SIZE_NORMAL_WINDOW | Window Size of the GUI | 20130412 | ||
| 6 | IV_LANGUAGE | Call by reference | Type reference (TYPE) | SYST-LANGU | SY-LANGU | Language Key of Current Text Environment | 20130412 | ||
| 7 | IV_LOGON_GROUP | Call by reference | Type reference (TYPE) | RFCLOAD | Logon Group for Load Balancing Mode | 20130412 | |||
| 8 | IV_MESSAGE_SERVER_NAME | Call by reference | Type reference (TYPE) | RFCHOST_EXT | Name of Target Host | 20130412 | |||
| 9 | IV_PASSWORD | Call by reference | Type reference (TYPE) | CHAR12 | Password | 20130412 | |||
| 10 | IV_REPORT_NAME | Call by reference | Type reference (TYPE) | PROGRAMM | ABAP Program Name | 20130412 | |||
| 11 | IV_REPORT_VARIANT | Call by reference | Type reference (TYPE) | RALDB_VARI | Variant Name | 20130412 | |||
| 12 | IV_REUSE_EXISTING_CONNECTION | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Reuse an existing connection | 20130412 | ||
| 13 | IV_SERVICE_PORT | Call by reference | Type reference (TYPE) | I | Service Port | 20130412 | |||
| 14 | IV_SKIP_INITIAL_SCREEN | Call by reference | Type reference (TYPE) | XFELD | ABAP_FALSE | Skip initial screen of transaction | 20130412 | ||
| 15 | IV_SM59_DESTINATION | Call by reference | Type reference (TYPE) | RFCDEST | Logical Destination (Specified in Function Call) | 20130412 | |||
| 16 | IV_SYSTEM_COMMAND | Call by reference | Type reference (TYPE) | CHAR70 | System Command | 20130412 | |||
| 17 | IV_SYSTEM_DESCRIPTION | Call by reference | Type reference (TYPE) | TEXT80 | System Description | 20130412 | |||
| 18 | IV_SYSTEM_ID | Call by reference | Type reference (TYPE) | SYST-SYSID | SY-SYSID | System ID | 20130412 | ||
| 19 | IV_SYSTEM_NUMBER | Call by reference | Type reference (TYPE) | RFCDISPLAY-RFCSERVICE | System Number | 20130412 | |||
| 20 | IV_TITLE | Call by reference | Type reference (TYPE) | STRING | Title | 20130412 | |||
| 21 | IV_TRACE_LEVEL | Call by reference | Type reference (TYPE) | N | CL_NWBC_SAPGUI_SHORTCUT=>SC_NO_TRACE | Diagnose the shortcut program | 20130412 | ||
| 22 | IV_TRANSACTION_CODE | Call by reference | Type reference (TYPE) | TCODE | Transaction Code | 20130412 | |||
| 23 | IV_USER_ID | Call by reference | Type reference (TYPE) | SYST-UNAME | SY-UNAME | User Name | 20130412 | ||
| 24 | IV_WORK_DIRECTORY | Call by reference | Type reference (TYPE) | CHAR255 | Work directory for the diagnose | 20130412 |
Method CONSTRUCTOR on class CL_NWBC_SAPGUI_SHORTCUT has no exception.
Method CREATE_TRANSACTION_STRING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | PARAMETERS | Call by reference | Type reference (TYPE) | TIHTTPNVP | Dynpro selection fields: Name-value pairs | 20130412 | |||
| 2 | RV | Value transfer | Type reference (TYPE) | STRING | Transaction string | 20130412 | |||
| 3 | SKIP_SELECTION | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Skip selectio nscreen indicator | 20130412 | ||
| 4 | TRANSACTION_CODE | Call by reference | Type reference (TYPE) | TCODE | Transaction Code | 20130412 |
Method CREATE_TRANSACTION_STRING on class CL_NWBC_SAPGUI_SHORTCUT has no exception.
Method GET_COMMAND_STRING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_COMMAND | Value transfer | Type reference (TYPE) | STRING | 20130412 |
Method GET_COMMAND_STRING on class CL_NWBC_SAPGUI_SHORTCUT has no exception.
Method GET_COMMAND_TYPE_STRING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_COMMAND_TYPE | Value transfer | Type reference (TYPE) | STRING | 20130412 |
Method GET_COMMAND_TYPE_STRING on class CL_NWBC_SAPGUI_SHORTCUT has no exception.
Method GET_GUI_PARAM_STRING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_PARAMETERS | Value transfer | Type reference (TYPE) | STRING | 20130412 |
Method GET_GUI_PARAM_STRING on class CL_NWBC_SAPGUI_SHORTCUT has no exception.
Method GET_SHORTCUT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_SHORTCUT | Call by reference | Type reference (TYPE) | STRING_TABLE | Table of Strings | 20130412 |
Method GET_SHORTCUT on class CL_NWBC_SAPGUI_SHORTCUT has no exception.
Method GET_SYSTEM_NUMBER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_HOST | Call by reference | Type reference (TYPE) | STUNHOST | 20130412 | ||||
| 2 | RV_SYSTEM_NUMBER | Value transfer | Type reference (TYPE) | SAPWLSYSNO | SAP Workload: instance number of an SAP instance | 20130412 |
Method GET_SYSTEM_NUMBER on class CL_NWBC_SAPGUI_SHORTCUT has no exception.
Method SURROUND Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | BLANKS | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Respect blanks | 20130412 | ||
| 2 | RV | Value transfer | Type reference (TYPE) | STRING | Surrounded string | 20130412 | |||
| 3 | SYMBOL | Call by reference | Type reference (TYPE) | CSEQUENCE | SC_APOSTROPHE | Prefix/Suffix string | 20130412 | ||
| 4 | TEXT | Call by reference | Type reference (TYPE) | CSEQUENCE | Text to be surrounded | 20130412 |
Method SURROUND on class CL_NWBC_SAPGUI_SHORTCUT has no exception.
Method URL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_GATEWAY_HOSTS | Call by reference | Type reference (TYPE) | T_GATEWAY_HOSTS | Gateway Host Names and Services | 20130412 | |||
| 2 | IT_PARAMETERS | Call by reference | Type reference (TYPE) | TIHTTPNVP | Dynpro Selection Fields: Name-Value-Pairs | 20130412 | |||
| 3 | IV_APPLICATION_SERVER_NAME | Call by reference | Type reference (TYPE) | RFCDISPLAY-RFCHOST | Application Server Name | 20130412 | |||
| 4 | IV_CLIENT_ID | Call by reference | Type reference (TYPE) | SYST-MANDT | SY-MANDT | System Client | 20130412 | ||
| 5 | IV_GUI_SIZE | Call by reference | Type reference (TYPE) | CHAR20 | CL_NWBC_SAPGUI_SHORTCUT=>SC_GUI_SIZE_NORMAL_WINDOW | Window Size of the GUI | 20130412 | ||
| 6 | IV_LANGUAGE | Call by reference | Type reference (TYPE) | SYST-LANGU | SY-LANGU | Language Key of Current Text Environment | 20130412 | ||
| 7 | IV_LOGON_GROUP | Call by reference | Type reference (TYPE) | RFCLOAD | Logon Group for Load Balancing Mode | 20130412 | |||
| 8 | IV_MESSAGE_SERVER_NAME | Call by reference | Type reference (TYPE) | RFCHOST_EXT | Name of Target Host | 20130412 | |||
| 9 | IV_PASSWORD | Call by reference | Type reference (TYPE) | CHAR12 | Password | 20130412 | |||
| 10 | IV_REPORT_NAME | Call by reference | Type reference (TYPE) | PROGRAMM | ABAP Program Name | 20130412 | |||
| 11 | IV_REPORT_VARIANT | Call by reference | Type reference (TYPE) | RALDB_VARI | Variant Name | 20130412 | |||
| 12 | IV_REUSE_EXISTING_CONNECTION | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Reuse an existing connection | 20130412 | ||
| 13 | IV_SERVER | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_SERVER | Use for determining proxies in network | 20130412 | |||
| 14 | IV_SERVER_RELATIVE_URL | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Use server relative form instead of fully qulified | 20130412 | ||
| 15 | IV_SERVICE_PORT | Call by reference | Type reference (TYPE) | I | Service Port | 20130412 | |||
| 16 | IV_SKIP_INITIAL_SCREEN | Call by reference | Type reference (TYPE) | XFELD | ABAP_FALSE | Skip initial screen of transaction | 20130412 | ||
| 17 | IV_SM59_DESTINATION | Call by reference | Type reference (TYPE) | RFCDEST | Logical Destination (Specified in Function Call) | 20130412 | |||
| 18 | IV_SYSTEM_COMMAND | Call by reference | Type reference (TYPE) | CHAR70 | System Command | 20130412 | |||
| 19 | IV_SYSTEM_DESCRIPTION | Call by reference | Type reference (TYPE) | TEXT80 | System Description | 20130412 | |||
| 20 | IV_SYSTEM_ID | Call by reference | Type reference (TYPE) | SYST-SYSID | SY-SYSID | System ID | 20130412 | ||
| 21 | IV_SYSTEM_NUMBER | Call by reference | Type reference (TYPE) | RFCDISPLAY-RFCSERVICE | System Number | 20130412 | |||
| 22 | IV_TITLE | Call by reference | Type reference (TYPE) | STRING | Title | 20130412 | |||
| 23 | IV_TRACE_LEVEL | Call by reference | Type reference (TYPE) | N | CL_NWBC_SAPGUI_SHORTCUT=>SC_NO_TRACE | Diagnose the shortcut program | 20130412 | ||
| 24 | IV_TRANSACTION_CODE | Call by reference | Type reference (TYPE) | TCODE | Transaction Code | 20130412 | |||
| 25 | IV_USER_ID | Call by reference | Type reference (TYPE) | SYST-UNAME | SY-UNAME | User Name | 20130412 | ||
| 26 | IV_WORK_DIRECTORY | Call by reference | Type reference (TYPE) | CHAR255 | Work directory for the diagnose | 20130412 | |||
| 27 | RV_URL | Value transfer | Type reference (TYPE) | STRING | Resulting URL | 20130412 |
Method URL on class CL_NWBC_SAPGUI_SHORTCUT has no exception.
History
| Last changed by/on | SAP | 20131127 |
| SAP Release Created in |