- 30 Mar 2022
- 4 Minutes to read
-
Print
-
DarkLight
Self Service Licensing Guide
- Updated on 30 Mar 2022
- 4 Minutes to read
-
Print
-
DarkLight
Overview
This article covers the features around self service licensing. Self Service Licensing needs to be enabled through the settings. Once enabled, a thread job in Decisions is ran, which collects information and applies a license for the environment. This thread job is ran every hour and when Decisions is started. The information gathered to apply the license will be the customerID, customer name, contact email and environment type, which is defined under the License Service Setting section. Other information gathered will be the usage data of the environment, such as the Machine name, the number of cores, memory size, IP Address and Instance name of the environment.
Self Service Licensing Guide
After signing up to license Decisions, Decisions sends a welcoming email with Customer Id and Name.
- Sign into Decisions and navigate to System > Settings > Licensing Setting.
- Within the Licensing Settings action menu select Display License Data.
License Server Settings
- Select Edit Licensing Setting in the action menu.
- Select Allow License Requests.This checkbox enables the system to request licenses. If the server that is being configured does not have internet access the method can not be followed. Navigate to Licensing a Server.
License Server Type
There are six main types of licenses provided for a Decisions server:
Trial | Enterprise-level license for temporary use only |
Standard NonProduction | Non-prod licenses cannot be used to serve production transaction levels or concurrent users |
Standard Production | This is for any production server. |
Repository | Used for licensing a Decisions Repository environment |
Disaster Recovery | Used for licensing DR environments |
Enterprise Production | Enables the enterprise module for production environments. The enterprise module includes features such as clustering, multi-tenancy and HL7. |
Enterprise NonProduction | Enables the enterprise module for development/qa environments. |
Multi Tenant License
Set this to true if the Server being configured needs a Multi Tenant License. For multi tenancy the same licensing information will be used by tenants and control instances.
Licensed Company Id
The licensed company id is a globally unique id that is sent from the customer onboarding manager when the license agreement is initiated.
Licensed Company Name
The company name must match the ID provided in the email. If these two values are out of sync the requests will be routed to the sales team.
Email Contact for License
This is the email address that will receive notifications about license updates, and progress for license requests submitted to Decisions. It is ok if this email address is not the same address that the onboarding emails are sent to.
License Contact Phone
Phone number is optional but will allow Support to contact the user if there is a problem with their license requests.
License Setting Actions
Now that the settings are done the server will initiate a license request. From the Licensing Settings action menu, there are a set of actions.
Check For License | This causes the Decisions instance to send a license request to the Decisions licensing server. Used to manually request a license. |
Delete License Server Settings | Removes the license server settings. |
Display License Data | Shows information about the current license installed on the Decisions instance. |
Edit Licensing Settings | This shows a dialog with the licensing settings like Customer Id, Customer Name, etc. |
Check For License
Selecting Check for License will display a pop-up notification that the request has started and then a reply which indicates the state of the request.
Starting License Check | This message indicates that a license request has been started. |
License Received and Installed | This message indicates that a license was received for this server and has been installed. To determine the details of the license, use the ‘Display License Data’ action. |
License Already Installed | The license found is already installed. Please contact support for more help |
Skipping License Check | A license request is already pending. |
Invalid or Unknown Company Id | If the settings have an invalid or an unknown company id and a license is requested a pop-up will show. An email will also be sent. |
Licensing a container
For licensing a container, the license info is specified and stored in environment variables. This is then used for reporting purposes and applying the license to the environment. For more information on the values being collected, please navigate to the License Service Settings section. Below is a list of the environment variables used to retrieve information for licensing:
- DECISIONS_LICENSECOMPANYID
- DECISIONS_LICENSECOMPANYNAME
- DECISIONS_LICENSECONTACTEMAIL
- DECISIONS_ENVIRONMENTNAME
- DECISIONS_LICENSETYPE
Licensing a Multitenant environment
When licensing a multitenant environment, the licensing information is expected for both the tenants and control instances. This information gathered will be can be found under License Server settings
Multiple Requests
If there are several requests submitted back to back a notification will show saying that a request ‘in process’ is preventing another request from running.
If there is no customer account, and one has been requested. It comes to the Decisions team to approve, then an email will be sent. Change the license server settings to match this email. After changing the server settings to match, there will be a string of emails sent about the licensing process.