Short Form of URL
You can use the short variant of the URL described in the table below to start NWBC with only a shell. The long variant of the URL can load any type of content on startup.
By merging the different URL elements, the complete URL looks as follows:
[optional protocol handler://][optional authentication sequence@]<server sequence>/<ICF path>/[optional cockpit/]
|
Element |
Optional |
Only NWBC for Desktop |
URL When Using Server Runtime for SAP NetWeaver UI Services |
URL When Using Server Runtime for SAP NetWeaver Business Client |
Description |
|---|---|---|---|---|---|
|
E-mail bootstrap |
yes |
url: |
url: |
This element is specifically available for NWBC for Desktop: If the startup URL is to be embedded in an e-mail, add the url: prefix to signal to Microsoft Outlook that this is a startable link and that it should be treated as a hyperlink. |
|
|
Protocol handler for desktop client |
yes |
yes |
sap-nwbc:// |
sap-nwbc:// |
The protocol handler is an extension added to Windows to allow NWBC to be started in the same way as a normal URL. When this “URL” starting with NWBC is used within a browser or from a startup icon, the URL is opened in the NWBC shell itself. This protocol handler is needed only if you intend to start NWBC for Desktop. If NWBC for HTML is to be started, the protocol handler need 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> |
<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> for imbedding authentication into the URL. Supported only with NWBC for Desktop. The connection is used to determine the type of server to which the connection is established; the default is an ABAP server. The proxy parameters can be employed to optionally specify a proxy used to establish the connection. Note that you must usually specify both an HTTP proxy (;proxy sequence) and an HTTPS proxy ( ;proxy-secure sequence). If necessary, supply the proxy authentication information ( ;proxy-authentication sequence). If a proxy configuration is specified, NWBC changes the Internet Explorer settings to use the proxy settings (for the current process) and restores the original settings when terminated. |
|
Server address |
http(s)://<server>.<domain>.<ext>[:<port>] |
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 |
/ui2/nwbc /sap/bc/ui2/nwbc /<myCompany>/ui2/nwbc |
/nwbc /sap/bc/nwbc /<myCompany>/nwbc |
This is the path within the ICF service tree to the NWBC handler. By default, use /sap/bc/ui2/nwbc or, if available, the shorter /ui2/nwbc alias. You can also have a different ICF path specified in the ICF service tree. |
||
|
Cockpit |
yes |
/<myCockpit> /<ROLE_NAME> |
/<myCockpit> /<ROLE_NAME> |
Optional cockpit that is a filter onto the role repository. Alternatively, you can use the name of a role that is used in the same way as a cockpit. This means that only the role is displayed. |
|
|
Trailing slash / |
/ |
/ |
The extra slash / is needed to lock the previous segment. |
Examples
|
Description |
For Users of Server Runtime for SAP NetWeaver UI Services |
For Users of Server Runtime for SAP NetWeaver Business Client |
|---|---|---|
|
Start NWBC for HTML |
https://<server>.<domain>.<ext>:<port>/sap/bc/ui2/nwbc | https://<server>.<domain>.<ext>:<port>/sap/bc/nwbc |
|
Start NWBC for Desktop |
sap-nwbc://https://<server>.<domain>.<ext>:<port>/sap/bc/ui2/nwbc Note When
the link is to be triggered from an e-mail, add the
url:
prefix:
url:sap-nwbc://https://<server>.<domain>.<ext>:<port>/sap/bc/ui2/nwbc |
sap-nwbc://https://<server>.<domain>.<ext>:<port>/sap/bc/nwbc Note When
the link is to be triggered from an e-mail, add the
url:
prefix:
url:sap-nwbc://https://<server>.<domain>.<ext>:<port>/sap/bc/nwbc |
A more complex example (only relevant for NWBC for Desktop) that includes authentication information and also information to traverse a proxy:
sap-nwbc://user:password;proxy=proxy.domain.corp:8080;proxy-secure=proxy-domain.corp:8083;proxy-authentication=p-user:p-password@https://<server>.<domain>.<ext>:<port>/sap/bc/ui2/nwbc
It is the user's responsibility to take the appropriate security measures to prevent misuse of the user's credentials such as user ID and password. Do not store the URL that contains the personal user and password anywhere where it could be read and misused. Be aware that Web browser URLs are stored in a history list and the password would be visible in plain text, even after the browser is closed.
We recommend that you use a non-secret user and password to prevent misuse.