Skip to content
Entitlement Management Service

Adoption information

Entitlement adoption is a process involving many different roles - it is much more than an engineering effort. The information in this technical documentation solely addresses the engineering components of adopting an Entitlement.

Dependencies

The list of key technical dependencies for adopting Entitlement v4 is given below:

  1. Entitlement depends on Trimble Identity for named-user and named-device licensing. Users must have a Trimble ID to be assigned to a license. Devices must be provisioned with a Device ID.

  2. All applications have been registered in the Cloud Console and subscribed to the Entitlement v4 API. For more information, see API Cloud and subscribe your application to Entitlement v4 API.

  3. Account information should now be retrieved from Account Profiles. For more information please see the Profiles documentation.

  4. Implement license enforcement mechanisms within your application. Entitlement will tell you what a user is entitled to. Entitlement does not do any enforcement based on that information.

  5. Define your product SKUs (refer to the following section).

SKU setup best practices

If you are a product manager, you need to set up your Product SKUs and map product features to Entitlement features. If you are an engineer, you need to get the base features, and talk to your product manager to determine which Entitlement features correspond to which features in your application that users should have access to.

SKU setup for your products impacts key elements of license checks and license enforcement:

  • Access patterns after you sign in to an application.
  • Access to feature sets within an application.
  • Recording of usage of features for license enforcement.

Features can be grouped into two categories: Base features - which gate access to application, and Functional features - which gate access to functionality and may be used to track and limit usage.

Rule 1: Create one base feature per application

For every application, there should be one base feature that is used to identify basic access to the application.

Rule 2: Create one functional feature for each component you are selling with usage limits

To use Entitlement’s Usage functionality, each component that has limits on the quantity available should be separated out into its own feature. There are no limitations on either the type of metric you track or the maximum quantity for that metric. Some example usage metrics include:

  • Maximum number of projects
  • Maximum data storage
  • Maximum number of custom attributes
  • Maximum number of guest users

Rule 3: In case, your application has a Reporting / Analytics module that is always included in the premium tier of your application and can also be purchased as an add-on to your base tier, then split out into its own feature.

Suppose your application has a Reporting / Analytics module that is always included in the premium tier of your application but can also be purchased as an add-on to your base tier. In this case, split out into its own feature.

Rule 4: Start with the most straightforward feature set you can, and grow complexity only as necessary

Don’t start by creating entitlement features for every single feature in your application.

Rule 5: A new functionality called Services is introduced in Entitlement to group your applications’ features under a common category or namespace to simplify naming and governance of features. The service names must be globally unique, with feature names are required to be unique within a service.

Services are new functionality in Entitlement to group your applications’ features under a common category or namespace, simplifying naming and governance of features. Only service names must be globally unique, with feature names required to be unique within a service.

We recommend you use one service per application.

Linking to AXP for license administration

AXP is the new standard license administration tool that replaces the existing tools such as Account Management Portal (AMP), License Management Portal (LMP), License Manager, and others. AXP is a web-based application that is accessible from any browser.