Complex Type: tns:entitlementLineItemDataType

Component	Type	Occurs	Description
		1..1
activationId	idType	1..1	Required. See idType.
description	string	0..1	Optional description field, used while creating or updating the entitlement line item.
product	productIdentifierType	0..1	Optional element supported for backwards compatibility. Replaced by entitledProducts element. A product must be uniquely identified by product identifier, part number, or a combination of part number and license model. Specifying a product element provides the default quantity of 1 for the single product on a line item. Only products and suites are supported. See productIdentifierType.
partNumber	partNumberIdentifierType	0..1	Optional. A part number can be used to identify a product or a unique combination of a product and license model. Only products and suites are currently supported, not maintenance. See partNumberIdentifierType.
licenseModel	licenseModelIdentifierType	0..1	Optional, but before the entitlement is deployed, a license model must be uniquely identified by a license model identifier, part number, or product. See licenseModelIdentifierType.
alternateLicenseModel1	licenseModelIdentifierType	0..1	Optional. Up to three license models are supported on a FlexNet license technology line item, one each of a certificate-based, trusted storage, and embedded on a single line item. See licenseModelIdentifierType.
alternateLicenseModel2	licenseModelIdentifierType	0..1	Optional. Up to three license models are supported on a FlexNet license technology line item, one each of a certificate-based, trusted storage, and embedded on a single line item. See licenseModelIdentifierType.
licenseModelAttributes	attributeDescriptorDataType	0..1	Any entitlement-time attributes must be set before deployment of the entitlement. If a request or response contains multiple license models, the accompanying license model attributes are a union of the attributes in all the license models. Therefore, if any license attributes are shared among the license models, they all must be assigned the same value. See attributeDescriptorDataType.
FNPTimeZoneValue	string	0..1	The time zone value is given as the contents of the name column of the time zone entry in the PROD_FNP_TIMEZONE table (not the time zone string that will be written into the license file).
policyAttributes	policyAttributesListType	0..1	Optional if used to override policy settings specified on the license model; required if any policies settings are deferred to entitlement time. However, if all policies to be set at entitlement time should be ignored, leave out this attribute. See policyAttributesListType.
orderId	string	0..1	Optional. Order ID from CRM or ERP system.
orderLineNumber	string	0..1	Optional. Order line number from CRM or ERP system.
numberOfCopies	integer	1..1	Required. Number of copies of the product entitled by this line item.
startDate	date	0..1	Start date of the entitlement. Do not set unless the startDateOption is set to DEFINE_NOW.
startDateOption	StartDateOptionType	0..1	At what point the start date is defined, where this is of the following values: DEFINE_NOW DEFINE_AT_FIRST_ACTIVATION DEFINE_AT_EACH_ACTIVATION DEFINE_ACTDATE_AT_FIRST_ACTIVATION DEFINE_ACTDATE_AT_EACH_ACTIVATION If neither startDate or startDateOption is specified, the default is DEFINE_AT_FIRST_ACTIVATION.
isPermanent	boolean	0..1	Whether the entitlement, and therefore, license activated from it, is permanent. If true, the entitlement line item, and the licenses activated from it, never expire. If true, do not set term or expirationDate. If false, set either term or expirationDate. If isPermanent is set to false, a query response will contain only expiring lineitem details. If isPermanent is set to true, a query response will contain only permanent lineitem details. If isPermanent is null (i.e. blank or not included in the query), a query response will contain both permanent and expiring lineitem details.
term	DurationType	0..1	The length of time after the start date that the entitlement, and the licenses activated from it, are valid. See DurationType. If isPermanent is true, do not set term or expirationDate. If isPermanent is false, set term or expirationDate, but not both.
expirationDate	date	0..1	The date that the entitlement line item, and the licenses activated from it, expire. If isPermanent is true, do not set term or expirationDate. If isPermanent is false, set term or expirationDate, but not both
isAutoRenewal	boolean	0..1	Controls whether a line item is automatically renewed. If set to True, the line item will be renewed according to the renewalInterval or renewalExpirationDate that is set. True: Set this field to True to enable auto-renewal of this line item. On the day of expiration, the line item’s expiration date is extended to the new end date (renewalExpirationDate) or duration (renewalInterval) set for the line item. False: Set this field to False to disable automatic renewal. (Default)
renewalInterval	DurationType	0..1	Set the duration after which the line item expires after it has been automatically renewed.
renewalExpirationDate	date	0..1	Expiration date of line item if its isAutoRenewal setting is set to True. Specify the date when the line item should expire after it has been automatically renewed.
versionDate	date	0..1	If any of the features in the product use date-based versions, and you want to set the version date when the line item is created, set versionDate and set versionDateAttributes to DEFINE_NOW. In a license, this date is converted into the Version Date Format that is specified in the system configuration.
versionDateAttributes	versionDateAttributesType	0..1	If any of the features in the product use date-based versions, set versionDateAttributes to reflect when and how you want to specify the version date. See Table versionDateAttributesType.
lineItemType	LineItemType	0..1	Optional. UPGRADE UPSELL RENEWAL If this element is set, then the entitlement line item will be of this type.
entitledProducts	entitledProductDataListType	0..1	See entitledProductDataListType.
lineItemAttributes	attributeDescriptorDataType	0..1	See attributeDescriptorDataType.
productLine	productCategoryDataType	0..1	See productCategoryDataType.
numberOfRemainingCopies	integer	0..1	Number of copies of the product entitled by this line item that have not yet been activated.
fulfilledCount	integer	0..1	Number of copies that were fulfilled from the line item.
availableExtraActivations	integer	0..1	Optional number of extra activations.
isTrustedType	boolean	0..1	Whether the product is licensed with a trusted license model.
state	StateType	0..1	One of the following: TEST DRAFT DEPLOYED INACTIVE ON_HOLD OBSOLETE
licenseTechnology	licenseTechnologyIdentifierType	0..1	License technology of the product. See licenseTechnologyIdentifierType.
parentLineItem	entitlementLineItemIdentifierType	0..1	Optional. The entitlement line item that contains the activatable product to which the maintenance is related. See entitlementLineItemIdentifierType.
createdOnDateTime	dateTime	0..1	The date and time when the line item was created.
lastModifiedDateTime	dateTime	0..1	The date and time when the line item was last modified.
overdraftMax	integer	0..1	Maximum number of overdrafts.
remainingOverdraftCount	integer	0..1	Number of overdrafts available.

