Show TOC

 6.1.3 URL Construction Locate this document in the navigation structure

 

It is highly recommended to use the method cl_nwbc=>url_construct to create the startup URLs. The more interesting parameters of this method are as follows:

url_construct Parameters

Parameter Name

Type

Associated Type

Default Value

Description

FOR_USE_IN_EMAIL

Importing

ABAP_BOOL

ABAP_FALSE

Prefix sap-nwbc:// with url: for use in (MS Outlook) emails.

HTML_CLIENT

Importing

ABAP_BOOL

ABAP_TRUE

Use HTML Client ==> NWBC HTML

SERVER

Importing

IF_HTTP_SERVER

Use for determining proxies in network

COCKPIT

Importing

CSEQUENCE

Optional cockpit to activate

ROLE

Importing

CSEQUENCE

Optional role that can be defined as “cockpit” to filter and show only the content of this specific role.

CANVAS_WDA

Importing

CSEQUENCE

Canvas = WDA: Web Dynpro ABAP ( [/namespace/]name)

CANVAS_TRANSACTION

Importing

CSEQUENCE

Transaction code to start

CANVAS_URL

Importing

CSEQUENCE

Canvas = URL: must be server absolute URL! (start with /)

CANVAS_SITEMAP

Importing

ABAP_BOOL

A sitemap for the user-assigned role(s) is generated into the canvas.

CANVAS_ROLE_ENTRY

Importing

CSEQUENCE

Canvas = RoleEntry: role:object_id

CANVAS_OBN

Importing

CSEQUENCE

Canvas = OBN: object.method

CANVAS_WDA__CLIENT_TYPE

Importing

String

auto

Client type of the canvas. Possible values: auto | html

CANVAS_TRANSACTION__CLNT_TYPE

Importing

String

auto

Client type of the canvas. Possible values: auto | sapgui | webgui

QUERY_STRING

Importing

CSEQUENCE

Query string name=value format, already URL encoded

URL

Returning

String

Server absolute URL

See the API of the method for a complete overview of all parameters in the system.

When using url_construct, note that you need to place transaction parameters as normal query string parameters. Example to start a transaction with a parameter:

  DATA: url TYPE string,

        query TYPE string.  

  CONCATENATE 'S_UNAME-LOW=' sy-uname '&abc=123' INTO query.   

  url = cl_nwbc=>url_construct(    

     canvas_transaction = 'ST22'     

     query_string = query ).   

  cl_nwbc=>url_launch( url ).

For a use case of startup URLs, see 6.2 Creating an NWBC Desktop Icon.