Show TOC

6.1.1 Short Form of URL Locate this document in the navigation structure

 

The short variant of the URL described in the table below can be used to start NWBC with just a shell. The long variant of the URL described in 6.1.2 Long Form of URL can load any type of content on startup.

By merging the different URL elements, the complete URL will look as follows:

[optional protocol handler://][optional authentication sequence@]<server sequence>/<ICF path>/[optional cockpit/]

Short URL

Element

Optional

Only Desktop Client

URL

Description

Email bootstrap

yes

url:

This element is available specifically for NWBC for Desktop: If the startup URL is to be embedded within an email, add the additional url: prefix, to signal to Microsoft Outlook that this is a startable link and that Outlook should treat this as a link that can be clicked.

Protocol handler for desktop client

yes

yes

sap-nwbc://

The protocol handler is an extension added into Windows to allow NWBC to be started similar to a normal URL. When this "URL" starting with NWBC is used within a browser or from a startup icon, the NWBC shell itself will be started to handle the URL. This protocol handler is only needed if you intend to start NWBC for Desktop. If NWBC for HTML is to be started, the protocol handler must not be specified.

Authentication

yes

yes

<name>:<password>[optional connection parameters]@optional connection parameters

  ;connection=ABAP|portal

  ;proxy=<server>.<domain>.<ext>:<port>

  ;proxy-secure=<server>.<domain>.<ext>:<port>

  ;proxy-authentication=<name>:<password>

Similar to ftp://<name>.<password>@<server> to imbed authentication into the URL. Only supported with NWBC for Desktop. The connection is used to determine the type of server that will be connected to, the default is an ABAP server.

The proxy parameters can be employed to optionally specify a proxy that should be used to set up the connection. Keep in mind that it is needed to usually specify both an HTTP proxy (;proxy sequence) and a proxy for HTTPS (;proxy-secure sequence). If needed, also supply the proxy authentication information (;proxy-authentication sequence). If a proxy configuration is specified, NWBC will change the Internet Explorer settings to use the proxy settings (for the current process) and will restore the original settings when terminated.

Server address

http(s)://<server>.<domain>.<ext>[:<port>]

For the server address, use the regular http(s):// sequence with a fully qualified domain name (FQDN).

NWBC handler path

/nwbc

/sap/bc/nwbc

/<myCompany>/nwbc

This is the path within the ICF service tree to the NWBC handler. By default use /sap/bc/nwbc, or, if available, the shorter /nwbc alias. It is also possible to have a different ICF path specified within the ICF service tree.

Cockpit

yes

/<myCockpit>

/<ROLE_NAME>

Optional cockpit that is a filter onto the role repository. Alternatively, it is possible to use directly the name of a role that is then used similarly as a cockpit, namely, only this role will be displayed.

Trailing slash /

/

The extra slash / is needed to lock the previous segment.

Examples

A very simple link to start NWBC for HTML could be:

    https://ldcibqi.wdf.sap.corp:44376/sap/bc/nwbc

 

Similarly, a simple link to start NWBC for Desktop could be:

    sap-nwbc://https://ldcibqi.wdf.sap.corp:44376/sap/bc/nwbc

 

When the link is to be triggered from an email, add the url: prefix:

    url:sap-nwbc://https://ldcibqi.wdf.sap.corp:44376/sap/bc/nwbc

 

A more complex example (only relevant for NWBC for Desktop) that includes authentication information and also information to traverse a proxy, could be:

    sap-nwbc://user:password;proxy=proxy.domain.corp:8080;proxy-secure=proxy-domain.corp:8083;proxy-authentication=p-user:p-password@https://ldcibqi.wdf.sap.corp:44376/sap/bc/nwbc