Why do 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’s 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 or if you have X Engine used at the same time, you need X SDK connections.
Web-based SDK
For the Web SDK, each time a request is sent, one SDK connection is used. The connection remains as long as it receives a request every five minutes or less. Once five minutes have passed with no requests sent, the connection is freed up. If an event listener is being used, then it consumes a persistent SDK connection. The same user sending another request does not use another connection. However, if a second user was to connect at the same time, two certificate parts would be required.
Macro SDK
The usage of macros doesn’t require a certificate part. Thus, no SDK connections are needed.
Workspace SDK (Config Tool and Security Desk)
NOTE: For more information about how certificates work with workspace integration, see SDK certificates for the Workspace SDK in the Security Center SDK Developer Guide.
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, no matter how many tiles are currently shown. Registered components include the tile view, tile widget, and tile properties. For example, if multiple tiles are shown, each with the same tile overlay, it only consumes one connection. ContentBuilder takes one SDK connection to Security Desk where the client application is installed. Custom tasks take one certificate per custom task open.
NOTE: If a user is logged in to 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
Content menu
You need to indicate the licensing structure of your solution in the solution listing when it’s complete and ready for deployment. For example, it could be one connection per workstation, two connections per server, or any other combination of connections.
Plugin SDK (Config Tool and Security Desk)
For the Plugin SDK, only one connection is required per plugin role added to the system. Generally, only one connection is needed. However, if a second plugin role is added, it requires two SDK connections in total.