Skip to content

Register a License to a HMI Device

A HMI Device must have a license to exchange data with iRis Cloud. You register a license while adding the HMI Device, or later from the HMI Device details. Licenses that are registered to your account but not yet assigned to a HMI Device are offered as Available licenses — see Receive Purchased Licenses for how they get there.

  1. Navigate to Entities → Devices, click +, and select Add new device. The Add new device dialog opens.
  2. Enter a Name for the HMI Device.
  3. Enter the Access token of the HMI Device and click Validate. The field takes letters and digits in the form XXXXX-XXXXX and inserts the hyphen for you. “This access token is valid.” confirms it; “Access token is already in use.” means the token belongs to another HMI Device.
  4. Check what the dialog says about the license:
    • After the token is validated, a message shows “A 1-month free trial will be applied” with the trial period, and the field reads License code (optional). Leave it empty to use the trial, or enter a code to use a paid license from the start.
    • “This access token has already used the free trial” — “Enter a license code to add the device.” appears in the dialog, and the License code field is required.
  5. To use a code, type it or pick one from Available licenses, then click Validate. “This license is available.” confirms it.
  6. Click Add. “The device was registered.” appears, the dialog closes, and the HMI Device is listed with its license.

When you click the License code field, Available licenses lists the pending licenses of your account — each with its code, its period and tag limit (for example 1 year(s) · 100 tags), and its product name. Typing narrows the list to the codes that start with what you typed; “No matching license code” means nothing matches. Selecting a license fills in the code — you still need to click Validate. The field takes the code in the form XXXX-XXXX-XXXX-XXXX and inserts the hyphens for you.

Open the HMI Device details and click the License tab. It has two sub-tabs:

  • License detail — the License code (for a paid license, a link to the License management page), Product, Start date, and Expiration date of the current license, or “No license is currently registered.” During the free trial a note reads “Free trial active” — “A paid license is required after the trial ends.”; after it, “Free trial expired” — “Register a paid license to continue.”
  • License history — every license change of the HMI Device, newest first: Changed time, Product, License code, Changed by, Status, and Change details. Use the search field (“Enter product, license code, changed by, status, or change details”) to filter it.

The Details tab also summarizes the license in its License field: “No license registered.”, Free trial in use with Expires <date> (D-n), Free trial expired with Expired <date>, or the license code with the days left — for example XXXX-XXXX-XXXX-XXXX (D-12), or (Expired) once it has expired. For a paid license the code is a link to the License management page.

A banner at the top of the HMI Device details tells you when action is needed, and carries a Register license button:

  • “You are currently using the 1-month free trial” — with “Expiration date : <date> (D-n)”; shown for the whole trial.
  • “Your 1-month free trial has expired” — “Register a paid license to keep using the device.”
  • “Your license is about to expire.” — shown during the last 30 days of a paid license, with the expiration date and the days left.
  • “Your license has expired.” — “Please register a new license.”

During the last 30 days of a paid license, and after it has expired, a Register license button also sits next to the License field.

  1. Click Register license. The Register license dialog opens.
  2. Type a license code or pick one from Available licenses, then click Validate. “This license is available.” confirms it.
  3. Click Register. “The license was registered.” appears, the new period starts, and the previous license is kept in the License history.

A paid license can be replaced only during its last 30 days or after it has expired — earlier, the button is not shown, and the license server would refuse with “The license cannot be renewed yet because more than 30 days remain until expiration.” The free trial can be replaced by a paid license at any time. If the seller extends the current license instead, there is nothing to register: the license keeps its code and only the expiration date moves — see Licenses Overview.

Messages shown under the Access token and License code fields:

MessageMeaning
”Access token is required.” / “Invalid access token format. (e.g. XXXXX-XXXXX)“Enter the token as five letters or digits, a hyphen, and five more.
”This access token is valid.”The token can be used for this HMI Device.
”Access token is already in use.”The token belongs to another HMI Device.
”Enter a license code.”A code is required for this token.
”Check the license code format.”A code is four groups of four letters or digits.
”Validate the entered license code.”Click Validate before Add or Register.
”This license is available.”The code is valid and not in use.
”License code is invalid.”The code does not exist. Copy it from the claim page or the License management page instead of typing it.
”License code is already in use.”The code is assigned to another HMI Device. Use a pending license.
”License code has expired.”The code’s period has ended. Use a pending license.

A failure also shows a notification with the message and its error code, for example “License code is invalid. (ECH00215)” — see License Error Messages.