Window: Inbound and Outbound Plug Parameters

Inbound und Outbound Plug Parameters of Type Standard

For each outbound plug of Standard type you can create a list of user-defined parameters. For each inbound plug of Standard type you can create a list of user-defined importing parameters in the associated event handler method.

Parameters for Suspend and Exit Plugs

You can define parameters for these special window plugs too. Since these parameters must be specified in the outbound URL, they must be either of type String or TIHTTPNVP (see below):

All parameters for exit and suspend plugs are specified in the target URL (optional for the exit plug, mandatory for the suspend plug). If the target URL is a Web Dynpro application, the URL has the following schema:

<schema>://<host>.<domain>.<extension>:<port>/sap/bc/webdynpro/

<Namespace>/<application name>?<parameter name>=<parameter value>

Exit and suspend plugs at runtime have the special string parameter URL. This is used to transfer the target URL. This parameter is not transferred to the following application.

The second special parameter is POST_PARAMETERS of type ABAP_BOOL. This can determine whether the subsequent application is navigated to using GET or POST. In addition, the suspend plug checks whether the resulting URL exceeds the length of 1024 bytes for the subsequent application. This is the maximum length for some browser types. To ensure the parameter does not get truncated, the framework automatically switches from GET to POST.

The third special parameter is RESUME_URL_ID. This is used to determine the name of the return address for the subsequent application.  If the parameter is not set, sap-wd-resumeurl is used as the parameter name. Other values can be used with this name too. When selecting a name, you should use ASCII characters only.

Parameters for Startup and Resume Plugs

Parameters for startup and resume plugs are passed with the calling URL to the associated event handler method, and this means they come from the secondary application. For this reason the number and the names of the parameters passed to the method at design time are often not known to the primary Web Dynpro application. To be able to process inbound URL parameters anyway, they are stored in a table of type TIHTTPNVP. All the application-specific URL parameters in this table can be accessed using parameter WDEVENT belonging to the event handler method of a startup or resume plug. The parameter created locally must be of the same type, that is, of type TIHTTPNVP (see below).

method HANDLEDEFAULT .

   data: l_url_parameters type tihttpnvp.
         .
         .
   wdevent->get_data(
     exporting
       name =  if_wd_application=>all_url_parameters
     importing
       value = l_url_parameters  ).
 .
 .
 endmethod.

If the parameters that are passed to the startup or resume plug are already known at design time, you can add the individual parameter strings to the signature of the event handler method and access them directly.

TIHTTPNVP Parameters

The table type TIHTTPNVP contains parameter names and their values. If you create a parameter of this type for a suspend or exit plug, the parameter will have the form of a table containing pairs of names and values of type string. In this case all the entries are passed to the URL together, rather than each parameter separately.

The pairs of names and values passed to the startup or exit plug are stored in a table.