activationId

idType

1..1

Required. See idType.

description

string

0..1

Optional description field, used while creating or updating the entitlement line item.

product

productIdentifierType

0..1

Optional element supported for backwards compatibility. Replaced by entitledProducts element.

A product must be uniquely identified by product identifier, part number, or a combination of part number and license model. Specifying a product element provides the default quantity of 1 for the single product on a line item.
Only products and suites are supported.

See productIdentifierType.

partNumber

partNumberIdentifierType

0..1

Optional. A part number can be used to identify a product or a unique combination of a product and license model. Only products and suites are currently supported, not maintenance. See partNumberIdentifierType.

licenseModel

licenseModelIdentifierType

0..1

Optional, but before the entitlement is deployed, a license model must be uniquely identified by a license model identifier, part number, or product. See licenseModelIdentifierType.

alternateLicenseModel1

licenseModelIdentifierType

0..1

Optional. Up to three license models are supported on a FlexNet license technology line item, one each of a certificate-based, trusted storage, and embedded on a single line item. See licenseModelIdentifierType.

alternateLicenseModel2

licenseModelIdentifierType

0..1

Optional. Up to three license models are supported on a FlexNet license technology line item, one each of a certificate-based, trusted storage, and embedded on a single line item. See licenseModelIdentifierType.

licenseModelAttributes

attributeDescriptorDataType

0..1

Any entitlement-time attributes must be set before deployment of the entitlement.

If a request or response contains multiple license models, the accompanying license model attributes are a union of the attributes in all the license models. Therefore, if any license attributes are shared among the license models, they all must be assigned the same value.

See attributeDescriptorDataType.

FNPTimeZoneValue

string

0..1

The time zone value is given as the contents of the name column of the time zone entry in the PROD_FNP_TIMEZONE table (not the time zone string that will be written into the license file).

policyAttributes

policyAttributesListType

0..1

Optional if used to override policy settings specified on the license model; required if any policies settings are deferred to entitlement time. However, if all policies to be set at entitlement time should be ignored, leave out this attribute. See policyAttributesListType.

orderId

string

0..1

Optional. Order ID from CRM or ERP system.

orderLineNumber

string

0..1

Optional. Order line number from CRM or ERP system.

numberOfCopies

integer

1..1

Required. Number of copies of the product entitled by this line item.

startDate

date

0..1

Start date of the entitlement. Do not set unless the startDateOption is set to DEFINE_NOW.

startDateOption

StartDateOptionType

0..1

At what point the start date is defined, where this is of the following values:

DEFINE_NOW
DEFINE_AT_FIRST_ACTIVATION
DEFINE_AT_EACH_ACTIVATION
DEFINE_ACTDATE_AT_FIRST_ACTIVATION
DEFINE_ACTDATE_AT_EACH_ACTIVATION

If neither startDate or startDateOption is specified, the default is DEFINE_AT_FIRST_ACTIVATION.

isPermanent

boolean

0..1

Whether the entitlement, and therefore, license activated from it, is permanent. If true, the entitlement line item, and the licenses activated from it, never expire. If true, do not set term or expirationDate. If false, set either term or expirationDate.

If isPermanent is set to false, a query response will contain only expiring lineitem details.
If isPermanent is set to true, a query response will contain only permanent lineitem details.
If isPermanent is null (i.e. blank or not included in the query), a query response will contain both permanent and expiring lineitem details.

term

DurationType

0..1

The length of time after the start date that the entitlement, and the licenses activated from it, are valid. See DurationType. If isPermanent is true, do not set term or expirationDate. If isPermanent is false, set term or expirationDate, but not both.

expirationDate

date

0..1

The date that the entitlement line item, and the licenses activated from it, expire. If isPermanent is true, do not set term or expirationDate. If isPermanent is false, set term or expirationDate, but not both

isAutoRenewal

boolean

0..1

Controls whether a line item is automatically renewed. If set to True, the line item will be renewed according to the renewalInterval or renewalExpirationDate that is set.

True: Set this field to True to enable auto-renewal of this line item. On the day of expiration, the line item’s expiration date is extended to the new end date (renewalExpirationDate) or duration (renewalInterval) set for the line item.
False: Set this field to False to disable automatic renewal. (Default)

renewalInterval

DurationType

0..1

Set the duration after which the line item expires after it has been automatically renewed.

renewalExpirationDate

date

0..1

Expiration date of line item if its isAutoRenewal setting is set to True. Specify the date when the line item should expire after it has been automatically renewed.

versionDate

date

0..1

If any of the features in the product use date-based versions, and you want to set the version date when the line item is created, set versionDate and set versionDateAttributes to DEFINE_NOW. In a license, this date is converted into the Version Date Format that is specified in the system configuration.

versionDateAttributes

versionDateAttributesType

0..1

If any of the features in the product use date-based versions, set versionDateAttributes to reflect when and how you want to specify the version date. See Table versionDateAttributesType.

lineItemType

LineItemType

0..1

Optional.