Show TOC

Definition of Configuration Parameters in CustomizingLocate this document in the navigation structure

You define configuration parameters for versions of SAP NetWeaver Business Client that connect to the server runtime for SAP NetWeaver user interface services in Customizing.

In Customizing under Start of the navigation path SAP NetWeaver Next navigation step UI Technologies Next navigation step SAP NetWeaver Business Client End of the navigation path, use transaction /UI2/NWBC_CFG_CUST to define configuration parameters for versions of SAP NetWeaver Business Client that connect to the server runtime for SAP NetWeaver UI services, for example the THEME or WELCOME_MESSAGE.

You can perform the following steps in Customizing:

  • Define names for configuration parameters
  • Assign values to the configuration parameters

You can define configuration parameters in Customizing using the following transactions:

  • NWBC Configuration: Define Parameter Names (transaction /UI2/NWBC_CFG_PARAMS)

    This table defines which configuration parameters are available and allows you to define names for configuration parameters and whether these should be translatable.

  • NWBC Configuration: Maintenance (transaction /UI2/NWBC_CFG_CUST)

    You use this table to assign concrete values to configuration parameters.

    This table allows you to make settings for the following configuration parameters:

    • parameter name (for example, WELCOME_MESSAGE)
    • parameter value (empty for translatable parameters)
    • translated parameter value (relevant only if you select the Translatable checkbox, for example, Welcome <User Name>)

SAP delivers some parameters with predefined values. This data is available via transaction /UI2/NWBC_CFG_SAP. As a customer you can define the same parameters with a different value in transaction /UI2/NWBC_CFG_CUST. The system always prefers the values that you have defined.

Note Data from table NWBC_CFG used with a server runtime of version 3.5 is not migrated to the transactions in Customizing. If you use the server runtime for SAP NetWeaver user interface services 3.6, you have to enter your data again.

The following parameters are supported for configuration of NWBC for Desktop 5.0:

Name

Translatable

Description

BRANDING_IMAGE

no

A branding image is typically a corporate logo that NWBC displays on the Index and the New Tab page instead of the SAP logo. This can be a small PNG or JPG image. The height should be limited to a maximum of 66 pixel. The value field is a URL that refers directly to the image. It must be ensured that the image can be loaded without authorization.

BRANDING_URL

no

If this parameter is configured, the branding image is clickable, and a click on the branding image navigates to this URL. The value is the URL that must be started. Typically, this is the corporate portal page of the company, which is then loaded.

THEME

no

The default theme is sap_corbu.

An administrator selects an SAP theme, or a custom theme created with UI theme designer. When the user logs on to the role or cockpit associated with this theme in the back end, NWBC with its overview pages, all Web Dynpro ABAP applications, and service maps are rendered using the specified theme.

When configuring a custom theme, specify the theme ID here.

WELCOME_MESSAGE

yes

At runtime, the system selects the welcome message in the logon language. If no matching language entry is found, the default message is used.

The welcome message is displayed on the Index page and replaces the default text “Here you can find all the information about your business”. You can use the following placeholders in the text:

  • &NAME&: first name

  • &SURNAME&: last name

  • &FULL_NAME&: full name

  • &USER&: user name

  • &CLIENT&: client

  • &SYSTEM&: system ID

CACHE_DISCRIMINATOR

no

NWBC for Desktop indefinitely caches the complete navigation tree for the end user locally on the desktop. Only when a role is changed, is a new navigation tree downloaded. However, there can be specific reasons one would like to force all desktop clients to dynamically reload their caches. The approach taken is to encode this random configuration string into the cache key. As long as the string is not configured or stably configured, it has no influence on the caching of NWBC for Desktop. As soon as the string gets a new and different random string, it changes the cache key, causing NWBC for Desktop to reload the caches. This parameter is not needed in productive use, unless explicitly so requested from a support process to resolve specific types of problems. You can use any character string. We recommend that you use three digit numbers.

USE_BROWSER_CACHE

optional

