Licensing ServiceControl

There are a few options to add a license to ServiceControl.

Note that the license file might allow running multiple products (NServiceBus Core, ServiceControl and ServiceInsight). Therefore the license file can also be loaded from other platform tools to achieve the same end result, as long as the licensing method imports the license into the registry.

ServiceControl Management tool

ServiceControl has a license user interface which can be accessed in ServiceControl Management. ServiceControl Management is installed together with ServiceControl and can be found in the Windows Start Menu.

The designated license file will be imported into the registry. The license file is added to the HKEY_LOCAL_MACHINE registry hive so it is available to all instances of ServiceControl regardless of the service account used.

ServiceControl PowerShell

To import a license using PowerShell:

Import-ServiceControlLicense <LicenseFile>

License from file system

It is also possible to load the license from the file system but this must be done manually. This allows the license to be loaded from (for example) a central network share instead of the registry.

Add the NServiceBus/LicensePath application setting to the ServiceControl.exe.config configuration file.

The easiest way to find the configuration file is by launching the Service Control Management Utility (SCMU), navigate to the relavant instance and open its deployment paths.
<add key="NServiceBus/LicensePath" value="d:\NServiceBus\License\License.xml" />

Using other platform tools

See the ServiceInsight licensing page or the instructions for licensing manually using the registry for more information.

Instance licensing

In Versions 1.17 and below, a license can be applied to an individual instance rather than using a license installed in the registry. To do this, copy the license.xml file to a license directory under the installation path of the instance.

Instance Licensing is deprecated in Version 1.18 and above. Use ServiceControl Management or the ServiceControl PowerShell module to install the license file to the registry.

Troubleshooting

ServiceControl license was updated, but ServicePulse reports the license has expired

License information is read at service startup and cached. Once a new license is applied the ServiceControl instance must be restarted to detect the license change, until then the license status shown in ServicePulse is based on the cached state.


Last modified