License Keys

License Keys

• Published on Sep 17, 2024
• 3 minute(s) read

This feature applies only to on-premise deployments of v39 and later.

After installing or upgrading to Hyperscience v39 or later, you need to enter a license key before logging in to the application. A license key is required for each individual instance of Hyperscience, no matter what its environment type is (e.g., development, UAT, production).

Each license key is created for a specific instance of Hyperscience and is only valid for that instance. If a key created for one instance is entered in another instance, an error message will appear, asking the user to enter a valid license key.

To obtain a license key, reach out to your Hyperscience representative. In order for the key to be created, you will need to provide the browser URL of your application, and you need to indicate which environment the license key will be applied to. Only one license key is required for each instance, regardless of the number of servers it contains.

After you enter the license key, it is stored in your instance's database.

License key statuses

An instance's license key can have one of the following statuses:

• Active — The license key is valid and does not need to be updated.
• Expiring — The key is set to expire soon, but the system is still fully functional. The length of time a key can be in this status before the expiration date is equal to the length of the key's grace period. For example, if the grace period is 30 days, the key enters the Expiring status 30 days before its expiration date.
• Extended — The key has passed its expiration date and entered into its grace period. The system is still fully functional.
• Expired — The key has passed its expiration date and grace period. The functionality of both the application and API is completely blocked until a valid license key is entered. However, none of the existing data is affected, and any processes currently in progress will continue until their completion.
• Missing — No license key has been entered for the instance. The system's functionality is limited to entering a license key.
• Invalid — The entered key is not valid (e.g., the key wasn’t provided by Hyperscience). The system's functionality is limited to entering a license key.

Providing a license key during installations or upgrades

If you're a System Admin, you're prompted to enter a license key the first time you log in to the application after installing Hyperscience or upgrading to a new major version (v39 or later).

You do not need to enter a license key after upgrading to a patch version of your current version of Hyperscience. For example, when you upgrade from v39.0.1 to v39.0.2, you do not need to enter a license key after upgrading. Also, if your license key is still valid when you upgrade to another major version (e.g., v40), you will not need to enter a license key after upgrading.

Updating a license key after contract renewal

You can enter a new key after contract renewal from the System & Health page:

1. Go to the System & Health page ( Administration > System & Health), and click Add License Key.
2. Enter the license key in the dialog box, and click Add License Key.

We recommend updating the license key outside of business hours, as system responsiveness may be reduced for up to one minute after the update. Processing and system access are not impacted.

Viewing the status of a license key

You can view the status of your license key, along with its expiration date and time, at the top of the System & Health page.

In some cases, a dialog box or banner notifies you of the status of your license key: