How are SDK connections consumed?

Development Acceleration Program


Why would I need to confirm the number of SDK connections?

The number of SDK connections corresponds to the required part numbers for your end users to make the solution compatible with their system. It is important to confirm this information so that Genetec representatives can let our mutual customers know what has to be ordered on their production license.

Further details on production part numbers and certificates can be found in the following article: How to obtain my part number and certificate for production?

How can I determine how many SDK connections are needed?

Standalone SDK applications (Console App, WPF Application, Windows Forms App, Windows service, ASP.NET Web Application)

An SDK connection refers to a connection established by the Engine object when logging on to Security Center. Each time the Log On method is called, and a connection to the directory is successfully established, a single SDK connection is used. When the Log Off method is called, the SDK connection is freed up. Therefore, the number of connections needed depends on the number of simultaneous SDK instances the application is running. If you are running X instances of an application concurrently, you will need X SDK connections.


Web-based SDK

For the Web SDK, each time a request is sent, one SDK connection is used. Once the response is received, the connection is freed up. If an event listener is being used, then it consumes a persistent SDK connection so two certificate parts are required.

Workspace SDK (Config Tool and Security Desk)

The usage of SDK connections in the Workspace SDK works differently than in a standalone .NET application. Each user logged in the client application consumes one SDK connection per registered component such as tile view, tile widget, and tile properties. Custom tasks take one certificate per custom task open:

  • If a user is logged in Config Tool and Security Desk simultaneously and there are three components registered in the module, it consumes six SDK connections.

The following Workspace SDK components do not require a certificate:

  • Notification

  • Contextual action

  • Workspace service

  • Map object provider

  • Map object view builder

  • Map searcher

  • Report page

  • Config page

  • Macro

You need to indicate the licensing structure of your solution in the solution listing when it is complete and ready for deployment. For example, it could be one connection per workstation, two connections per server, or any other combination of connections.

For additional information regarding SDK connections in the Workspace SDK, refer to the Security Center developer guide.