Show TOC

6.1.2 Long Form of URL Locate this document in the navigation structure

 

For the long URL the first part consists of the short URL as described in 6.1.1 Short Form of URL, plus the following elements:

.../~canvas/<canvas type>/<client_type>/<canvas relevant sequence>/[?parameter sequence][sap parameters]

Long URL

Element

Optional

URL

Description

Canvas delimiter and options

/~canvas[;window=main|app|embedded]

If this is an URL that loads a specific canvas, then this ~canvas sequence must be available. Windowing qualifiers are optional.

  • window=main: starts a shell window with both top and left navigation.

  • window=app: starts an application window without navigation elements.

  • window=embedded: starts the shell in rendered format that is embedded in foreign portals; only relevant for NWBC for HTML.

Example:

  http://<server>.<domain>.<ext>:<port>/sap/nwbc/~canvas;window=app/wda/myApplication/

Target-specific description

/transaction/<transaction_code>

  [;client_type=auto]

  ;client_type=sapgui

  ;client_type=webgui

/wda/[<namespace>/]<name>

  [;client_type=auto]

  ;client_type=html

/url/<segment>/...

/roleEntry/<role_name>:<id>

/sitemap

/obn/<object>.<method>

/applicationAlias/<alias>

Segment that describes the type of canvas to load. These strings describe the possible canvases that can be used.

  • transaction: This form is used to define that a specific (SAP GUI-based) transaction should be started. It is similar to starting a transaction within the OK-field in SAP GUI. By default, NWBC for Desktop will use SAP GUI to start the transaction, and NWBC for HTML will use SAP GUI for HTML. Use the client_type qualifier to force a specific rendering engine. This is specifically of interest when using NWBC for HTML, but needing the transaction to be executed in SAP GUI. For the transaction-specific sequence, specify the transaction that needs to be started.

  • wda: Use this form to start a Web Dynpro ABAP (WDA) application. By default all Web Dynpro ABAP applications are started with an HTML-based rendering client. The client_type qualifier is here just used for possible future enhancements. For the specific sequence, specify the name of the Web Dynpro ABAP application. This could include an optional namespace if the application is not in the default SAP namespace.

  • url: Defines an absolute URL on the server that must be started. Note that this is an URL relative to the server against which NWBC is started. For the url-specific sequence, specify the server absolute URL with any number of segments, each separated in the usual form by a / character.

  • roleEntry: Use this entry to start a very specific entry in a very specific role. This is an absolute form of addressing. Here the name of the role is directly used, and within the role, the assigned numeric id. This number can be seen within PFCG on the Menu tab when Other Node Details is turned on (for more information, see 5.5 Navigation Tree and PFCG.01 Searching for Technical Names). For the roleEntry specific sequence, specify the name of the role and the id (numeric number) for the specific entry in the role.

  • sitemap: Use the sitemap sequence to embed a complete set of roles to an external portal. It is also possible to only imbed one role by specifying the role as optional part of the URL directly after the /nwbc sequence (see chapter 6.1.1 Short Form of URL). Typical use case would be to imbed a complete Employee Self Service scenario (for example, expressed via the role SAP_ESS) into a Microsoft SharePoint portal. With this one link a service map is embedded into the external portal that represents the complete role and can be used to start any transaction contained within the role.

  • obn: Specifies that for the startup application much be determined by resolving the OBN call. This is a very good way to start a specific type of symbolic transaction, without knowing at that moment what the real transaction is that is mapped into the user’s role. For example, assume the call sequence .../obn/process.Monitor. Then for a normal user, a role could be assigned where this entry maps onto a monitoring application for his specific work area, whereas the area supervisor can have a different role which maps this OBN call in his assigned role onto a special application that gives an overall view over all work areas. For this obn-specific sequence, both the object and method must be specified.

  • applicationAlias: Using an application alias is another form to start an application via a symbolic name. Within the role (in transaction PFCG), it is possible to assign symbolic names to role entries. For the PFCG this is just a user-defined string without any further meaning. This symbolic name can be used to enable NWBC at runtime to resolve the specific application that must be started.

Trailing slash /

/

The extra slash / is needed to lock the previous segment and allow page-relative URLs to work.

Query string

yes

?name=value&name=value&…

The query string is passed as-is to the called application. It does not, and should not, contain any NWBC-relevant parameters or options.

Note Note

If a transaction is to be started, the startup parameters must still be specified as normal URL parameters (in the format &name=value). At runtime, the parameters will be correctly transformed into the format required by SAP GUI for HTML.

End of the note.

SAP parameter

yes

&sap-client=<nnn>

&sap-user=<user name>

&sap-language=<XX>

Note that an additional sap-client is always added to ensure an HTML URL always runs back into the correct client.

Examples

For example, to start directly transaction ME21 in NWBC, use the sequence:

    https://ldcibqi.wdf.sap.corp:44376/sap/bc/nwbc/~canvas/transaction/ME21/

   

To force-start the same transaction in SAP GUI while using NWBC for HTML, add the client_type qualifier:

    https://ldcibqi.wdf.sap.corp:44376/sap/bc/nwbc/~canvas/transaction;client_type=sapgui/ME21/

   

To start the Web Dynpro ABAP application IT00, shipped by SAP in the default namespace, use:

    https://ldcibqi.wdf.sap.corp:44376/sap/bc/nwbc/~canvas/wda/IT00/

   

However, if the Web Dynpro ABAP application was developed in a specific namespace, it must also be specified. For example, to start /SRM/Inbox, use:

    https://ldcibqi.wdf.sap.corp:44376/sap/bc/nwbc/~canvas/wda/SRM/Inbox/

   

The start URL of a Web Dynpro ABAP application with certain Web Dynpro ABAP specific parameters can look as follows:

    https://uxai5q35.wdf.sap.corp:44321/sap/bc/nwbc/~canvas;window=app/wda/hress_a_persinfo/?WDCONFIGURATIONID=HRESS_AC_PERSINFO&sap-client=004&sap-language=EN

   

For example, assume we wish to specify a BSP application myApp that needs to be started, then use the url sequence and specify the complete URL to start.

    https://ldcibqi.wdf.sap.corp:44376/sap/bc/nwbc/~canvas/url/sap/bc/bsp/sap/myApp/default.htm

   

To start a very specific entry in a role, without knowing what the entry is, use the roleEntry sequence. For example, given the role PROCESS_MONITOR, start entry 27 with this sequence:

    https://ldcibqi.wdf.sap.corp:44376/sap/bc/nwbc/~canvas/roleEntry/PROCESS_MONITOR:27/

   

To embed all roles in an external portal, you can use for example an NWBC for HTML link that shows a service map for all roles:

    https://ldcibqi.wdf.sap.corp:44376/sap/bc/nwbc/~canvas;window=embedded/sitemap/

   

To embed one complete role in an external portal, you can use for example an NWBC for HTML link that selects a complete role and shows a service map for the role:

   https://ldcibqi.wdf.sap.corp:44376/sap/bc/nwbc/SAP_ESS/~canvas;window=embedded/sitemap/

   

To use a symbolic call, consider to use an OBN call that is only resolved at runtime via the specific assigned roles. For example, to start a process monitor application, map the OBN sequence process.Monitor in the assigned role and use this startup URL:

    https://ldcibqi.wdf.sap.corp:44376/sap/bc/nwbc/~canvas/obn/process.Monitor/

   

To start an overview application, assuming the application alias OVERVIEW_APP has been defined for a specific entry within the user-assigned roles, use:

    https://ldcibqi.wdf.sap.corp:44376/sap/bc/nwbc/~canvas/applicationAlias/OVERVIEW_APP/