Thank you for your feedback.
Form temporarily unavailable. Please try again or contact to submit your comments.
  • London
  • Kingston
  • Jakarta
  • Istanbul
  • Helsinki
  • Geneva
  • Store

Add a SAM Foundation software entitlement

Add a SAM Foundation software entitlement

Software entitlements enable you to define license details that are matched to software models.

Before you begin

Role required: sam_user

About this task

Software entitlements are stored in the Software Entitlement [alm_license] table.
Note: Entitlements are assigned to Add a SAM Foundation software model, which are different than software discovery models.


  1. Navigate to Software Asset > Licensing > Software Entitlements and create a new record (see table for field descriptions).
    Table 1. Software Entitlement form
    Field Description
    Display name Automatically generated name based on asset tag and model.
    Asset tag Specify the serial number and the bar code for tracking the asset.
    Software model Select the software model to match the entitlement.
    License type Specify the license type. Whether the rights grant full access to the software or if they are being upgraded from a previous version of the software.
    • Full: The rights grant full access to the software.
    • Upgrade: The rights are being upgraded from a previous version of the software.

      When upgrade is selected, the Upgraded Entitlements related list is shown, which is used to specify the entitlements you are upgrading from.

    This field becomes read-only after the form has been submitted.

    License duration Length of time the license is valid. Default value is Perpetual.
    • Perpetual: Duration is continuous.
    • Subscription: Duration is for a specified length of time.
      Duration dates:
      • Start date: Required.
      • End date: If empty, subscription does not expire.

      State is automatically set to In Use when current date is between start and end dates.

      State is automatically set to Retired when current date is past the end date and active rights is 0.

      State is automatically set to On Order when the start date is in the future and active rights is 0.

    Metric group Select the metric group for the software. Each metric group has a set of license metrics that are specific to the publisher.
    License metric Select the license metric for the license group that the software license is counted against when reconciliation is run.

    Point to the reference field icon to view the license calculation.

    • Common:
      • Per Device: Licenses a device for a number of installations of software.
      • Per Named Device: Licenses a specific device for a number of installations of software.
      • Per Named User: Licenses a specific user for a number of installations of software.
      • Per User: Licenses a user for a number of installations of software.
    • Custom:

      Custom license metrics configured, if any.

    Agreement type Select the agreement type.
    • Generic
    • Enterprise Level Agreement (ELA)
    Purchased rights Specify the number of rights that you are purchasing.

    The number of purchased rights for the new entitlement gets set in the Active rights field.

    Active rights [Read-only] Specifies the number of entitlements to be granted for this license.
    Note: If an enterprise contract is attached to the license, the Active rights field is not shown.
    Allocations available [Read-only] Specifies the number of user or device allocations that have not been created for an entitlement.

    Allocations available = (number of active rights) - (sum of all allocation quantities)

    Serial number Unique number assigned for identification of the asset.
    Owned by User or department with financial ownership of the asset. Can be different than the manager.
    State Current state of the asset. Values include On order, In stock, In transit, In use, Consumed, In maintenance, Retired, and Missing.

    If the state is Retired, the Active rights field is set to 0.

    Substate More details about the software license stage. The available substate settings depend on the State selected.

    For example, if you select the Retired state, the substate options available are Disposed, Sold, Donated, and Vendor credit.

    Company Company to which this asset belongs.
    Location Where the license is used. For example, a specific site, country, or region.
    Department Department of the person Assigned to this software license.
    Cost Cost of the software.
    Note: Required for total cost and savings calculations on the Software Asset Management Foundation dashboard.

    For additional field descriptions, see Create assets in Asset Management.

    Upgraded Entitlements
    From Entitlement The entitlement from which rights are upgrading. Multiple upgrade entitlements are supported.

    You can upgrade previously owned rights for a particular version of software to a newer version (for example, Office Professional Plus 2013 to Office Professional Plus 2016).

    Note: This field is shown only when the License type is Upgrade.

    The rights from entitlements that you are upgrading from get deactivated when you upgrade because they are moved to the new entitlement.

    Number of rights Number of rights to upgrade.

    The Contracts related list contains contract details.

    The User or Device Allocations related list contains entitlement allocations.
    Note: This related list is only shown when the License Metric field is Per User or Per Device.

    The Activities related list contains work notes for the asset.

  2. To perform additional configuration, select the new software entitlement record in the Software Entitlements list.
    1. To set upgrade and downgrade entitlements, in the Downgrades/Upgrades related list, create a new record to specify which software models to which you have upgrade or downgrade rights (see table for field descriptions).
      This allows you to set entitlement to previous or future versions of software (for example, the purchase of Office Professional Plus 2016 rights entitles you to Office Professional Plus 2013 as well).
      Table 2. Downgrades/Upgrades form
      Field Description
      Software entitlement Software entitlement with which the upgrade/downgrade is associated.
      Software model Software model of the entitlement.
      Order Order of the upgrade/downgrade.
      Start date Start date of the upgrade/downgrade.
      End date End date of the upgrade/downgrade.
    2. To set up cost-tracking details, configure Expense Lines.
    3. To manage license keys, in the License Keys related list, create a new record to specify the licenses keys allocated to entitlements (see table for field descriptions).
      Table 3. License Key form
      Field Description
      Is allocated Check box indicating that the license key has been allocated.
      License key License key value. Must be unique per entitlement.
      Software entitlement Software entitlement associated with the license key.

Updates to site content will be made starting around 4am on January 17th (Pacific Time) and lasting approximately 6 hours.  This site may be intermittently unavailable.