License and activation token
Overview
A license is the right to use a software product, limited by the terms of the license agreement.
To start operating the platform under the license agreement, the platform installed from the distribution must be activated. Activation is performed with a license token bound to a specific platform instance and installed product.
The activation token:
-
Is created by the licensor based on the license agreement and the activation code generated by the platform instance via the API.
-
Is uploaded via the API into the master domain of the system. It can be uploaded in the Settings application by the master domain administrator manually, or from the license server by the tool when identification information is entered.
-
Contains information about the usage limits of the system instance, allowing it to be operated in accordance with the license agreement.
-
Has a validity period for the activated license parameter configuration; with long-term use, this requires periodic token renewal manually or automatically with the system connected to the internet.
-
Has an application deadline, after which the specific token is considered expired and cannot perform activation.
-
Can be provided by the license server automatically.
-
Can be provided by the license server based on HTTP requests for systems installed in an isolated environment.
-
Is applied, maintained, and reserved on all servers with the mdc role.
-
Is stored on the system servers in encrypted form and cannot be transferred manually.
Activation
Automatic activation, update, and renewal
This method applies if:
-
the version of the system being activated is 1.9 or newer,
-
the license request returned a license number and a list of several passwords,
-
the system being activated has internet access.
-
Log in to the installed system to be activated.
-
In the menu, under "Domain", open the "Licenses" tool.
-
In the "Token activation" section, click "Get activation code".
-
In the "New license" field that opens, enter the identifier and one of the previously unused passwords in the following format:
ID/PWD(numeric identifier, slash, password). Click Apply. -
On success, a green pop-up appears, and the "License information" section shows the current data for the platform instance.
-
The system will then automatically poll the license server periodically to update the token and license information. If the license composition changes as planned, you can speed up the update with the "Update token" button in the "Information" section.
If you need to reactivate another system instance, use the remaining passwords. Automatic license renewal for the previously activated instance will stop. Each password can be used once.
Manual activation, update, and renewal for isolated systems
This method applies if:
-
the version of the system being activated is 1.9 or newer,
-
the license request returned a license number and a list of several passwords,
-
the system being activated has no internet access.
The procedure is:
-
When requesting license creation, in addition to the other required parameters, specify that the license is for an isolated environment.
-
Obtain the identifier and a list of several passwords.
-
Log in to the pre-installed system to be activated. Open the Settings application (in the master domain). In the menu, under "Domain", open the "Licenses" tool.
-
In the "Token activation" section, click "Get activation code".
-
Copy the resulting activation code to the clipboard and save it for transfer to a computer with internet access.
-
Open a browser on the computer connected to the internet. In the address bar, enter
https://activate.incoplax.comand follow the application prompts. You will need the identifier from step 2, one of the previously unused passwords from there, and the activation code copied in step 5. The password can be omitted if a token is being renewed and the activation code was taken from a previously activated, currently valid system. -
If everything is correct, the server returns a file with the license token, which has a limited time for activation. Open the file, copy the value, and transfer it to the system being activated in the isolated environment.
-
Enter the token in the "New license" field where the activation code was taken in steps 4-5. It is important that the session is the same. It is important that token activation is performed promptly after the license server issues it.
If necessary, after a failure, you can obtain a new activation code and perform the procedure more quickly. You can use the same password; if it is incorrect, the license server will report this as an error.
A system activated in this way needs periodic token renewal. Perform this operation at the scheduled time, taking into account the token lifetime. If the token is renewed in time, no password is needed because the tokens are linked in a blockchain whose information is passed through the activation code. If renewal is late, a new password may be required.
If you need to reactivate another system instance, use the remaining passwords. Automatic license renewal for the previously activated instance will stop. Each password can be used once.
Activation of older versions (before 1.8)
If the license request returned a token, enter it into the system manually.
This method was used up to version 1.8.
-
Log in to the installed system to be activated.
-
In the menu, under "Domain", open the "Licenses" tool.
-
In the "Token activation" section, click "Get activation code".
-
In the "New license" field that opens, enter the previously issued token and click "Apply".
Licensed parameters
The decrypted license file is a JSON structure that the system exposes transparently through the license management API.
Distinguish between the contents of the license file and the current effective license values. The file may contain, as conditions, time ranges of parameter availability, combined values, and various license parameter configurations bound to time periods.
For convenience, the API allows viewing the decrypted file contents and the currently effective license independently.
{
"products": "incoplax",
"topleveldnpolicy": 1,
"dql": {
"domains": 100,
"devices": 15000,
"siptrunks": 3000
}
}
{
"products": "incoplax",
"topleveldnpolicy": 1,
"dql": {
"domains": 100,
"devices": 1000,
"siptrunks": 1000
},
"licensed_to": "Company X",
"licensed_number": "712158",
"configurations": [
{
"smart": {
"dtstart": "2017-12-01",
"dtstop": "2018-01-31"
},
"dql": {
"domains": 100,
"devices": "5000;10000,tilldt=2018-01-12",
"siptrunks": "1000;2000,tilldt=2018-01-12"
}
},
{
"smart": {
"dtstart": "2017-01-01",
"dtstop": "2020-12-31"
},
"dql": {
"domains": 100,
"devices": 3000,
"siptrunks": 1000
}
},
{
"smart": {
"dtstart": "2020-12-31"
},
"dlgtimesec": 30
}
]
}
Basic parameters
| Key | Description |
|---|---|
|
License start date (from the license agreement). Displayed in the license parameters. |
|
License end date (from the license agreement). Displayed in the license parameters. |
|
Activation token creation date. Displayed in the license parameters. |
|
Date after which the token can no longer be activated. The token must be applied before this date. |
|
Token expiration date. Before this date, the system must obtain a new token from the license server, or a fresh token can be uploaded manually. Displayed in the license parameters. |
|
Date after which the system health monitoring starts showing a warning about the upcoming expiration of the token or license. As a rule, two weeks before the 'tdate' parameter. |
|
Date/time when the token was created by the license server. Refines the 'cdate' parameter and is used by the system. Filled only when the token is obtained from the license server. |
|
Date/time of the next token update on the license server. The system tries to obtain a new token starting approximately 2 hours before the specified value. On failure, the attempt is repeated every hour. The system remains activated until the 'stop_dt' time expires. Only a previously activated system can freely update a token through the license server if its identification characteristics remain the same. Each time a fresh token is issued, the server blocks token updates until sync_dt expires for all systems whose identification characteristics differ from the recipient of the last token. If the active service moves to another server, the identification characteristics probably change. In this case, the active system receives a fresh token strictly after sync_dt. Nevertheless, it remains possible to activate another system instance using another password from the issued list. Filled only when the token is obtained from the license server. |
|
Token expiration time, before which the system must obtain a fresh token. Otherwise, the system becomes inoperable and clears the domain list. Refines the 'tdate' parameter and is used by the system. Filled only when the token is obtained from the license server. |
|
Defines the name of the licensed product. The license can be applied only to a system instance deployed from the distribution of the corresponding product. |
|
Product and license information. Licensor, licensee, identification information. |
|
Limit on the supported product version. Example: "1.8" supports all 1.8.* and earlier versions, while 1.9.0 is no longer supported. |
|
Limit on the number of servers in the cluster configuration. |
|
Limits the duration of all conversations. Can be used in test licenses. Unlimited by default. |
|
Mode of applying the quantitative parameter to internal SIP device connections. Values:
When the limit on simultaneously registered devices under a specific account is enabled, the mechanism for polling all registered devices with OPTIONS can be used on a general basis when slots are insufficient. Default: 'contacts_reserved'. Commonly used value: 'accounts_concurrent'. |
|
Limit on first-level domain names.
Default: |
|
Group of quantitative functionality parameters.
Can be extended with other parameters:
|
|
Section containing a list of various configurations and their application conditions. Contains a list of objects, each representing an alternative configuration.
The The first configuration matching all conditions is merged with the base configuration from the root, replacing matching key values, and the remaining alternative configurations are ignored. An alternative configuration can contain all keys of this section ( If a key is missing, it is taken from the base structure. |
Quantitative parameters
Quantitative parameters are set as numeric values and are consumed/restored when entities are created/deleted in domains.
They are contained in the dql (domain quantitative limits) property group.
All quantitative parameters are distributed across the domain tree. Each domain:
-
reserves part of the quantitative licenses received from the parent domain for internal use,
-
passes part of the quantitative licenses to its child domains,
-
leaves the rest unused; they can be reclaimed by the parent domain administrator if necessary.
Reservation is performed via the domain settings management API (the licowned key), and transfer to a child domain is performed via the domain entity management API (the lic field).
| Key | Description |
|---|---|
|
Number of domains. One is consumed for each domain. If a domain lacks licenses, a new child domain cannot be created. |
|
Number of registered SIP devices under SIP user accounts. Distributed across SIP user accounts. Consumed, depending on the configured mode, one per account with at least one active registration (including P2P), or per separate SIP device at registration time. Not redistributed automatically between accounts. If a domain lacks licenses, the SIP user entity cannot be changed to increase the number of devices or a new one cannot be created. Reaching the limit within a SIP user entity causes registration of a new device to be rejected if the maximum number is already registered. However, situations are possible when a device initiates a new registration without deleting the previous one on the server. To avoid such problems, before rejecting registration due to insufficient licenses, the system polls the registered devices with a SIP OPTIONS request. Registration is rejected only if all registered devices responded correctly. Otherwise, registration is performed in place of the "zombie". |
|
Number of simultaneously active trunks on SIP provider accounts. Distributed across SIP provider accounts. One is consumed for each call through the esg role and released when the call ends. Not redistributed automatically between accounts. If a domain lacks licenses, the SIP provider entity cannot be changed to increase the number of trunks or a new one cannot be created. Reaching the limit within a SIP provider entity causes the next call to be rejected. |
Distribution of quantitative licenses across the tree
The distribution algorithm is:
-
The master domain receives the license directly via the API or from the HDD.
-
The master domain passes quantitative licenses to child domains via their
licproperty. -
Each working domain receives a license from its parent domain.
-
The working domain reserves part of the received quantitative licenses for internal use via settings, the licowned key.
-
The working domain passes part of the reserved licenses to its entities (for example, sipuser, provider) via their
licproperty. -
The working domain passes part of the received and unreserved quantitative licenses to child domains via their
licproperty.
Extending the product license
The license file extends the values of the product license.
All quantitative values are summed; qualitative values are activated if they are present in at least one of the matching configurations.
The 'tilldt' suffix for 'dql'
The suffix can be added to the string representation of any value in the dql section of the license file and limits the application of that value until the specified date.
It can combine several values at once.
For example, the standard value "devices": 100 can be changed as follows:
-
"devices": "100": does not change behavior. -
"devices": "100,tilldt=2025-10-01":100until October 1, 2025, then0. -
"devices": "100;500,tilldt=2022-10-01;200,tilldt=2023-02-23":800until October 1, 2022,300until February 23, 2023, then100.
Specifics
Every few minutes, the license is recalculated, updating its conditional values.
If values decrease, the server reloads the domain tree. Reserved licenses (licowned) exceeding the new value are reduced to it.
Licenses can be reclaimed from child domains in an amount not greater than X = T - O - D, where
-
T- the number of licenses allocated to the domain, -
O- the number of reserved licenses, -
D- the number of licenses allocated to child domains.
If a domain is blocked (the opts.isblocked property), all licenses can be reclaimed from it. Licenses allocated to a blocked domain are not consumed: they are available to the parent domain, and when the block is removed the system checks that they fit into the available licenses again.
If communication between sites is lost, they retain the last active license until successful synchronization with the master site. After a restart, the system also applies the last active license.
Unlimited values of quantitative license parameters (numeric values greater than 123456789) set in the product asset defaultlic.json are distributed across the domain tree automatically.
License token lifetime
The license token is time-limited.
A token has:
-
creation time,
-
activation deadline,
-
initial synchronization time with the license server,
-
token validity deadline.
During the token validity period, quantitative values can also be dynamically limited. For this purpose, you can use:
-
the
tilldtsuffix on specific values; -
alternative configuration settings bound to time.
Test licenses
For test operation limits, you can use:
-
the
dlgtimesecparameter; -
time-based limits:
-
reducing quantitative values, including domains;
-
activating alternative configurations with disabled functionality.
-
See also
-
API activation code.
-
API license management.
-
Asset product license.
-
Entity domain.