SSO Configuration Application MMC Snap-In

|  Posted: November 16, 2009  |  Categories: General Technical
Tags: General

For those of you who have used BizTalk long enough, its not a surprise : The Enterprise single sign on capabilities that comes as part of BizTalk server is used to store lot of confidential information in  a secured way, without SSO you can’t setup a BizTalk environment. BizTalk Server internally uses SSO to store lots of its internal configurations like adapter data, configuration you put on send/receive ports etc, etc.

Another less known factor (at least for beginners) is that, you can keep your own configuration data in SSO database (the things you normally keep in an app.config file).  In the past, its not a straight forward approach due to lack of tooling. People like Richard Seroter came with custom tools to tackle this issue, which helped.

Recently Microsoft released a MMC snap-in to tackle this exact issue. You can download the full package from here. The installation comes with

1. MMC Snap-in to manage a SSO application (Create, import, export, delete etc), Manage your custom key/value pair data.

2. It comes with .cs helper file with a static method to read the data,

3. MSBuild task, which helps to import your custom application during deployment (this is supper cool).

Let just see a “Hello World” walk through example:

1. Download and install the MMC snap in from here

2. Open “SSO Application Configuration.msc” mmc snap-in

3. Right-Click on the top node “<your company name> SSO Application Configuration” and select “Add Application”, give the name “HelloWorld”.

4. Right-Click on the “HelloWorld” node, and select “Add Key Value Pair”, provide the values Key=”LoggingEnabled”, Value = “True”

sso configuration

5. Create a console application, add reference to the dll “C:Program FilesCommon FilesEnterprise Single Sign-OnMicrosoft.BizTalk.Interop.SSOClient.dll“, include the “SSOClientHelper.cs” helper file (part of the download).

6. Now you can access the key data as shown below

Console.WriteLine(SSOClientHelper.Read(“HelloWorld”, “LoggingEnabled”));

MSBuild Task:

The mmc snap in allows you to export the SSO application in an encrypted format. You can later import it either using the mmc snap-in, or you can bundle it as part of msbuild task (if in case you already got your deployment configured using msbuild) as shown below

<Target Name=”ImportSSOApp”>
<ImportSSOConfigurationApplicationTask EncryptionKey=”test” EncryptedFile=”C:UsersAdministratorDocumentsSSO App ExportTestApp.sso” />
<Message Text=”Imported SSO Application” />

Author: Saravana Kumar

Saravana Kumar is the Founder and CTO of BizTalk360, an enterprise software that acts as an all-in-one solution for better administration, operation, support and monitoring of Microsoft BizTalk Server environments.

  • BTGuy

    Thanks for the tip. It made easier to maintain Applications within the SSO DB

  • Hans Johanss

    When I used the tool I never got any of my key/value pairs into the program and well… I realised something was wrong.
    This lead me to try a repair and later a try to uninstall the tool. This lead to some wierd errors that I really need help with.

    First Error When trying to “repair” the tool:

    The following information was included with the event:

    Product: SSO Application Configuration — Error 1001. Error 1001. Company Name is a required field.





    description for Event ID 11001 from source MsiInstaller cannot be
    found. Either the component that raises this event is not installed on
    your local computer
    or the installation is corrupted. You can install or repair the
    component on the local computer.

    If the event originated on another computer, the display information had to be saved with the event.

    The following information was included with the event:

    Error 2 while uninstalling:

    SSO Application Configuration — Error 1001. Error 1001. An exception
    occurred while uninstalling. This exception will be ignored and the
    uninstall will
    continue. However, the application might not be fully uninstalled after
    the uninstall is complete. –>
    Cannot delete a subkey tree because the subkey does not exist.





    The tool is currently unusable. And worse, we cannot uninstall and re-install this tool. Please advise.

    • Bensonius

      I’ve been having this exact same issue, can’t install or uninstall. Were you able to resolve the issue? If so, how?

      • Hans Johansson

        Nope, we dropped the program and went for manual addition to the SSO-database and then we used the BizTalk Deploy Framework from codeplex and its SSO solution.

Back to Top