Sample XML for Entitlement Web Services
On this page:
>Partial Example Showing Concurrency Support for SAOT
* SAOT is an abbreviation of "Set At Entitlement Time" or "Define in Entitlement". For details, see SAOT.
Simple Example
<entitlement>
<enabled>true</enabled>
<action>PRODUCE</action>
<partnerId />
<partnerEmail />
<refId1 />
<refId2 />
<description />
<startDate>2011-09-12</startDate>
<endDate>2500-12-31</endDate>
<customerId>1</customerId>
<policy>
<registrationRequired>DESIRED</registrationRequired>
</policy>
<entitlementItem>
<lineItemType>Product_Key</lineItemType>
<numActivationPerProductKey>1</numActivationPerProductKey>
<numProductKeys>1</numProductKeys>
<vendorId>1</vendorId>
<enforcementId>1</enforcementId>
<identity>1</identity>
<identityCount>1</identityCount >
<itemProduct>
<productId>1</productId>
</itemProduct>
<activationAttribute>
<attributeName>ACKNOWLEDGEMENT_REQUEST</attributeName>
<attributeValue>false</attributeValue>
</activationAttribute>
<memorySegments>
</memorySegments>
</entitlementItem>
</entitlement>
Partial Example Showing Concurrency Support for SAOT
To enable concurrency for products that include a saotAllowed attribute value of TRUE for CONCURRENT_INSTANCES, you must set the ENABLE_CONCURRENCY attributeValue as TRUE.
...
...
<lmAttribute>
<attribute>
<attributeId>5</attributeId>
<attributeName>ENABLE_CONCURRENCY</attributeName>
<attributeType>4</attributeType>
<attributeDefaultValue></attributeDefaultValue>
<displayOrder>5</displayOrder>
<attributeLevel>1</attributeLevel>
<associatedLockCriteria></associatedLockCriteria>
<associatedLockCriteriaValue></associatedLockCriteriaValue>
<endUserPermission>0</endUserPermission>
<parameterGroupName>Concurrency</parameterGroupName>
<parameterSubGroupName></parameterSubGroupName>
<isvPermission>WRITE</isvPermission>
<nullable>false</nullable>
<saotAllowed>false</saotAllowed>
</attribute>
<attributeValue>true</attributeValue>
<saot>false</saot>
<actionName>NONE</actionName>
</lmAttribute>
<lmAttribute>
<attribute>
<attributeId>6</attributeId>
<attributeName>CONCURRENT_INSTANCES</attributeName>
<attributeType>6</attributeType>
<attributeDefaultValue></attributeDefaultValue>
<displayOrder>6</displayOrder>
<attributeLevel>1</attributeLevel>
<associatedLockCriteria></associatedLockCriteria>
<associatedLockCriteriaValue></associatedLockCriteriaValue>
<endUserPermission>0</endUserPermission>
<parameterGroupName>Concurrency</parameterGroupName>
<parameterSubGroupName></parameterSubGroupName>
<isvPermission>WRITE</isvPermission>
<nullable>false</nullable>
<saotAllowed>true</saotAllowed>
</attribute>
<attributeValue>20</attributeValue>
<saot>true</saot>
<actionName>NONE</actionName>
</lmAttribute>
...
...
Expanded Example with SAOT
The following entitlement example includes one Product with two Features. One feature uses the Expiration Date license model with concurrency support that is defined to use SAOT values. The other feature uses the Execution Count license model and uses SAOT to allow the number of executions to be changed when the entitlement is created.
<entitlement>
<startDate>2021-12-17</startDate>
<endDate>2500-12-31</endDate>
<createDate>2021-12-17</createDate>
<commitDate>2021-12-17</commitDate>
<enabled>true</enabled>
<entState>PRODUCT_KEY_GENERATED</entState>
<isTest>false</isTest>
<policy>
<registrationRequired>DESIRED</registrationRequired>
</policy>
<refId1></refId1>
<refId2></refId2>
<description></description>
<entitlementItem>
<startDate>2021-12-17</startDate>
<endDate>2500-12-31</endDate>
<numProductKeys>1</numProductKeys>
<numActivationPerProductKey>1</numActivationPerProductKey>
<priority>D</priority>
<vendorId>1</vendorId>
<enforcementId>1</enforcementId>
<lineItemType>Product_Key</lineItemType>
<itemProduct>
<productId>48</productId>
<product>
<productName>Product_Sample</productName>
<baseProductId>0</baseProductId>
<productIdentifier>38</productIdentifier>
<useVclock>false</useVclock>
<lifeCycleStage>COMMIT</lifeCycleStage>
<enforcementProductType>BASE</enforcementProductType>
<enforcementProtectionType>HL_or_SL_AdminMode_or_SL_UserMode</enforcementProtectionType>
<rehost>ENABLE</rehost>
<upgradeToDriverless>false</upgradeToDriverless>
<cloneProtection>true</cloneProtection>
<physicalMachineType>PlatformDefault</physicalMachineType>
<virtualMachineType>PlatformDefault</virtualMachineType>
<productDescription></productDescription>
<refId1></refId1>
<refId2></refId2>
<enabled>true</enabled>
<deployed>true</deployed>
<productFeatureRef>
<featureId>3</featureId>
<actionName>NONE</actionName>
<productFeatureLicenseModel>
<actionName>NONE</actionName>
<licenseModel>
<licenseModelId>2</licenseModelId>
<licenseModelName>Expiration Date</licenseModelName>
<licenseType>0</licenseType>
<lmAttribute>
<attribute>
<attributeId>3</attributeId><attributeName>EXPIRATION_DATE</attributeName>
<attributeType>2</attributeType>
<attributeDefaultValue></attributeDefaultValue>
<displayOrder>3</displayOrder>
<attributeLevel>1</attributeLevel>
<associatedLockCriteria></associatedLockCriteria>
<associatedLockCriteriaValue></associatedLockCriteriaValue>
<endUserPermission>0</endUserPermission>
<parameterGroupName>License Terms</parameterGroupName>
<parameterSubGroupName></parameterSubGroupName>
<isvPermission>WRITE</isvPermission>
<nullable>false</nullable>
<saotAllowed>true</saotAllowed>
</attribute>
<attributeValue>2025-12-31</attributeValue>
<saot>true</saot>
<actionName>NONE</actionName>
</lmAttribute>
<lmAttribute>
<attribute>
<attributeId>11</attributeId>
<attributeName>VIRTUAL_MACHINE_ACCESS</attributeName>
<attributeType>4</attributeType>
<attributeDefaultValue></attributeDefaultValue>
<displayOrder>11</displayOrder>
<attributeLevel>1</attributeLevel>
<associatedLockCriteria></associatedLockCriteria>
<associatedLockCriteriaValue></associatedLockCriteriaValue>
<endUserPermission>0</endUserPermission>
<parameterGroupName>Accessibility</parameterGroupName>
<parameterSubGroupName></parameterSubGroupName>
<isvPermission>WRITE</isvPermission>
<nullable>false</nullable>
<saotAllowed>false</saotAllowed>
</attribute>
<attributeValue>TRUE</attributeValue>
<saot>false</saot>
<actionName>NONE</actionName>
</lmAttribute>
<lmAttribute>
<attribute>
<attributeId>10</attributeId>
<attributeName>DETACHABLE</attributeName>
<attributeType>4</attributeType>
<attributeDefaultValue></attributeDefaultValue>
<displayOrder>10</displayOrder>
<attributeLevel>1</attributeLevel>
<associatedLockCriteria></associatedLockCriteria>
<associatedLockCriteriaValue></associatedLockCriteriaValue>
<endUserPermission>0</endUserPermission>
<parameterGroupName>Concurrency</parameterGroupName>
<parameterSubGroupName></parameterSubGroupName>
<isvPermission>WRITE</isvPermission>
<nullable>false</nullable>
<saotAllowed>false</saotAllowed>
</attribute>
<attributeValue>false</attributeValue>
<saot>false</saot>
<actionName>NONE</actionName>
</lmAttribute>
<lmAttribute>
<attribute>
<attributeId>5</attributeId>
<attributeName>ENABLE_CONCURRENCY</attributeName>
<attributeType>4</attributeType>
<attributeDefaultValue></attributeDefaultValue>
<displayOrder>5</displayOrder>
<attributeLevel>1</attributeLevel>
<associatedLockCriteria></associatedLockCriteria>
<associatedLockCriteriaValue></associatedLockCriteriaValue>
<endUserPermission>0</endUserPermission>
<parameterGroupName>Concurrency</parameterGroupName>
<parameterSubGroupName></parameterSubGroupName>
<isvPermission>WRITE</isvPermission>
<nullable>false</nullable>
<saotAllowed>false</saotAllowed>
</attribute>
<attributeValue>true</attributeValue>
<saot>false</saot>
<actionName>NONE</actionName>
</lmAttribute>
<lmAttribute>
<attribute>
<attributeId>6</attributeId>
<attributeName>CONCURRENT_INSTANCES</attributeName>
<attributeType>6</attributeType>
<attributeDefaultValue></attributeDefaultValue>
<displayOrder>6</displayOrder>
<attributeLevel>1</attributeLevel>
<associatedLockCriteria></associatedLockCriteria>
<associatedLockCriteriaValue></associatedLockCriteriaValue>
<endUserPermission>0</endUserPermission>
<parameterGroupName>Concurrency</parameterGroupName>
<parameterSubGroupName></parameterSubGroupName>
<isvPermission>WRITE</isvPermission>
<nullable>false</nullable>
<saotAllowed>true</saotAllowed>
</attribute>
<attributeValue>20</attributeValue>
<saot>true</saot>
<actionName>NONE</actionName>
</lmAttribute>
<lmAttribute>
<attribute>
<attributeId>7</attributeId>
<attributeName>COUNT_CRITERIA</attributeName>
<attributeType>7</attributeType>
<attributeValueChoice>
<valueOption>Station</valueOption>
<valueOption>Login</valueOption>
<valueOption>Process</valueOption>
</attributeValueChoice>
<attributeDefaultValue></attributeDefaultValue>
<displayOrder>7</displayOrder>
<attributeLevel>1</attributeLevel>
<associatedLockCriteria></associatedLockCriteria>
<associatedLockCriteriaValue></associatedLockCriteriaValue>
<endUserPermission>0</endUserPermission>
<parameterGroupName>Concurrency</parameterGroupName>
<parameterSubGroupName></parameterSubGroupName>
<isvPermission>WRITE</isvPermission>
<nullable>false</nullable>
<saotAllowed>false</saotAllowed>
</attribute>
<attributeValue>0</attributeValue>
<saot>false</saot>
<actionName>NONE</actionName>
</lmAttribute>
<lmAttribute>
<attribute>
<attributeId>9</attributeId>
<attributeName>NETWORK_ENABLED</attributeName>
<attributeType>4</attributeType>
<attributeDefaultValue></attributeDefaultValue>
<displayOrder>9</displayOrder>
<attributeLevel>1</attributeLevel>
<associatedLockCriteria></associatedLockCriteria>
<associatedLockCriteriaValue></associatedLockCriteriaValue>
<endUserPermission>0</endUserPermission>
<parameterGroupName>Accessibility</parameterGroupName>
<parameterSubGroupName></parameterSubGroupName>
<isvPermission>WRITE</isvPermission>
<nullable>false</nullable>
<saotAllowed>false</saotAllowed>
</attribute>
<attributeValue>true</attributeValue>
<saot>false</saot>
<actionName>NONE</actionName>
</lmAttribute>
<lmAttribute>
<attribute>
<attributeId>1</attributeId>
<attributeName>LICENSE_TYPE</attributeName>
<attributeType>7</attributeType>
<attributeValueChoice>
<valueOption>Perpetual</valueOption>
<valueOption>Executions</valueOption>
<valueOption>Expiration Date</valueOption>
<valueOption>Time Period</valueOption>
</attributeValueChoice>
<attributeDefaultValue></attributeDefaultValue>
<displayOrder>1</displayOrder>
<attributeLevel>1</attributeLevel>
<associatedLockCriteria></associatedLockCriteria>
<associatedLockCriteriaValue></associatedLockCriteriaValue>
<endUserPermission>0</endUserPermission>
<parameterGroupName>License Terms</parameterGroupName>
<parameterSubGroupName></parameterSubGroupName>
<isvPermission>WRITE</isvPermission>
<nullable>false</nullable>
<saotAllowed>true</saotAllowed>
</attribute>
<attributeValue>2</attributeValue>
<saot>false</saot>
<actionName>NONE</actionName>
</lmAttribute>
<lmAttribute>
<attribute>
<attributeId>8</attributeId>
<attributeName>REMOTE_DESKTOP_ACCESS</attributeName>
<attributeType>4</attributeType>
<attributeDefaultValue></attributeDefaultValue>
<displayOrder>8</displayOrder>
<attributeLevel>1</attributeLevel>
<associatedLockCriteria></associatedLockCriteria>
<associatedLockCriteriaValue></associatedLockCriteriaValue>
<endUserPermission>0</endUserPermission>
<parameterGroupName>Accessibility</parameterGroupName>
<parameterSubGroupName></parameterSubGroupName>
<isvPermission>WRITE</isvPermission>
<nullable>false</nullable>
<saotAllowed>false</saotAllowed>
</attribute>
<attributeValue>true</attributeValue>
<saot>false</saot>
<actionName>NONE</actionName>
</lmAttribute>
</licenseModel>
</productFeatureLicenseModel>
<lmStatus>DEFINED</lmStatus>
<excludable>true</excludable>
<featureName>Reports</featureName>
<featureIdentifier>42</featureIdentifier>
<featureDescription>Enables creation of system usage reports</featureDescription>
</productFeatureRef>
<productFeatureRef>
<featureId>2</featureId>
<actionName>NONE</actionName>
<productFeatureLicenseModel>
<actionName>NONE</actionName>
<licenseModel>
<licenseModelId>1</licenseModelId>
<licenseModelName>Execution Count</licenseModelName>
<licenseType>0</licenseType>
<lmAttribute>
<attribute>
<attributeId>11</attributeId>
<attributeName>VIRTUAL_MACHINE_ACCESS</attributeName>
<attributeType>4</attributeType>
<attributeDefaultValue></attributeDefaultValue>
<displayOrder>11</displayOrder>
<attributeLevel>1</attributeLevel>
<associatedLockCriteria></associatedLockCriteria>
<associatedLockCriteriaValue></associatedLockCriteriaValue>
<endUserPermission>0</endUserPermission>
<parameterGroupName>Accessibility</parameterGroupName>
<parameterSubGroupName></parameterSubGroupName>
<isvPermission>WRITE</isvPermission>
<nullable>false</nullable>
<saotAllowed>false</saotAllowed>
</attribute>
<attributeValue>TRUE</attributeValue>
<saot>false</saot>
<actionName>NONE</actionName>
</lmAttribute>
<lmAttribute>
<attribute>
<attributeId>7</attributeId>
<attributeName>COUNT_CRITERIA</attributeName>
<attributeType>7</attributeType>
<attributeValueChoice>
<valueOption>Station</valueOption>
<valueOption>Login</valueOption>
<valueOption>Process</valueOption>
</attributeValueChoice>
<attributeDefaultValue></attributeDefaultValue>
<displayOrder>7</displayOrder>
<attributeLevel>1</attributeLevel>
<associatedLockCriteria></associatedLockCriteria>
<associatedLockCriteriaValue></associatedLockCriteriaValue>
<endUserPermission>0</endUserPermission>
<parameterGroupName>Concurrency</parameterGroupName>
<parameterSubGroupName></parameterSubGroupName>
<isvPermission>WRITE</isvPermission>
<nullable>false</nullable>
<saotAllowed>false</saotAllowed>
</attribute>
<attributeValue>0</attributeValue>
<saot>false</saot>
<actionName>NONE</actionName>
</lmAttribute>
<lmAttribute>
<attribute>
<attributeId>2</attributeId>
<attributeName>EXECUTION_COUNT</attributeName>
<attributeType>3</attributeType>
<attributeDefaultValue></attributeDefaultValue>
<displayOrder>2</displayOrder>
<attributeLevel>1</attributeLevel>
<associatedLockCriteria></associatedLockCriteria>
<associatedLockCriteriaValue></associatedLockCriteriaValue>
<endUserPermission>0</endUserPermission>
<parameterGroupName>License Terms</parameterGroupName>
<parameterSubGroupName></parameterSubGroupName>
<isvPermission>WRITE</isvPermission>
<nullable>false</nullable>
<saotAllowed>true</saotAllowed>
</attribute>
<attributeValue>10</attributeValue>
<saot>true</saot>
<actionName>NONE</actionName>
</lmAttribute>
<lmAttribute>
<attribute>
<attributeId>9</attributeId>
<attributeName>NETWORK_ENABLED</attributeName>
<attributeType>4</attributeType>
<attributeDefaultValue></attributeDefaultValue>
<displayOrder>9</displayOrder>
<attributeLevel>1</attributeLevel>
<associatedLockCriteria></associatedLockCriteria>
<associatedLockCriteriaValue></associatedLockCriteriaValue>
<endUserPermission>0</endUserPermission>
<parameterGroupName>Accessibility</parameterGroupName>
<parameterSubGroupName></parameterSubGroupName>
<isvPermission>WRITE</isvPermission>
<nullable>false</nullable>
<saotAllowed>false</saotAllowed>
</attribute>
<attributeValue>FALSE</attributeValue>
<saot>false</saot>
<actionName>NONE</actionName>
</lmAttribute>
<lmAttribute>
<attribute>
<attributeId>6</attributeId>
<attributeName>CONCURRENT_INSTANCES</attributeName>
<attributeType>6</attributeType>
<attributeDefaultValue></attributeDefaultValue>
<displayOrder>6</displayOrder>
<attributeLevel>1</attributeLevel>
<associatedLockCriteria></associatedLockCriteria>
<associatedLockCriteriaValue></associatedLockCriteriaValue>
<endUserPermission>0</endUserPermission>
<parameterGroupName>Concurrency</parameterGroupName>
<parameterSubGroupName></parameterSubGroupName>
<isvPermission>WRITE</isvPermission>
<nullable>false</nullable>
<saotAllowed>true</saotAllowed>
</attribute>
<attributeValue>10000000</attributeValue>
<saot>false</saot>
<actionName>NONE</actionName>
</lmAttribute>
<lmAttribute>
<attribute>
<attributeId>8</attributeId>
<attributeName>REMOTE_DESKTOP_ACCESS</attributeName>
<attributeType>4</attributeType>
<attributeDefaultValue></attributeDefaultValue>
<displayOrder>8</displayOrder>
<attributeLevel>1</attributeLevel>
<associatedLockCriteria></associatedLockCriteria>
<associatedLockCriteriaValue></associatedLockCriteriaValue>
<endUserPermission>0</endUserPermission>
<parameterGroupName>Accessibility</parameterGroupName>
<parameterSubGroupName></parameterSubGroupName>
<isvPermission>WRITE</isvPermission>
<nullable>false</nullable>
<saotAllowed>false</saotAllowed>
</attribute>
<attributeValue>TRUE</attributeValue>
<saot>false</saot>
<actionName>NONE</actionName>
</lmAttribute>
<lmAttribute>
<attribute>
<attributeId>11</attributeId>
<attributeName>VIRTUAL_MACHINE_ACCESS</attributeName>
<attributeType>4</attributeType>
<attributeDefaultValue></attributeDefaultValue>
<displayOrder>11</displayOrder>
<attributeLevel>1</attributeLevel>
<associatedLockCriteria></associatedLockCriteria>
<associatedLockCriteriaValue></associatedLockCriteriaValue>
<endUserPermission>0</endUserPermission>
<parameterGroupName>Accessibility</parameterGroupName>
<parameterSubGroupName></parameterSubGroupName>
<isvPermission>WRITE</isvPermission>
<nullable>false</nullable>
<saotAllowed>false</saotAllowed>
</attribute>
<attributeValue>TRUE</attributeValue>
<saot>false</saot>
<actionName>NONE</actionName>
</lmAttribute>
<lmAttribute>
<attribute>
<attributeId>1</attributeId>
<attributeName>LICENSE_TYPE</attributeName>
<attributeType>7</attributeType>
<attributeValueChoice>
<valueOption>Perpetual</valueOption>
<valueOption>Executions</valueOption>
<valueOption>Expiration Date</valueOption>
<valueOption>Time Period</valueOption>
</attributeValueChoice>
<attributeDefaultValue></attributeDefaultValue>
<displayOrder>1</displayOrder>
<attributeLevel>1</attributeLevel>
<associatedLockCriteria></associatedLockCriteria>
<associatedLockCriteriaValue></associatedLockCriteriaValue>
<endUserPermission>0</endUserPermission>
<parameterGroupName>License Terms</parameterGroupName>
<parameterSubGroupName></parameterSubGroupName>
<isvPermission>WRITE</isvPermission>
<nullable>false</nullable>
<saotAllowed>true</saotAllowed>
</attribute>
<attributeValue>1</attributeValue>
<saot>false</saot>
<actionName>NONE</actionName>
</lmAttribute>
<lmAttribute>
<attribute>
<attributeId>5</attributeId>
<attributeName>ENABLE_CONCURRENCY</attributeName>
<attributeType>4</attributeType>
<attributeDefaultValue></attributeDefaultValue>
<displayOrder>5</displayOrder>
<attributeLevel>1</attributeLevel>
<associatedLockCriteria></associatedLockCriteria>
<associatedLockCriteriaValue></associatedLockCriteriaValue>
<endUserPermission>0</endUserPermission>
<parameterGroupName>Concurrency</parameterGroupName>
<parameterSubGroupName></parameterSubGroupName>
<isvPermission>WRITE</isvPermission>
<nullable>false</nullable>
<saotAllowed>false</saotAllowed>
</attribute>
<attributeValue>FALSE</attributeValue>
<saot>false</saot>
<actionName>NONE</actionName>
</lmAttribute>
</licenseModel>
</productFeatureLicenseModel>
<lmStatus>SAOT</lmStatus>
<excludable>true</excludable>
<featureName>Save format</featureName>
<featureIdentifier>3</featureIdentifier>
<featureDescription>Enables saving in formats other than the default</featureDescription>
</productFeatureRef>
</product>
</itemProduct>
<activationAttribute>
<attributeName>ACKNOWLEDGEMENT_REQUEST</attributeName>
<attributeValue>false</attributeValue>
<groupName>LICENSE TERMS</groupName>
</activationAttribute>
</entitlementItem>
</entitlement>