Skip to Content
PortcullisDocs
Concepts

Licenses and entitlements

What a license contains, how entitlements work, and what the license key is for.

A license is a customer's right to run one product. It carries a policy (how long, how many installations, how often to check in) and entitlements (which features and limits apply). Digicom staff issue licenses from the Portcullis console.

Policy

Each license stores its own copy of these values. They are pre-filled from the product's defaults when the license is issued, so later changes to product defaults never alter an existing license.

FieldMeaningTypical on-prem value
typeperpetual, time_limited or trialtime_limited
starts_atNot valid before this datecontract start
expires_atLicense end (empty = perpetual)contract end
maintenance_expires_atProduct builds released after this date are not covered (empty = always covered)= expires_at, or +1 year for perpetual
max_machinesMaximum concurrently active installations (0 = unlimited)2 (production + DR)
check_in_interval_hoursHow often online installations refresh (empty = never; offline-only)24
lease_daysHow long an online-issued license file is valid30
grace_daysProduct keeps working, with warnings, after lease or license expiry14
allow_offlineDigicom may issue offline (air-gapped) license filestrue
auto_release_daysInstallations that stop checking in are released after N days (empty = never)empty

Entitlements

Each product declares its features. A license gives each feature a value, called an entitlement.

Feature codeTypeExample value
module.tripsbooleantrue
module.fuelbooleanfalse
limit.vehiclesinteger500
limit.usersinteger50
editionstring"enterprise"

Conventions:

  • module.* booleans switch features on or off. A missing boolean means false.
  • limit.* integers are caps. -1 means unlimited.
  • Anything else is informational.
  • Products ignore feature codes they don't know, so Digicom can add features without breaking older builds.

The product enforces limits locally, because it knows its own usage (for example its vehicle count). It reports actual usage at check-in so Digicom can see compliance.

License key

The key looks like OMF-7KQ2M-HX9TB-P4WRN-3ZC8D: a product prefix followed by 20 random characters (no 0, O, 1 or I, to avoid confusion). Lowercase, spaces and missing dashes are accepted.

  • The key is a secret used only for online activation. It carries no data and is not signed. Treat it like a password.
  • The signed license file is the actual proof of entitlement.
  • Digicom can rotate a key (for example if it leaked). Installations that are already activated keep working; new installations need the new key.

On this page