In Software Asset Management classic, an entitlement records rights you have bought for a software product: how many, under which license type, and who or what they are allocated to. The steps below cover single entitlements, maintenance and Microsoft Software Assurance records, spreadsheet imports, and starting a reconciliation run.
Software asset management classic entitlements: where the record lives and who can create it
Go to All, then Software Asset, then Licensing, then Software Entitlements, and select New. Standard entitlements need the sam_user role. Maintenance entitlements need sam_admin. Microsoft Software Assurance records can be created by sam_user or sam_admin.
Creating a single entitlement, field by field
Start with the publisher part number. Once you enter it, the software model, metric group, agreement type and any existing lifecycle data fill in automatically. Complete the remaining fields from the software entitlement field reference.
Right-click the form header and choose Save while you are still configuring the record. Saving keeps you on the entitlement so you can add allocations and related lists. Select Update when the record is finished, because that submits it to the entitlement list.
Related lists hold further detail. Downgrade Rights records earlier versions the entitlement also covers, so a purchase of Microsoft Office Professional Plus 2016 also covers Professional Plus 2013. Expense Lines track the cost across the software lifecycle. License Keys record which keys are allocated, and Upgrade History shows the software model before and after an upgrade.
After saving, you can still change purchased rights, software model, license type, number of packs and publisher part number. An entitlement that has related entitlements, upgrade history, entitlement history or an upgraded entitlement attached is locked, and so are Microsoft reserve and source entitlements.
If SaaS License Management is installed, a software model is generated after you create an integration profile. Create an entitlement against that model so rights can be compared with usage.
Allocating rights to users and devices
Allocations sit in two sections on the record, User Allocations and Device Allocations. They show which person or machine holds each right.
The Device Allocations section does not appear for the IBM Resource Value Unit (RVU) license metric. That metric is licensed at product level, so rights are not tied to individual devices, and an empty device section on an RVU record is the expected view. When you upgrade to the Brazil release from a prior release that had device allocations, the existing device allocations are removed, so review migrated records that depended on devices.
Maintenance entitlements for publishers other than Microsoft
Maintenance entitlements hold contract start and end dates and upgrade rights. Microsoft has its own pattern, covered in the next section.
- Open a new Software Entitlement form, complete the mandatory fields, and set License type to Maintenance.
- If the software model has a Next Version populated and the metric group is Common, the entitlement moves to the next version of the model.
- Right-click the header and Save.
- Complete the Financial tab with the vendor and invoice number, and the Contracts tab with lease contracts and the warranty expiry date.
- In Related Entitlements, insert a row, search for the perpetual entitlement, set Active rights to the number you want to grant, and save.
- Select Update.
Linking can split a perpetual record, which surprises people the first time. Suppose a perpetual entitlement holds 50 active rights and you link 20 of them to a maintenance entitlement. The original keeps 20 active rights and 50 purchase rights, and stays associated with the maintenance entitlement. A new record takes the remaining 30 active rights with no association and no purchase rights.
Deleting one linked record does not delete the other. Removing the link means removing the entitlement from the Related Entitlements list. If the perpetual record has split and you delete the maintenance entitlement, the split perpetual record stays in place.
Microsoft Software Assurance entitlements
Microsoft Software Assurance (SA) follows the same pattern with three differences. Select Maintenance in License type, enter the granted rights in Active rights, and skip allocations, because SA entitlements do not take user or device allocations. Then link the perpetual entitlement as described above. Validation runs across the active rights of all related entitlements, and a failed calculation returns a message with resolution steps. The Microsoft rules guide explains the rules behind these numbers.
The Upgraded Entitlements related list appears when the license type is Step-up. Suppose you bought 50 rights of SQL Server 2016 with SA, and a newer datacenter release arrives during the maintenance period. You create an entitlement for the upgraded software and link the related entitlements to it. If the SA rights do not cover the perpetual rights after linking, an error appears and the rights need correcting before the record saves cleanly.
Importing a batch of entitlements from a spreadsheet
For a larger purchase history, use the import route.
- Go to All > Software Asset > Entitlement Import and select New.
- Download the .xlsx template from the Entitlement import page.
- Add one column for each extra field, including custom fields. The column name must match the field label exactly.
- Check the currency. Unit cost follows the system currency by default. For another currency, enter a valid currency code, a semicolon and the cost, such as EUR;200. The code must be active in the Currency table.
- Attach the file, select Import, and read the confirmation, which reports rows processed, successful and in error.
The Entitlement Import page has two tabs. Entitlements lists the records created. Relate entitlements lists records still in build state, such as maintenance entitlements waiting to be linked to their base entitlements.
For failed rows, select Review import errors. The list shows records with the status Needs review, and it may need a reload before that option appears. Correct the record and select Import again.
Running a software reconciliation
Reconciliation runs as a scheduled job, weekly by default, and you can also run it on demand. It covers products that have entitlements or installs. Run it from All > Software Asset > Reconciliation > Run Reconciliation, selecting the publishers to calculate or all of them. To narrow results, choose a Group and optionally a Subgroup from None, Country, Department, Company, Region and Cost Center. Select Continue. The classic run needs sam_admin, and a manual run can take a long time, so start with specific publishers when you are checking one product.
The classic path requires the legacy SAM module. If the classic menu is not visible, use the reconciliation task in SAM Workspace. The publisher reconciliation guide explains how to read the results.
Reading the software model results after a run
The Rights Owned vs Rights Used chart on the software model result forecasts when additional licenses are needed, so you can buy before consumption passes what you own.
| Figure | What it means |
|---|---|
| True-up cost | The estimated cost of covering unlicensed installations, based on the fewest rights needed multiplied by the average price per right from the entitlements |
| Over-licensed amount | The estimated cost of rights that are not in use |
| Potential savings | The cost saved if removal candidates are reclaimed |
Rights owned is the sum of active rights across entitlements sharing one license metric. Rights used is rights allocated plus rights not allocated but installed. Allocated in use means a right is assigned and licensing an install. Not allocated in use means an install consumes a right nobody has been assigned. Allocated not in use is the waste: rights assigned to a user or device that does not have the software installed. When Not allocated in use is above zero, two remediation options, Create Allocations and Remove Unallocated Installs, are generated for each unique license metric, except User CAL and Device CAL.
Because the true-up and over-licensed estimates use the average price per right from the entitlements, the unit costs you enter, by hand or by import, shape those figures directly. Removal candidates can be created from a reclamation rule or by hand, and each one’s potential savings equal its unused rights multiplied by the average price per right. The reclamation rules guide covers how candidates arise: software reclamation rules.
Frequently asked questions
Which role do I need for each task?
Standard entitlements need sam_user, maintenance entitlements need sam_admin, and Microsoft Software Assurance records can be created by sam_user or sam_admin. On the classic path, running a reconciliation needs sam_admin.
Why can I not edit an entitlement I created earlier?
The entitlement is locked when it has related entitlements, upgrade history, entitlement history or an upgraded entitlement attached. Microsoft reserve and source entitlements are locked as well. Review the links on the record before you change its purchase details.
Why is the Device Allocations section missing?
The section is hidden for the IBM Resource Value Unit (RVU) license metric, which is licensed at product level rather than per device. For other metrics the section is present.
What happens when I link some of a perpetual entitlement’s rights?
The perpetual entitlement splits into two records. One keeps the linked rights and the original purchase rights, and is associated with the maintenance or SA entitlement. The other holds the remaining active rights with no association. Check both records after the split.
Where do I run a reconciliation if the classic menu is missing?
Use the reconciliation task in SAM Workspace. The classic path requires the legacy SAM module, so the classic menu may not appear on some instances.