Definition of Configuration Parameters with Table NWBC_CFGLocate this document in the navigation structure

For minimal configuration of NWBC, use configuration table NWBC_CFG. The table is used only for customization and is local to the current system.

Caution

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.

You can maintain the table in transaction Data Browser ( SE16) because it is basically a sequence of name-value pairs that are configured either globally or for a specific cockpit. The table has the following general structure:

Name

Required/Optional

Description

CLIENT

required

System client to which the configuration belongs

IDX

required

A unique number that has no other purpose than to set a sort sequence and function as a key. The actual value of the number is irrelevant.

COCKPIT

optional

Use either the wildcard * character to apply this setting to all cockpits or enter the name of a cockpit to limit the settings to the specific cockpit.

NAME

required

Name of the configuration parameter (see below)

LANG

depends on NAME

If the parameter can also have a language-dependent string, set the ISO language code here. Or use the wildcard (*) to apply to all languages.

DISPLAY

depends on NAME

The actual natural language string that is displayed to the user

VALUE

depends on NAME

For language-independent texts (opposed to DISPLAY), such as a URL (for example, for the branding image parameter)

COCKPIT_PATH

optional

It is possible that the same cockpit name actually exists in different parts of the ICF tree. The name itself is not unique, it only becomes unique when the full path from the root is specified, for example, for myCockpit, the full path could be /sap/bc/nwbc/myCockpit. You can specify the complete cockpit path to ensure that the cockpit is unique. If specified, this string is also used to validate whether this configuration row belongs to the current cockpit.

We recommend that this field is empty or “*” in all cases.

Each parameter is one entry in the table. The following parameters are supported:

Name

Language Field

Description

CACHE_DISCRIMINATOR

not used

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.

INSTALL_DIRECTORY

required

A link that is displayed and rendered on the ~launch page to allow 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.

BUSINESS_LINE

not used

This entry controls the icon that is displayed within NWBC to refer to one of SAP's business lines. Possible values are:

  • BUSINESS_SUITE

  • Business_All-in-One or BAiO

  • BUSINESS_BYDESIGN

If the parameter is not defined, the usual SAP icon is displayed with NWBC.

Note

Specifically for the SAP Business Suite, no separate logo is displayed, but the SAP logo itself is applied.

Recommendation

We recommend to use the default setting of “SAP”.

BRANDING_IMAGE

not used

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

not used

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.

COCKPIT_TITLE

not used

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, limited at the moment to NWBC for HTML.

LOGOFF_URL

not used

This parameter is for NWBC for HTML. After a logoff sequence, if a logoff URL is specified, the browser navigates to this page. NWBC for Desktop has the typical desktop application behavior where a logoff causes the application to terminate.

WELCOME_MESSAGE

optional

At runtime, the system selects the welcome message in the logon language. If no matching language entry is found, LANG=' ' or LANG='*' is used as a fallback.

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

The VALUE field contains the text. You can use the following placeholders:

  • &NAME&: first name

  • &SURNAME&: last name

  • &FULL_NAME&: full name

  • &USER&: user name

  • &CLIENT&: client

  • &SYSTEM&: system ID

THEME_NAME

not used

By default, the VALUE field contains sap_corbu.

As an administrator you can select a different theme based on customer needs. When the user logs on to the role or cockpit associated with this theme in the back end, the NWBC for HTML shell, all Web Dynpro ABAP applications, and service maps are rendered using the specified theme.

FORCE_BROWSER_STANDARD_MODE

optional

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 NWBC for HTML 3.5 only

  • Relevant for Internet Explorer 9 or higher

  • Available with patch 25. For more information, see SAP Note 1783826 Information published on SAP site.

  • 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 NWBC_CFG_SAP system table. Entries for the mentioned parameter in table NWBC_CFG overwrite the entry in table NWBC_CFG_SAP. If SAP entries should not be lost, we recommend that you copy them to the new entry created by the customer.

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.5 or higher) and for service maps used in NWBC for Desktop (version 3.5 or higher)

  • Available with patch 25. For more information, see SAP Note 1783826 Information published on SAP site.

  • 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 figure provides a configuration example:

NWBC_CFG example

For SAP Developers Only

There are cases where it might be required to ship specific parameters that are predefined for a specific cockpit. This is particularly interesting when a cockpit is used to define a small "product". For example, assume that SRM would like to define a new cockpit and pre-configure a title, a custom search engine and a help are linked in this use case. The approach would be then to define a new cockpit that can be used to group relevant roles and to which the configuration can be tied. In these cases, use the table NWBC_CFG_SAP to configure a set of parameters for the cockpit that can be transported.

Caution

This table is client-dependent. It uses only a three-character index to obtain unique keys. Contact the NWBC development team to reserve a set of numbers.