How to use a session based license?

DeepSight Session Licensing Explained:

1. DeepSight Session license

The DeepSight session license is designed to work with our non-GUI Toolkit and our SDKs. Each license for a session is time-based. The time settings are stored both at the Sightcorp licensing server side and at the client side.

The license key authentication mechanism assumes internet availability, however it provides ways of handling failure exceptions in case of network infrastructure issues. This mechanism is described further in the document.

2. License Key Registration

The time based license keys for the Toolkit/SDK sessions is set in the settings file when setting up the Toolkit/SDK 

The license key will be valid for a pre-defined duration of time (e.g. 1 year) and pre-defined number of sessions as per contractual agreement.

1. When starting the Headless Toolkit or SDK, it will authenticate the validity of the license key with the Sightcorp licensing server;
2. If there is time and session slots available on the license key, the server will approve the authentication and the Toolkit/SDK session will start;
3. Upon successful authentication, the validity duration of the license key will be set both on the Sightcorp server and at the client's side;
4. In case of a failed authentication, the Toolkit/SDK will not start and it will need to be manually restarted by the user (this can also be easily automated via a short script).

3. Authentication at session start

1. When starting the Headless Toolkit or SDK, it will authenticate the validity of the license key with the Sightcorp licensing server;
2. If there is time and session slots available on the license key, the server will approve the authentication and the Toolkit/SDK session will start;
3. Upon successful authentication, the validity duration of the license key will be set both on the Sightcorp server and at the client's side;
4. In case of a failed authentication, the Toolkit/SDK will not start and it will need to be manually restarted by the user (this can also be easily automated via a short script).

4. Authentication at session stop

When a Toolkit/SDK session is stopped, an ‘end-session’ ping will be sent to the Sightcorp server;

Once the ping is received, the session slot is released and can be used by another Toolkit or SDK session.

5. Unexpected interim failure

• If the session unexpectedly stops (e.g. due to a network issue) while the Toolkit/SDK is running, the session will not be terminated right away. Instead the software will try to authenticate the license with a ‘KeepAlive’ message to the server;
• The authentication will be attempted 8 times, once every 30 minutes;
• During this period, the data collected by the Toolkit/SDK is not lost and will still be stored in the CSV locally;
• If the data push keeps working (no interruption with the push server), that will work as usual;
• On an ultimate successful authentication, the Toolkit/SDK session is restored as before with the same license key;
• If the Toolkit/SDK session is unable to authenticate after 8 tries, the Toolkit/SDK will stop the process and the licensing server will release the slot for another session to use.

6. Failure (to update license) at stop

1. After a successful start, the licensing server will check whether the Toolkit/SDK session is still running by looking for the “KeepAlive” message from the Toolkit;
2. Assuming an occasional ‘KeepAlive’ message can fail because of internet, power or other issues – the Toolkit/SDK session will not be terminated right away;
3. The Sightcorp server will keep checking at the aforesaid regular intervals, and only in case of 8 successive failures, the session would be assumed to have stopped;
4. In such a case the license will be released so that it can be used for another session;