Start of Content Area

Procedure documentation Starting the SAP Web Dispatcher  Locate the document in its SAP Library structure

The SAP Web Dispatcher can be started in various ways.

SAP Management Console

You can start the SAP Web Dispatcher from the SAP Management Console (or from SAP MMC under Windows).

More information:

SAP Management Console

SAP Microsoft Management Console: Windows

Command line

You start the SAP Web Dispatcher with the command:

sapwebdisp pf=<profile name> [-f <trace file> -t <trace level>  -cleanup -shm_attach_mode <mode> -auto_restart -version]

The optional parameters have the following meaning:

      You can use -f to determine the name of the trace file. Standard is dev_webdisp.

      You can use option -t to set the Trace Level.

      -cleanup means that common resources (shared memory and so on) are released. This is necessary if the SAP Web Dispatcher ran was not stopped in an orderly manner the last time it ran, but was terminated by a crash.

      -shm_attach_mode <mode> determines what should happen to the shared memory of the SAP Web Dispatcher. Here, <mode> is a number that is a combination of the following values (bit mask):

1: Delete the shared memory of the SAP Web Dispatcher (cleanup)

2: Try to connect to the shared memory (attach)

4: Create a new shared memory (create)

This results in the following possible options:

1: The shared memory is cleaned up and the SAP Web Dispatcher ends. The behavior is the same as with the option of –cleanup.

2: The SAP Web Dispatcher connects to the existing shared memory (attach). If this does not exist, the SAP Web Dispatcher ends with an error.

3: Not useful

4: The SAP Web Dispatcher creates a new shared memory. If this exists already, the SAP Web Dispatcher ends with an error.

5: If a shared memory exists already, it is deleted. A new shared memory is then created.

6: The system tries to attach it to an existing shared memory. If a shared memory does not exist, a new one is created. This is also the default value, and the SAP Web Dispatcher behaves like this if options -shm_attach_mode <mode> and -cleanup are not used, and parameter wdisp/shm_attach_mode  is not explicitly set to another value (see Parameter Overview)

7: As 5


These settings are useful for managing SSL client IP addresses. With the appropriate settings, this information does not get lost in the SHM, but can be reused if the SAP Web Dispatcher crashes. See also SAP Web Dispatcher and SSL.

      -auto_restart: With this option you can enable high availability for the SAP Web Dispatcher at process level. The process is described in the section High Availability of the SAP Web Dispatcher.

      -version displays the version of the SAP Web Dispatcher. The program is not started.


You usually start the SAP Web Dispatcher as follows:

sapwebdisp pf=<Profile name>


You can also start the SAP Web Dispatcher without a profile by using the Bootstrap Option.

Setting Up a Windows Service

In Windows you can set up the SAP Web Dispatcher as a service. It will then always be started automatically whenever the computer is restarted.

Call the following:

ntscmgr install sapwebdisp -b <path>\sapwebdisp.exe -p "service pf=<profile file> <options>"

<path> stands for the path in the file system where the program is stored, <options> for more parameters as described above. If the path contains blank characters, you have to enclose the path in quotation marks (for example: -b "C:\Program Files\sapwebdisp.exe" ...).

You then see the SAP Web Dispatcher sapwebdisp in the list of services.

You can then maintain the restart properties for the service on Windows level to make the Web Dispatcher highly available on process level.


        ntscmgr is an SAP program that must be installed on the server. For more information see SAP Note 618053.

        If you have any problems due to missing Microsoft DLLs, refer to SAP Note 684106.

More Information

Importing the SAP Web Dispatcher

Starting the SAP Web Dispatcher with the Bootstrap Option




End of Content Area