{"id":"sforce_api_objects_packagelicense","title":"PackageLicense","content":"

PackageLicense

\n
\nRepresents a license for an installed managed\n package.\n This object is available in API version 31.0 and later.
\n\n
\n

Supported Calls

\n\n \n

describeSObjects(), query(), retrieve()

\n\n
\n\n
\n

Special Access Rules

\n\n \n

Customer Portal users can't access this object.

\n\n
\n\n
\n

Fields

\n\n \n \n
\n \n \n \n \n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n
Field NameDetails
AllowedLicenses\n
\n \n
Type
\n\n
int
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
The number of users allowed to use the package.
\n\n \n
\n\n
ExpirationDate\n
\n \n
Type
\n\n
dateTime
\n\n \n \n
Properties
\n\n
Filter, Nillable, Sort
\n\n \n \n
Description
\n\n
The date and time when the package license expires.
\n\n \n
\n\n
IsAvailableForIntegrations\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
Reserved for future use.
\n\n \n
\n\n
IsProvisioned\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
Reserved for internal use.
\n\n \n
\n\n
NamespacePrefix\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
The namespace prefix associated with the package.
\n\n \n
\n\n
Status\n
\n \n
Type
\n\n
picklist
\n\n \n \n
Properties
\n\n
Filter, Group, Restricted picklist, Sort
\n\n \n \n
Description
\n\n
The status of the license. Possible values are: Active,\n Expired, Free, and\n Trial.
\n\n \n
\n\n
UsedLicenses\n
\n \n
Type
\n\n
int
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
The number of users who have a license to the package.
\n\n \n
\n\n
\n\n
\n\n
\n

Usage

\n\n \n

Use this object to determine the number of licenses allowed and in use for a\n managed package installed in your organization.

\n\n
\nThe following example demonstrates the use of the API to manage licenses for\n a package. The example defines an Apex class that does the following.
    \n
  • Retrieves the PackageLicense record for the specified package (identified by its\n namespace prefix).
    • \n\n
  • Defines a function that returns a list of all users with the specified profile.
    • \n\n
  • Creates a UserPackageLicense record for each user with that profile, which has the\n effect of assigning a license for the package to all users with that profile.
    • \n\n
  • Returns an error message if the number of users exceeds the number of available\n licenses.
    • \n\n
\n
\n\n 
public class AssignPackageLicense {\n     \n    static String PACKAGE_NAMESPACE_PREFIX = 'acme_101';\n    static String PROFILE_ID = '00exx000000jz1SAAQ';\n    public static String exceptionText {get; set;}\n        \n    public AssignPackageLicense() {\n         exceptionText = 'Initialized';\n    }\n\n \t\tstatic List<User> getUsersWithProfile(){\n      String userQuery = 'SELECT Id FROM User WHERE ProfileId = :PROFILE_ID';\n      List<User> matchingUsers = new List<User>();\n      matchingUsers = [SELECT Id FROM User WHERE ProfileId = :PROFILE_ID];\n      return matchingUsers;\n    }\n\n    public static void assignLicenseByProfile() {\n        //find the PackageLicense Id\n        PackageLicense pl = [SELECT Id, NamespacePrefix, AllowedLicenses, UsedLicenses, \n        \t\t\t\t\t ExpirationDate,Status FROM PackageLicense WHERE \n        \t\t\t\t\t NamespacePrefix = :PACKAGE_NAMESPACE_PREFIX];\n        System.assert(pl != null, 'PackageLicense cannot be null.');\n        List<User> usersToAssignLicenses = getUsersWithProfile();\n        List<UserPackageLicense> firstUPLs = new List<UserPackageLicense>();\n        \n        //create a new UserPackageLicense record for each user with the specified profile\n        for (Integer i = 0; i< usersToAssignLicenses.size(); i++){\n              UserPackageLicense upl = new UserPackageLicense();\n              upl.PackageLicenseId = pl.Id;\n              upl.UserId = usersToAssignLicenses[i].Id;\n              firstUPLs.add(upl);\n        }\n        \n        try {\n          //bulk insert\n          insert(firstUPLs);\n          } catch(DmlException e) {\n             for (Integer i = 0; i < e.getNumDml(); i++) {\n             // process exception here \n               System.debug(e.getDmlMessage(i)); \n               String status = e.getDmlStatusCode(i);\n               System.debug(status + ' ' + e.getDmlMessage(i));\n               if(status.equals('LICENSE_LIMIT_EXCEEDED')){\n                exceptionText = 'You tried to assign more licenses than available. ' \n                +' You tried to create '+ firstUPLs.size()+' licenses but only have '\n                + (pl.AllowedLicenses - pl.UsedLicenses) + ' licenses free.';\n                System.debug(exceptionText);\n               }\n             }\n         }\n    }    \n }\n
\n\n
\n\n
"}