6.1.4 URL Construction

Use

We highly recommend that you use the method cl_nwbc=>url_construct to create the startup URLs. The parameters of this method include the following:

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 (Microsoft Outlook) e-mails
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		Content area (canvas) = WDA: Web Dynpro ABAP ( [/namespace/]name)
CANVAS_TRANSACTION	Importing	CSEQUENCE		Transaction code to start
CANVAS_URL	Importing	CSEQUENCE		Content area (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 content area (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 content area (canvas) Possible values: auto\| html
CANVAS_TRANSACTION__CLNT_TYPE	Importing	String	auto	Client type of the content area. Possible values: auto\| sapgui\| webgui
QUERY_STRING	Importing	CSEQUENCE		Query string name=value format, already URL encoded
URL	Returning	String		Server absolute URL
SM59_ALIAS	Importing	CSEQUENCE	OPTIONAL	Destination for which URL should be generated
APPLICATION	Importing	CSEQUENCE	DEFAULT CL_URL=>MC_APPLICATION	Default HTTPURLLOC application name
DOMAIN	Importing	CSEQUENCE	OPTIONAL	Default HTTPURLLOC domain name

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

Example of how 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 .

How to Customize Server Name and Port

If you want to generate a URL for public use or for use in e-mail, you can control the name and port of the server in the generated URL using three additional parameters.

This function is available only if you have implemented the following patch levels and read the SAP Notes:

For SAP NetWeaver 7.3 EHP1:

SAP Note 1747651 - SAP NWBC 3.5 7.31: cumulative correction package nr.8
For SAP NetWeaver 7.0/ 7.01/ 7.02/ 7.11/ 7.20/ 7.30:

SAP Note 1748036 - SAP NWBC 3.0 ABAP Runtime Patch 23

If you want to generate a URL for public use or for use in e-mail, you can control the name and port of the server in the generated URL in the following ways:

You can pass the target system name using the new parameter named SM59_alias. The target system name is defined in the same way as for the remote system definition in transaction Role Maintenance ( PFCG).

For more information, see 5.11 Remote Systems .
You can pass the application name and / or the domain name in the respective parameters. Based on these parameters, the server and port name for the generated URL are taken from the configuration table HTTPURLLOC.

For more information, see Programming Interface .