Configuring UNIFYBroker for use with Embedded Web Server

DEPRECATED: Please note that as of UNIFYBroker v5.2, this feature is deprecated. Configure IIS instead.

UNIFYBroker is configured by default to use its own embedded web server. This article details the configuration of this web server, which is enabled by default.


The configuration is modified through the file Unify.Framework.Web.WebEnginePlugInKey.extensibility.config.xml

This file can be found in the directory %Installation Directory%\Services\Extensibility

The configuration structure of the web server is described by a single configuration element.

<? xml version="1.0" encoding="utf-8" ?>
<WebEngine changeId="{...}" enabled="true">
   <Configuration <!-- Configuration Details --> />

For use with IIS, the web engine should be disabled. This can be accomplished by setting the enabled property of the web engine to false.

The following configuration settings can be defined in the <Configuration> element:

Attribute Name Description Required
applicationPath The physical path of the web server files. Absolute or relative paths may be used. The default value is ..\Web True
port Sets the port number that the web server will be bound to. The default value is 8008. True
ipAddress The IP Address that the web server will be bound to. If not provided, will default to the IP loopback address. False
virtualPath Virtual path of the web server. If not provided, will default to /. False


The intended use case for the embedded web server is for a single administrator configuring UNIFYBroker; requests made by this server are executed sequentially which can impact performance. Additionally, more advanced security configuration is not available. Performance may also be impacted in large or complicated solutions, which may require setting up a separate web server.

It is recommended that in the event that interactions are being made through a single web server with multiple users, that the hosted IIS web server be configured.

For more information on hosting UNIFYBroker on IIS, see Configuring for use with IIS

Is this article helpful for you?