CONSUMPTION BASED LIMITATIONS – Help Center | SLASCONE

Entitlement in its simplest form is about enabling/disable product features. In addition to that, SLASCONE’s licensing core provides limitations, which are numerical values used in order to restrict the scale of some operations e.g., maximum number of users or jobs.

Limitations can be used/interpreted by the client application in two ways:

Static: In such case, the limitation constitutes a global restriction, regardless of usage patterns, e.g., maximum number of documents that can be stored in a database. It is the client’s responsibility to ensure compliance of this limitation.
Consumption-Based Quota: In this case, the limitation constitutes a consumption-based quota, that resets periodically. For example, the license allows the creation of 10 documents monthly. SLASCONE tracks the consumption of this quota and informs the client when the quota is depleted.

DEFINING A CONSUMPTION-BASED LIMITATION

Whether a limitation is static or consumption-based, is defined in the license. In case of consumption-based, you have to additionally define the reset mode:

Lifecycle: In this reset mode, the defined quota, for example 10 documents, does not reset, which means once the 10 documents have been created, SLASCONE informs the client, that no more are allowed. This mode is typically used in trial licenses.
Periodical (number of days): In this reset mode, the quota is reset every n days.
First day of month/quarter/year: In this reset mode, the quota is reset on the first day of the next month/quarter/year.

GOODWILL

A typical requirement in such scenarios is the ability to allow an overconsumption, or goodwill. In SLASCONE you can define this in percent. A limitation of 10 combined with a 20% goodwill, means that a consumption of up to 12 is allowed but not more.

The goodwill percentage is an edition (not a license) property.

CONSUMPTION MONITOR

The vendor portal provides an overview of the consumption and the actual balance:

CLIENT/API CONSIDERATIONS

CONSUMPTION HEARTBEAT

Before starting a client action involving a consumption limitation, the client has to send a consumption heartbeat to SLASCONE:

POST /isv/{isv_id}/data_gathering/consumption_heartbeats

The consumption heartbeat is going to return the information, if there is enough quota.

If there is not enough quota, the response contains a null transaction_id.
If there is enough quota, the response contains a valid transaction_id.

With a valid transaction_id, the client can start performing the relevant local operation (e.g., processing of a document).

ROLLBACK

In case the relevant local operation failed, you should rollback the heartbeat in order to make sure that no quota was used for a failed operation.

POST /isv/{isv_id}/data_gathering/consumption_heartbeats/rollback

VALIDATION

If you want to check the consumption balance without sending a heartbeat you can use the following method.

POST /isv/{isv_id}/provisioning/validate/consumption