Add a custom license metric

  • Release version: Yokohama
  • Updated June 11, 2026
  • 2 minutes to read
  • You can add a custom license metric to modify the default reconciliation process.

    Before you begin

    Role required:
    • to create or modify a custom metric script: sam_developer
    • to read custom metric script: sam_admin

    Role required to create or modify a custom metric script: sam_developer

    About this task

    Custom license metrics can be created to define specific software calculations not included in the predefined license metrics list. Custom license metrics are useful so reconciliation can calculate rights per user or device for certain software products and bundles of lesser-known software publishers.

    For example, you can create a custom metric to avoid over counting installs for products that are part of an unrecognized bundle.

    You can use the Resource Value [samp_sw_resource_value] table to enhance the custom license metric capability by doing a 1:1 calculation between the Units consumed column in the Resource Value [samp_sw_resource_value] table and the Licenses required column in the License Metric Results [samp_license_metric_result] table. You can create your own calculations in your custom license metric scripts and write your own logic to further customize your custom license metric. For information on adding resource values to the Resource Value [samp_sw_resource_value] table, see Specify resource values for your custom license metrics.

    Custom metrics can be disabled using the custom license metric property. This feature is enabled by default.

    Procedure

    1. Navigate to All > Software Asset > Administration > Custom License Metrics and create a new record (see table for field descriptions).
      Table 1. Custom License Metric form
      Field Description
      License metric Name of the custom license metric. This name is shown in the License Metric field of software entitlements, and in the license metric results for the software model.
      Table Source Specify if this custom license metric belongs to the Software Installations [cmdb_sam_sw_install] table or the Resource Value [samp_sw_resource_value] table.
      Note:
      If the table specified is the Resource Value table, the following fields: Reconciliation order – allocated, Reconciliation order – unallocated, and Allocation type are not displayed. Additionally, the Calculation Script shows a sample script related to resource value.
      Metric group Custom license metric.
      Allocation type Allocation type of the metric license, per device or per user.
      • Device
      • User
      Description Description of the custom license metric.
      Reconciliation order — allocated Reconciliation metric rank priority for allocated licenses. Lower rank value takes precedence.
      Reconciliation order — unallocated Reconciliation metric rank priority for unallocated licenses. Lower rank value takes precedence.
      Calculation
      Calculation Script The calculation method for the license metric is script. Specify the reconciliation script.
    2. Select Submit.