SAP ABAP Interface /UI2/IF_NWBC_RUNTIME (The NWBC Runtime Interface)
Hierarchy
☛
SAP_UI (Software Component) User Interface Technology
⤷
CA-UI2-INT-BE (Application Component) Backend Enablement
⤷
/UI2/NWBC_CORE (Package) NetWeaver Business Client - Core Functionality
SAP_UI (Software Component) User Interface Technology⤷
CA-UI2-INT-BE (Application Component) Backend Enablement⤷
/UI2/NWBC_CORE (Package) NetWeaver Business Client - Core Functionality
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface composition (i COMPRISING i_ref) | /UI2/IF_NWBC_RUNTIME35 | The NWBC Runtime Interface | 20120822 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | /UI2/CL_NWBC_RUNTIME35 | Business Client Runtime v3.5 | 20120828 |
Properties
| Interface | /UI2/IF_NWBC_RUNTIME | |
| Short Description | The NWBC Runtime Interface |
General Data
| Package | /UI2/NWBC_CORE | NetWeaver Business Client - Core Functionality |
| Created | 20120820 | SAP |
| Last changed | 20141121 | |
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | /UI2/IF_NWBC_CONSTANTS | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 2 | /UI2/IF_NWBC_RUNTIME | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 3 | /UI2/IF_NWBC_RUNTIME35 | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 4 | ABAP | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Interface /UI2/IF_NWBC_RUNTIME has no interface.
Friends
Interface /UI2/IF_NWBC_RUNTIME has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | BASE_URL | Instance attribute | Public | Type reference (TYPE) | STRING | /start-up URL/ (with trailing'/') | 20120822 | ||
| 2 | COCKPIT | Instance attribute | Public | Type reference (TYPE) | STRING | 20120822 | |||
| 3 | COCKPIT_ROLE_FILTER | Constant | Public | Type reference (TYPE) | STRING | 'NWBC_ROLETEST' | Name of role test cockpit | 20120822 | |
| 4 | COCKPIT_ROLE_FILTER_ALIAS | Constant | Public | Type reference (TYPE) | STRING | '~roletest' | Alias of role test cockpit | 20120822 | |
| 5 | COCKPIT_SAPGUILINK | Constant | Public | Type reference (TYPE) | STRING | 'NWBC_SAPGUILINK' | 20130418 | ||
| 6 | COCKPIT_SAPGUILINK_ALIAS | Constant | Public | Type reference (TYPE) | STRING | '~sapguilink' | 20130418 | ||
| 7 | COCKPIT_UPPERCASE | Instance attribute | Public | Type reference (TYPE) | STRING | 20120822 | |||
| 8 | CORE | Instance attribute | Public | Object reference (TYPE REF TO) | /UI2/IF_NWBC_RUNTIME_CORE | The NWBC Runtime Interface (Core Functionality) | 20120822 | ||
| 9 | E_CLIENT_TYPE | Constant | Public | See coding | 20120822 | ||||
| 10 | E_CLIENT_TYPE_SAPGUI | Constant | Public | See coding | 20120822 | ||||
| 11 | E_CONFIG_BUSINESS_LINE | Constant | Public | See coding | 20120822 | ||||
| 12 | E_CONFIG_NAMES | Constant | Public | See coding | 20120822 | ||||
| 13 | E_REPORT_TYPE | Constant | Public | See coding | 20120822 | ||||
| 14 | E_ROLE_ATTRIBUTE_NAMES | Constant | Public | See coding | 20120822 | ||||
| 15 | FULL_QUALIFIED_BASE_URL | Instance attribute | Public | Type reference (TYPE) | STRING | http(s)://host:port/base_url/ | 20120822 | ||
| 16 | FULL_QUALIFIED_HOST | Instance attribute | Public | Type reference (TYPE) | STRING | http(s)://host:port | 20120822 | ||
| 17 | ICF_BASE_URL | Instance attribute | Public | Type reference (TYPE) | STRING | Direct ICF Path: /start-up URL/ (trailing'/') | 20120822 | ||
| 18 | NWBC_SHELL | Instance attribute | Public | Type reference (TYPE) | STRING | cl_nwbc=>for_desktop | cl_nwbc=>for_html | 20120822 | ||
| 19 | PATCH_LEVEL | Constant | Public | Type reference (TYPE) | STRING | '41' | 20120822 | ||
| 20 | PATH_FILTER | Instance attribute | Public | Type reference (TYPE) | STRING | Contains current role or current cockpit | 20130418 | ||
| 21 | ROLE_FILTER | Instance attribute | Public | Type reference (TYPE) | STRING | Only this role active | 20120822 | ||
| 22 | RUNTIME_LOAD | Instance attribute | Public | Type reference (TYPE) | STRING | Name of ZNWBC if active | 20120822 | ||
| 23 | SAP_RELEASE_702_PLUS | Instance attribute | Public | Type reference (TYPE) | ABAP_BOOL | >= 7.02? | 20120822 | ||
| 24 | SERVER | Instance attribute | Public | Object reference (TYPE REF TO) | IF_HTTP_SERVER | HTTP Framework (iHTTP) HTTP Server | 20120822 | ||
| 25 | SPECIAL_ICF_NODES | Constant | Public | Type reference (TYPE) | STRING | 'nwbc_test/nwbc_launch/nwbc_testcanvas/nwbc_sapguilink/exprt_sapportal/exprt_atom/nwbc_debug' | 20120822 | ||
| 26 | URL | Instance attribute | Public | Object reference (TYPE REF TO) | /UI2/CL_URL | URL Generator for different frames in one | 20120822 | ||
| 27 | VERSION | Constant | Public | Type reference (TYPE) | STRING | `3.6.23` | Release.Transport.Testtransport | 20120822 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | EPCM_DO_NAVIGATE |
Instance method | Public | Method | Directly resolve EPCM.doNavigate | 20120822 |
| 2 | EPCM_DO_OBJECT_BASED_NAVIGATE |
Instance method | Public | Method | Directly resolve EPCM.doObjBasedNavigate | 20120822 |
| 3 | GET_ALL_RUNTIME_INFO |
Instance method | Public | Method | Export all NWBC runtime data in our call | 20120822 |
| 4 | GET_COCKPITS |
Instance method | Public | Method | Retrieve list of configured cockpits | 20120822 |
| 5 | GET_COCKPITS_WITH_ROLES |
Instance method | Public | Method | Return all roles for all cockpits | 20120822 |
| 6 | GET_CONFIGURATION |
Instance method | Public | Method | Return if_nwbc_runtime=>e_config_names~* | 20120822 |
| 7 | GET_MIMES |
Instance method | Public | Method | 20130418 | |
| 8 | GET_NAVIGATION_TREE |
Instance method | Public | Method | List of all menus configured over all roles | 20120822 |
| 9 | GET_OBN_TARGETS |
Instance method | Public | Method | Returns the complete set of possible OBN targets for roles | 20120822 |
| 10 | GET_ROLES |
Instance method | Public | Method | Returns all roles for this user & cockpit & role_filter | 20120822 |
| 11 | GET_RUNTIME_VERSION |
Instance method | Public | Method | Returns runtime version | 20120822 |
| 12 | GET_SYSTEM_INFO |
Instance method | Public | Method | Return all system relevant information | 20120822 |
| 13 | GET_TROUBLE_SHOOTING_INFO |
Instance method | Public | Method | Gather as much trouble shooting information as possible | 20120822 |
| 14 | GET_USER_INFO |
Instance method | Public | Method | Return small set of user information | 20120822 |
| 15 | GET_USER_ROLES |
Instance method | Public | Method | Returns all roles assigned user & cockpit | 20120822 |
| 16 | HANDLE_API |
Instance method | Public | Method | Handle API calls | 20120822 |
| 17 | IS_CACHE_VALID |
Instance method | Public | Method | Checks if cache of current instance valid | 20130726 |
| 18 | RESOLVE_NAVIGATION |
Instance method | Public | Method | Resolve OBN obj.method or ROLE name:id to object_id navTree | 20120822 |
Events
Interface /UI2/IF_NWBC_RUNTIME has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | T_ALIASES | Public | See coding | 20120822 | t_aliases TYPE STANDARD TABLE OF /ui2/cl_url=>t_sm59_destination WITH DEFAULT KEY
|
||
| 2 | T_ALL_RUNTIME_INFO | Public | See coding | 20120822 | BEGIN OF t_all_runtime_info,
trouble_shooting_info TYPE t_trouble_shooting_info,
system_info TYPE t_system_info,
user_info TYPE t_user_info,
configuration TYPE t_configuration,
cockpits TYPE t_cockpits,
roles TYPE t_roles,
navigation_tree TYPE t_navigation_tree,
obn_targets TYPE t_obn_targets,
cockpits_with_roles TYPE t_cockpits_with_roles,
END OF t_all_runtime_info
|
||
| 3 | T_APPLICATION | Public | See coding | 20120822 | BEGIN OF t_application,
name TYPE string,
description TYPE string,
url_token TYPE string,
END OF t_application
|
||
| 4 | T_APPLICATIONS | Public | See coding | 20120822 | BEGIN OF t_applications,
name TYPE string,
report_type TYPE string, " see e_report_type
url TYPE string,
max_hit_count_used TYPE i,
possibly_more_hits TYPE abap_bool,
applications TYPE STANDARD TABLE OF t_application WITH KEY name,
END OF t_applications
|
||
| 5 | T_ATTRIBUTE | Public | See coding | 20120822 | BEGIN OF t_attribute,
name TYPE string,
value TYPE string,
END OF t_attribute
|
||
| 6 | T_ATTRIBUTES | Public | See coding | 20120822 | t_attributes TYPE STANDARD TABLE OF t_attribute WITH KEY name
|
||
| 7 | T_COCKPIT | Public | See coding | 20120822 | BEGIN OF t_cockpit,
name TYPE string,
name_uppercase TYPE string,
path TYPE string,
text TYPE string,
END OF t_cockpit
|
||
| 8 | T_COCKPITS | Public | See coding | 20120822 | t_cockpits TYPE STANDARD TABLE OF t_cockpit WITH DEFAULT KEY
|
||
| 9 | T_COCKPITS_WITH_ROLES | Public | See coding | 20120822 | t_cockpits_with_roles TYPE STANDARD TABLE OF t_cockpit_with_roles WITH DEFAULT KEY
|
||
| 10 | T_COCKPIT_WITH_ROLES | Public | See coding | 20120822 | BEGIN OF t_cockpit_with_roles,
cockpit TYPE t_cockpit,
role_names TYPE t_role_names,
END OF t_cockpit_with_roles
|
||
| 11 | T_CONFIGURATION | Public | See coding | 20120822 | BEGIN OF t_configuration, "==> DUPLICATE OF SYSTEM INFO ABOVE
runtime_version TYPE string, " cl_nwbc_runtime=>version (currently "3.0.0")
patch_level TYPE string, " NWBC Runtime patch level
base_url TYPE string, " /startup-URL/
full_qualified_base_url TYPE string, " http(s)://server:port/startup-URL/
full_qualified_host TYPE string, " http(s)://server:port
accessibility TYPE abap_bool,
auto_hide_lone_workcenters TYPE abap_bool,
cockpit_title TYPE string, " `COCKPIT_TITLE`
branding_image TYPE string, " `BRANDING_IMAGE`
branding_url TYPE string, " `BRANDING_URL`
css_url TYPE string,
" search_engine TYPE t_parameters, DEPRECATED " `SEARCH_ENGINE`
" help_link TYPE t_parameters, DEPRECATED " `HELP_LINK`
business_line TYPE string, " `BUSINESS_LINE`
cache_discriminator TYPE string,
support_key TYPE string, " 'support key
install_directory TYPE string, " split into two params " URI that points to latest NWBC installation
install_description TYPE string, " description of URI in install_directory
logoff_url TYPE string, " `LOGOFF_URL`
system_type TYPE string, " `SYSTEM_TYPE`
system_repository TYPE string, " `SYSTEM_REPOSITORY`
system_host TYPE string, " `SYSTEM_HOST`
system_id TYPE string, " `SYSTEM_ID`
system_instance TYPE string, " `SYSTEM_INSTANCE`
system_service TYPE string, " `SYSTEM_SERVICE`
system_release TYPE string, " `SYSTEM_RELEASE`
system_sap_basis TYPE string, " `SYSTEM_SAP_BASIS`
system_trouble_shooting_url TYPE string, " `SYSTEM_TROUBLE_SHOOTING_URL`
system_webgui_path TYPE string, " `SYSTEM_WEBGUI_PATH`
theme TYPE string,
" theme_attributes type string, DEPRECATED " Theme attributes
use_browser_cache TYPE abap_bool,
force_browser_standard_mode TYPE string, " Regex to identify URLs that must be rendered in the standard mode
* theme_handler type string, " class name that holds the customer theme information - implements interface /UI2/IF_NWBC_theme_handler
welcome_message TYPE string,
is_emb_reporting_active TYPE abap_bool, " indicates that embedded supprot services are active (SolMan system connected)
system_alias_last_modified TYPE timestamp, " last modified timestamp of system alias data (currently SM59 content)
customer_parameters TYPE t_parameters,
services TYPE t_service_descriptions, " supported services
END OF t_configuration
|
||
| 12 | T_LANG_TEXT | Public | See coding | 20120822 | BEGIN OF t_lang_text,
language TYPE laiso,
text TYPE string,
END OF t_lang_text
|
||
| 13 | T_LANG_TEXTS | Public | See coding | 20120822 | t_lang_texts TYPE STANDARD TABLE OF t_lang_text WITH KEY language
|
||
| 14 | T_MENU_TYPE | Public | See coding | 20120822 | t_menu_type(1) TYPE c
|
||
| 15 | T_NAVIGATION_ENTRY | Public | See coding | 20120822 | BEGIN OF t_navigation_entry,
object_id TYPE string, " node id
unique_id TYPE string, " unique id that is computed to be "stable"
parent_id TYPE string, " parent id
agr_name TYPE agr_name, " role name
origin_id TYPE string, " object_id of the node relative to the role (agr_name)
app_id TYPE string, " unique application identifier
menu_level TYPE string, " tree depth
report_type TYPE string, " see e_report_type
client_type TYPE string, " see e_client_type
sort_order TYPE i, " sort sequence of the tree level
target_system TYPE string, " if this application must be started on a different server
sm59_rfc_dest_name TYPE rfcdes-rfcdest, " the related SM59 destination which contains the RFC data to that different server
url TYPE string, " application URL
url_base TYPE string, " only if /url#hash ==> /url
url_hash TYPE string, " only if /url#hash ==> #hash
is_hidden TYPE abap_bool, " not shown in tree
force_sapgui TYPE abap_bool, " enable native SAPGUI rendering in the browser
window_mode TYPE string, " window mode; values see constant interface
is_report TYPE abap_bool, " special visualisation
is_new_create TYPE abap_bool, " move into "new" menu
is_home_page TYPE abap_bool, " homepage of the parent folder
for_print TYPE abap_bool, " this entry is used to show "printed" documents, new icon in NWBC v1.0
is_service_map TYPE abap_bool, " not used yet
link_collection TYPE abap_bool, " folder is part of link collections
single_top_level TYPE abap_bool, " display only one top level entry, rest on left panel
menu_entry TYPE abap_bool, " these entries belong in top menu
is_search TYPE abap_bool, " entry is a search application
is_seldomly_used TYPE abap_bool, " not often used (will be hidden in menu)
is_side_panel TYPE abap_bool, " entries of the folder are side panels for the parent folder
is_force_dirty TYPE abap_bool, " Brian knows
ref_id TYPE string, " homepage/folder reference (object id)
text TYPE string, " display text
description TYPE string, " tooltip text
icon TYPE string, " icon only relevant for folder root nodes (level=1) when visualized on the shell
icon_for_service_map TYPE string, " icon only relevant for folders when displayed in a service map (48x48)
is_top_level TYPE abap_bool, " set if node is a top level node
" has_children type abap_bool, " set if the node has children
is_disabled TYPE abap_bool, " entry is visible in tree, but disabled
is_emphasized TYPE abap_bool, " entry should be visualized more prominent in tree
inherited TYPE abap_bool, " especially at the moment for link collections, this entry is inherited from a parent node
dont_cache TYPE abap_bool, " only set in extreme cases when entry cant be cached
children_not_loaded TYPE abap_bool, " children of not available yet; skipped probably due to performance reasons
application_alias TYPE string, " a string with no further meaning that applications can configure in PFCG to recognize entries again during BADI call
application_data TYPE string, " additional application data, which is not used as identifier as application_alias
nwbc_context TYPE string, " runtimee encoded string that encodes context for application to know from where it is started
text_texts TYPE t_lang_texts,
description_texts TYPE t_lang_texts,
END OF t_navigation_entry
|
||
| 16 | T_NAVIGATION_TREE | Public | See coding | 20120822 | t_navigation_tree TYPE STANDARD TABLE OF t_navigation_entry WITH KEY object_id
|
||
| 17 | T_NAVIGATION_TREES | Public | See coding | 20120822 | BEGIN OF t_navigation_trees,
user_menu TYPE t_navigation_tree,
user_menu_info TYPE t_navigation_tree_info,
sap_menu TYPE t_navigation_tree,
sap_menu_info TYPE t_navigation_tree_info,
favorites TYPE t_navigation_tree,
favorites_info TYPE t_navigation_tree_info,
END OF t_navigation_trees
|
||
| 18 | T_NAVIGATION_TREE_INFO | Public | See coding | 20120822 | BEGIN OF t_navigation_tree_info,"meta info for a complete set of navigation tree
answer_cachable TYPE abap_bool, " only set in extreme cases when tree cant be cached
sap_menu_active TYPE abap_bool, " set if the user menu contains the sap menu in case no user menu exists
menu_empty TYPE abap_bool, " navigation tree might contain some technical stuff but no workcenters/menu
user_menu_empty TYPE abap_bool, " menu_empty might be true for current navigation tree but would be false for user menu
END OF t_navigation_tree_info
|
||
| 19 | T_NAVIGATION_TREE_SRT | Public | See coding | 20120822 | t_navigation_tree_srt TYPE SORTED TABLE OF t_navigation_entry WITH NON-UNIQUE KEY parent_id sort_order
|
||
| 20 | T_NODES | Public | See coding | 20120822 | t_nodes TYPE STANDARD TABLE OF smensaplng
|
||
| 21 | T_NWBC_CFG_DB_ENTRY | Public | See coding | 20120822 | BEGIN OF t_nwbc_cfg_db_entry,
mandt TYPE mandt,
idx(3) TYPE c, " just three character key that must be unique
cockpit(32) TYPE c, " name of cockpit, matches icf node or '*' = all
name(32) TYPE c, " name of parameter, refer to documentation for possible value
lang TYPE spras, " language key
display TYPE text70, " display text for on screen texts
value TYPE text240, " value of parameter
cockpit_path(132) TYPE c, " absolute path, starting /, as additional optional filter
END OF t_nwbc_cfg_db_entry
|
||
| 22 | T_NWBC_CFG_DB_TABLE | Public | See coding | 20120822 | t_nwbc_cfg_db_table TYPE STANDARD TABLE OF t_nwbc_cfg_db_entry WITH DEFAULT KEY
|
||
| 23 | T_OBJECT_IDS | Public | See coding | 20130117 | t_object_ids TYPE HASHED TABLE OF string WITH UNIQUE DEFAULT KEY
|
||
| 24 | T_OBN_RESOLVE_LOG | Public | See coding | 20120822 | BEGIN OF t_obn_resolve_log ,
source_role TYPE agr_name,
obn_targets TYPE t_obn_targets,
object TYPE string,
method TYPE string,
is_obn TYPE abap_bool,
badi_has_resolved_obn TYPE abap_bool,
obn_resolve_failed TYPE abap_bool,
END OF t_obn_resolve_log
|
||
| 25 | T_OBN_TARGET | Public | See coding | 20120822 | BEGIN OF t_obn_target,
agr_name TYPE agr_name,
object_id TYPE string, " menu_num10
unique_nr TYPE i,
system_alias TYPE string,
object_type TYPE swo_objtyp, " from BOR
object_name TYPE string,
method TYPE swo_verb, " from BOR
method_name TYPE string,
description TYPE string,
priority TYPE i,
parms TYPE string,
END OF t_obn_target
|
||
| 26 | T_OBN_TARGETS | Public | See coding | 20120822 | t_obn_targets TYPE STANDARD TABLE OF t_obn_target WITH DEFAULT KEY
|
||
| 27 | T_PARAMETER | Public | See coding | 20120822 | BEGIN OF t_parameter,
name TYPE string,
display TYPE string,
value TYPE string,
END OF t_parameter
|
||
| 28 | T_PARAMETERS | Public | See coding | 20120822 | t_parameters TYPE STANDARD TABLE OF t_parameter WITH KEY name
|
||
| 29 | T_QUERIED_APPLICATIONS | Public | See coding | 20120822 | BEGIN OF t_queried_applications,
query TYPE string,
transactions TYPE t_applications,
web_dynpro_abaps TYPE t_applications,
fpm_saved_searches TYPE t_applications,
END OF t_queried_applications
|
||
| 30 | T_ROLE | Public | See coding | 20120822 | BEGIN OF t_role,
agr_name TYPE agr_name,
change_date TYPE dats,
change_time TYPE tims,
home_role TYPE abap_bool,
sort_index TYPE i,
name TYPE string,
description TYPE string,
attributes TYPE t_attributes,
name_texts TYPE t_lang_texts,
description_texts TYPE t_lang_texts,
END OF t_role
|
||
| 31 | T_ROLES | Public | See coding | 20120822 | t_roles TYPE STANDARD TABLE OF t_role WITH KEY agr_name
|
||
| 32 | T_ROLES_INFORMATION | Public | See coding | 20120822 | BEGIN OF t_roles_information, "#EC CI_VALPAR
roles TYPE t_roles,
navigation_tree TYPE t_navigation_tree,
obn_targets TYPE t_obn_targets,
aliases TYPE t_aliases,
END OF t_roles_information
|
||
| 33 | T_ROLES_LANG_TEXTS | Public | See coding | 20130418 | t_roles_lang_texts TYPE STANDARD TABLE OF t_role_lang_text WITH KEY language
|
||
| 34 | T_ROLE_IDS | Public | See coding | 20120822 | t_role_ids TYPE STANDARD TABLE OF agr_name WITH DEFAULT KEY
|
||
| 35 | T_ROLE_LANG_TEXT | Public | See coding | 20130418 | BEGIN OF t_role_lang_text,
agr_name TYPE agr_name,
language TYPE laiso,
text TYPE string,
END OF t_role_lang_text
|
||
| 36 | T_ROLE_NAME | Public | See coding | 20120822 | BEGIN OF t_role_name,
agr_name TYPE agr_name,
name TYPE string,
END OF t_role_name
|
||
| 37 | T_ROLE_NAMES | Public | See coding | 20120822 | t_role_names TYPE STANDARD TABLE OF t_role_name WITH DEFAULT KEY
|
||
| 38 | T_SEARCH_ENTRIES | Public | See coding | 20120822 | t_search_entries TYPE STANDARD TABLE OF t_search_entry WITH DEFAULT KEY
|
||
| 39 | T_SEARCH_ENTRY | Public | See coding | 20120822 | BEGIN OF t_search_entry,
display_name TYPE string,
search_url TYPE string,
client_type TYPE string, " see e_client_type
is_enterprise_search TYPE abap_bool,
END OF t_search_entry
|
||
| 40 | T_SERVICE_DESCRIPTIONS | Public | See coding | 20130117 | BEGIN OF t_service_descriptions,
get_associated_apps TYPE string,
get_associated_links TYPE string,
get_associated_searches TYPE string,
get_associated TYPE string,
resolve_system_alias TYPE string,
list_system_aliases TYPE string,
expand_host TYPE string,
END OF t_service_descriptions
|
||
| 41 | T_SYSTEM_INFO | Public | See coding | 20120822 | BEGIN OF t_system_info,
runtime_version TYPE string, " cl_nwbc_runtime=>version (currently "3.0.0")
patch_level TYPE string, " NWBC Runtime patch level
base_url TYPE string, " /startup-URL/
full_qualified_base_url TYPE string, " http(s)://server:port/startup-URL/
full_qualified_host TYPE string, " http(s)://server:port
parameters TYPE t_parameters,
search_entries TYPE t_search_entries,
END OF t_system_info
|
||
| 42 | T_TEXTS | Public | See coding | 20120822 | t_texts TYPE STANDARD TABLE OF smensaplnt
|
||
| 43 | T_TROUBLE_SHOOTING_INFO | Public | See coding | 20120822 | t_trouble_shooting_info TYPE STANDARD TABLE OF t_trouble_shooting_info_test WITH DEFAULT KEY
|
||
| 44 | T_TROUBLE_SHOOTING_INFO_TEST | Public | See coding | 20120822 | BEGIN OF t_trouble_shooting_info_test,
test TYPE string,
help TYPE string,
entries TYPE t_trouble_shooting_test_entrys,
END OF t_trouble_shooting_info_test
|
||
| 45 | T_TROUBLE_SHOOTING_TEST_ENTRY | Public | See coding | 20120822 | BEGIN OF t_trouble_shooting_test_entry,
title TYPE string,
priority TYPE string,
value TYPE string,
status TYPE string,
END OF t_trouble_shooting_test_entry
|
||
| 46 | T_TROUBLE_SHOOTING_TEST_ENTRYS | Public | See coding | 20120822 | t_trouble_shooting_test_entrys TYPE STANDARD TABLE OF t_trouble_shooting_test_entry WITH DEFAULT KEY
|
||
| 47 | T_URLS | Public | See coding | 20120822 | t_urls TYPE STANDARD TABLE OF smensaplnu
|
||
| 48 | T_USER_INFO | Public | See coding | 20120822 | BEGIN OF t_user_info,
user TYPE string,
type TYPE c LENGTH 1, " A - dialog, B - system, C - cpic, L - reference, S - service, D - bdc
name TYPE string,
surname TYPE string,
full_name TYPE string,
email TYPE string,
welcome_message TYPE string,
language TYPE laiso,
language_bcp TYPE string,
time_zone TYPE tznzone,
date_format TYPE xudatfm,
time_format TYPE xutimefm,
decimal_notation TYPE xudcpfm,
rtl TYPE abap_bool,
charset TYPE string,
client TYPE mandt,
roles_key TYPE string,
roles_timestamp TYPE timestamp,
favorites_key TYPE string,
favorites_timestamp TYPE timestamp,
accessibility TYPE abap_bool,
show_transaction_codes TYPE abap_bool,
theme TYPE string,
sap_menu_key TYPE string,
sap_menu_name TYPE hier_guid,
sap_menu_timestamp TYPE timestamp,
default_context TYPE string,
session_context TYPE string,
END OF t_user_info
|
Method Signatures
Method EPCM_DO_NAVIGATE Signature
Method EPCM_DO_NAVIGATE on Interface /UI2/IF_NWBC_RUNTIME has no exception.
Method EPCM_DO_OBJECT_BASED_NAVIGATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ANSWER_CACHEABLE | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20120822 | |||
| 2 |  Importing |
BUSINESS_OBJECT_NAME | Call by reference | Type reference (TYPE) | STRING | 20120822 | |||
| 3 | Exporting |
NAVIGATION_ENTRY | Call by reference | Type reference (TYPE) | T_NAVIGATION_ENTRY | 20120822 | |||
| 4 | Importing |
NWBC_CONTEXT | Call by reference | Type reference (TYPE) | STRING | 20120822 | |||
| 5 | Importing |
OBJECT_VALUE | Call by reference | Type reference (TYPE) | STRING | 20120822 | |||
| 6 | Importing |
OPERATION | Call by reference | Type reference (TYPE) | STRING | 20120822 | |||
| 7 |  Changing |
POST_BODY | Call by reference | Type reference (TYPE) | TIHTTPNVP | 20120822 | |||
| 8 | Importing |
RESOLVING_MODE | Call by reference | Type reference (TYPE) | STRING | SPACE | 20120822 | ||
| 9 | Exporting |
SM59_RFC_DESTINATION_NAME | Call by reference | Type reference (TYPE) | RFCDES-RFCDEST | 20120822 | |||
| 10 | Importing |
SYSTEM_ALIAS | Call by reference | Type reference (TYPE) | STRING | 20120822 | |||
| 11 | Exporting |
TARGET_URL | Call by reference | Type reference (TYPE) | STRING | 20120822 |
Method EPCM_DO_OBJECT_BASED_NAVIGATE on Interface /UI2/IF_NWBC_RUNTIME has no exception.
Method GET_ALL_RUNTIME_INFO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ALL_RUNTIME_INFO | Call by reference | Type reference (TYPE) | T_ALL_RUNTIME_INFO | 20120822 |
Method GET_ALL_RUNTIME_INFO on Interface /UI2/IF_NWBC_RUNTIME has no exception.
Method GET_COCKPITS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
COCKPITS | Call by reference | Type reference (TYPE) | T_COCKPITS | 20120822 |
Method GET_COCKPITS on Interface /UI2/IF_NWBC_RUNTIME has no exception.
Method GET_COCKPITS_WITH_ROLES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
COCKPITS_WITH_ROLES | Call by reference | Type reference (TYPE) | T_COCKPITS_WITH_ROLES | 20120822 |
Method GET_COCKPITS_WITH_ROLES on Interface /UI2/IF_NWBC_RUNTIME has no exception.
Method GET_CONFIGURATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
CONFIGURATION | Call by reference | Type reference (TYPE) | T_CONFIGURATION | 20120822 |
Method GET_CONFIGURATION on Interface /UI2/IF_NWBC_RUNTIME has no exception.
Method GET_MIMES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
FILE_NAME | Call by reference | Type reference (TYPE) | STRING | 20130418 | |||
| 2 | Importing |
SERVER | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_SERVER | 20130418 | |||
| 3 |  Returning |
URL_KEY | Value transfer | Type reference (TYPE) | STRING | 20130418 |
Method GET_MIMES on Interface /UI2/IF_NWBC_RUNTIME has no exception.
Method GET_NAVIGATION_TREE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
MENU_TYPE | Call by reference | Type reference (TYPE) | T_MENU_TYPE | 20120822 | |||
| 2 | Exporting |
NAVIGATION_TREE | Call by reference | Type reference (TYPE) | T_NAVIGATION_TREE | Standard NAV Tree, copy by value | 20120822 | ||
| 3 | Exporting |
NAVIGATION_TREE_SRT | Call by reference | Type reference (TYPE) | /UI2/IF_NWBC_RUNTIME=>T_NAVIGATION_TREE_SRT | Sorted Nav Tree, copy by ref | 20130906 |
Method GET_NAVIGATION_TREE on Interface /UI2/IF_NWBC_RUNTIME has no exception.
Method GET_OBN_TARGETS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
OBN_TARGETS | Call by reference | Type reference (TYPE) | T_OBN_TARGETS | 20120822 |
Method GET_OBN_TARGETS on Interface /UI2/IF_NWBC_RUNTIME has no exception.
Method GET_ROLES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ROLES | Call by reference | Type reference (TYPE) | T_ROLES | 20120822 |
Method GET_ROLES on Interface /UI2/IF_NWBC_RUNTIME has no exception.
Method GET_RUNTIME_VERSION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
VERSION | Value transfer | Type reference (TYPE) | STRING | 20120822 |
Method GET_RUNTIME_VERSION on Interface /UI2/IF_NWBC_RUNTIME has no exception.
Method GET_SYSTEM_INFO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
SYSTEM_INFO | Call by reference | Type reference (TYPE) | T_SYSTEM_INFO | 20120822 |
Method GET_SYSTEM_INFO on Interface /UI2/IF_NWBC_RUNTIME has no exception.
Method GET_TROUBLE_SHOOTING_INFO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
TROUBLE_SHOOTING_INFO | Call by reference | Type reference (TYPE) | T_TROUBLE_SHOOTING_INFO | 20120822 |
Method GET_TROUBLE_SHOOTING_INFO on Interface /UI2/IF_NWBC_RUNTIME has no exception.
Method GET_USER_INFO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_FETCH_NAVIGATION_DATA | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Fetch roles, favorites etc keys and time stamps | 20120822 | |
| 2 | Importing |
IV_FETCH_PERSON_DATA | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Fetch user email, adress etc | 20120822 | |
| 3 | Importing |
IV_FETCH_SYSTEM_DATA | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Fetch theme, language, accessibility etc | 20120822 | |
| 4 | Importing |
IV_FETCH_WELCOME_MESSAGE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Fetch welcome message only | 20120822 | |
| 5 | Exporting |
USER_INFO | Call by reference | Type reference (TYPE) | T_USER_INFO | 20120822 |
Method GET_USER_INFO on Interface /UI2/IF_NWBC_RUNTIME has no exception.
Method GET_USER_ROLES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ROLES | Call by reference | Type reference (TYPE) | T_ROLES | 20120822 |
Method GET_USER_ROLES on Interface /UI2/IF_NWBC_RUNTIME has no exception.
Method HANDLE_API Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_SERVER_ASSIST | Call by reference | Object reference (TYPE REF TO) | /UI2/CL_NWBC_SERVER_ASSIST | 20120822 | |||
| 2 | Importing |
IV_REST_OF_URL | Call by reference | Type reference (TYPE) | STRING | 20120822 |
Method HANDLE_API on Interface /UI2/IF_NWBC_RUNTIME has no exception.
Method IS_CACHE_VALID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_MENU_TYPE | Call by reference | Type reference (TYPE) | CHAR1 | /UI2/IF_NWBC_CONSTANTS=>GC_S_MENU_TYPE-USER | One of /ui2/if_nwbc_constants=>gc_s_menu_type | 20130726 | |
| 2 | Returning |
RV_VALID | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20130726 |
Method IS_CACHE_VALID on Interface /UI2/IF_NWBC_RUNTIME has no exception.
Method RESOLVE_NAVIGATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ANSWER_CACHEABLE | Call by reference | Type reference (TYPE) | ABAP_BOOL | We can cache this response | 20120822 | ||
| 2 | Importing |
APPEND_QUERY_PARMS_TO_URL | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Should parameters be placed on URL? | 20120822 | |
| 3 | Exporting |
CANVAS__TYPE | Call by reference | Type reference (TYPE) | STRING | .../~canvas/wda|transaction|.../ | 20120822 | ||
| 4 | Exporting |
CANVAS__WINDOW | Call by reference | Type reference (TYPE) | STRING | .../~canvas[;win=main|app]/ | 20120822 | ||
| 5 | Exporting |
CLIENT__TYPE | Call by reference | Type reference (TYPE) | STRING | Client_type for WDA or TR (See cl_nwbc=>url_construct) | 20120822 | ||
| 6 | Exporting |
NAVIGATION_ENTRY | Call by reference | Type reference (TYPE) | T_NAVIGATION_ENTRY | Only valid and bound if object_id is set. | 20120822 | ||
| 7 | Importing |
NWBC_CONTEXT | Call by reference | Type reference (TYPE) | STRING | String that encodes position within navigation tree | 20120822 | ||
| 8 | Exporting |
OBJECT_ID | Call by reference | Type reference (TYPE) | STRING | Into NavigationTree | 20120822 | ||
| 9 | Exporting |
OBN_RESOLVE_LOG | Call by reference | Type reference (TYPE) | T_OBN_RESOLVE_LOG | Hints for the obn resolve result | 20120822 | ||
| 10 | Changing |
QUERY_PARMS | Call by reference | Type reference (TYPE) | TIHTTPNVP | Post body from OBN navigation | 20120822 | ||
| 11 | Importing |
QUERY_STRING | Call by reference | Type reference (TYPE) | CSEQUENCE | Url encoded set of parameters | 20120822 | ||
| 12 | Exporting |
REPORT_TYPE | Call by reference | Type reference (TYPE) | STRING | Type of the returned URL | 20120822 | ||
| 13 | Exporting |
SM59_RFC_DESTINATION_NAME | Call by reference | Type reference (TYPE) | RFCDES-RFCDEST | Logical Destination (Specified in Function Call) | 20120822 | ||
| 14 | Importing |
SOURCE | Call by reference | Type reference (TYPE) | CSEQUENCE | Role: role:object_id | 20120822 | ||
| 15 | Importing |
SOURCE_ROLE | Value transfer | Type reference (TYPE) | AGR_NAME | Resolve OBN within this role | 20120822 | ||
| 16 | Exporting |
URL | Call by reference | Type reference (TYPE) | STRING | Target (Fully Qualified) URL inclusive parameters | 20120822 |
Method RESOLVE_NAVIGATION on Interface /UI2/IF_NWBC_RUNTIME has no exception.
History
| Last changed by/on | SAP | 20141121 |
| SAP Release Created in | 100 |