The following applies for this parameter:

  • Relevant for HTML sites of NWBC for HTML and for service maps used in NWBC for Desktop
  • Possible values are ON and OFF ( OFF is the default).

This parameter offers the following enhancements:

  • Accelerated responsiveness of HTML pages

  • Less back-end CPU usage

  • Reduced network traffic

Caution

The HTML sites of the NWBC for HTML might contain security-relevant data. Therefore, we recommend that you take appropriate measures to secure your data, for example hard disk encryption.

The following parameters are supported for configuration of NWBC for HTML 3.6:

Name

Translatable

Description

BRANDING_IMAGE

no

A branding image is typically a corporate logo that NWBC is displayed on the lower part of the navigation panel (when visible). This can be a small PNG or JPG image. The value field is a URL that refers directly to the image. It must be ensured that the image can be loaded without authorization.

BRANDING_URL

no

If this parameter is configured, the branding image is clickable, and a click the branding image navigates to this URL. The value is the URL that must be started. Typically, this is the corporate portal page of the company, which is then loaded.

THEME

no

The default theme is sap_corbu.

An administrator selects an SAP theme, or a custom theme created with UI theme designer. When the user logs on to the role or cockpit associated with this theme in the back end, NWBC with its overview pages, all Web Dynpro ABAP applications, and service maps are rendered using the specified theme.

When configuring a custom theme, specify the theme ID here.

WELCOME_MESSAGE

yes

At runtime, the system selects the welcome message in the logon language. If no matching language entry is found, the default message is used.

The welcome message is displayed in NWBC for HTML next to the Log Off pushbutton.

You can use the following placeholders:

  • &NAME&: first name

  • &SURNAME&: last name

  • &FULL_NAME&: full name

  • &USER&: user name

  • &CLIENT&: client

  • &SYSTEM&: system ID

COCKPIT_TITLE

yes

This parameter is only used in rare cases where a cockpit wishes to create a "product" approach. In such cases, this parameter can be used to configure a string that is displayed on the shell.

LOGOFF_URL

no

After a logoff sequence, if a logoff URL is specified, the browser navigates to this page.

FORCE_BROWSER_STANDARD_MODE

no

Use this parameter to force an application to be rendered with the newest available rendering engine. NWBC for HTML uses the Internet Explorer 8 rendering engine by default. The following applies for this parameter:

  • Relevant for Internet Explorer 9 or higher
  • Possible values:

    An ABAP-regular expression that describes an application URL. If the pattern of the regular expression matches an URL, the entire NWBC page (the top frame and with this also the application included in an IFrame) is rendered with the newest rendering engine (IE=edge).

Example

/sap\.com|/ui5_ui5/ : This regular expression matches any URL that contains the string /ui5_ui5/ or sap.com.

Caution An entry is already available in the configuration delivered by SAP (transaction /UI2/NWBC_CFG_SAP). The system always prefers the values that you have defined. If SAP entries should not be lost, we recommend that you copy them to the new entry.

USE_BROWSER_CACHE

optional

Use this parameter to store HTML pages in NWBC for HTML in the browser cache.

This parameter offers the following enhancements:

  • Accelerated responsiveness of HTML pages

  • Less back-end CPU usage

  • Reduced network traffic

The following applies for this parameter:

  • Relevant for HTML sites of NWBC for HTML (version 3.6 or higher) and for service maps used in NWBC for Desktop (version 3.5 or higher)
  • Possible values are ON and OFF ( OFF is the default).
Caution

The HTML sites of the NWBC for HTML might contain security-relevant data. Therefore, we recommend that you take appropriate measures to secure your data, for example hard disk encryption.

The following parameters are supported for configuration of the ~launch page:

Name

Translatable

Description

INSTALL_DIRECTORY no A link that is displayed at the bottom of the ~launch page. The link allows users to quickly get a reference to a location from which NWBC for Desktop can be installed. This link could refer to a wiki, a file share, even to the mime repository on the local server. We recommend that the URL itself refers to an HTML page because it is started in a browser window.
INSTALL_DESCRIPTION yes Text rendered for the INSTALL_DIRECTORY link on the ~launch page.