Data Access API and Data Share Entity Relationship Details

This topic details the data that is returned by the FlexNet Operations Data Access API and shared via Snowflake Data Warehouse. A diagram is provided that indicates the relationships between the various entities that are returned by this API. Following the diagram, each of the report fields that are returned by the this API are defined.

Data Access API Entity Relationship Diagram

The following is a diagram that indicates the relationships between the various entities that are returned by the FlexNet Operations Data Access API. This information is used both in data warehouse data sharing and in data access API.

Note: Click on a column in the diagram to jump to descriptions of the fields in that set of data.

FlexNet Operations Data Access API Entity Relationship Diagram account device served-device entitlement fulfillment product-feature user usage downloads files

Note: Fields in the usage column with an * are applicable for concurrent and metered licensing, but are not applicable for elastic licensing.

Data Access API Field Descriptions

The following describes the report fields that are returned by the FlexNet Operations Data Access API, and details the relationships between them. This information is used when extracting data from the data warehouse data and when generating reports using the Data Access API.

account | device | served-device | entitlement | fulfillment | product-feature | user | downloads | files | usage

account

The following fields are in the account report:

Field in Database Field in DAPI Description Equivalent To
ID AccountID A unique identifier of an organization’s account as defined in FlexNet Operations. (For example, Stark International Enterprises.)

Equivalent to:

  • device: DeviceAccountID
  • entitlement: CustomersAndPartners.EndCustomerAccountID
  • fulfillment: AccountID
  • user: AccountID
  • usage: accountId
 NAME AccountName A display name for an organization’s account as defined in FlexNet Operations. (For example, Stark.) The Account Name is what FlexNet Operations displays on most of the Producer Portal and End-User Portal pages.

Equivalent to:

  • device: DeviceAccountName
  • entitlement: CustomersAndPartners.EndCustomerAccountName
  • fulfillment: AccountName
  • user: AccountName
 DESCRIPTION AccountDescription The description associated with the account.  
 ACCOUNT_TYPE AccountType

Identifies an account as one of the following types:

  • CUSTOMER—Regular customer accounts.
  • SELF_REGISTERED—Self-registered accounts.
  • CHANNEL_PARTNER—Channel partner accounts.
  • PUBLISHER—Producer accounts.

Accounts without a standard account type are shown as UNKNOWN.

 
 ADDR_ADDR1 Address1 The first line of the optional street address of the account.  
 ADDR_ADDR2 Address2 The second line of the optional street address of the account.  
 CITY City The city for the address associated with the account.  
 COUNTRY Country The country code for the account.  
 ADDR_ZIPCODE PostalCode The postal code for account.  
 PARENT_ORG_IDS ParentAccountIDs The account ID of the parent account, if any.  
 LASTUPDATED LastUpdated Last time a change was made to the account.  
 CREATEDATE CreateDate The date the account was first created.  
 ADDR_STATE State

The state of the account as one of the following:

  • ACTIVE
  • INACTIVE
 
 VISIBLE Visible

Indicates whether partners in different distribution tiers are permitted to see information about this account.

 
 REGION Region The region where the account is situated. For instance, EMEA or APAC. Region is an optional field in the account-creation process and can contain any region designation the user enters.  
 DWH_LASTUPDATED_DATE DWH_LASTUPDATED_DATE The last date that the record was refreshed in the data warehouse.  
 ACCOUNT_DELETED AccountDeleted List of accounts that were deleted.

Also referred to in:

  • device: AccountDeleted
  • served-device: AccountDeleted
  • fulfillment: AccountDeleted

device & device history

A device is either a license server or a standalone device. The following fields are in the device entity.

field in database Field in dapi Description Equivalent To
ID DeviceID

A 19-digit unique identifier of the device record as defined in FlexNet Operations. The ID is the primary key for the Device dimension.

Equivalent to:

  • served-device: ServerHostID
MACHINE_TYPE DeviceMachineType

A 64-character machine type. The possible machine type values are:

  • PHYSICAL
  • VIRTUAL
  • UNKNOWN

This field may be empty.

 
DEVICE_ALIAS Alias/Device Name A short, alternative name for the device.  
SITE_NAME SiteName Site name used for additional information purposes only.  
STATUS Status

The status of the device:

  • ACTIVE
  • OBSOLETE
  • RETURNED
 
HOST_TYPE Type

Identifies the device type as one of the following:

  • Device Model, such as FLX_CLIENT— Standalone devices (including anonymous devices).
  • Server Host Type, such as FLX_SERVER—FlexNet Embedded Local License Server or Cloud License Server.
 
VM_NAME VMName A 64-character VM name for the device. VMName is null if MACHINE_TYPE is not VIRTUAL. This field may be empty.  
HOST_ID_TYPE IDType

One of several possible device host ID types:

  • Ethernet
  • Internet
  • Internet IPV6
  • FlexID 9
  • FlexID 10
  • String
  • User
  • VM UUID
  • Container Id
  • Extended
  • Publisher defined
 
BACKUP_DEVICE_NAME BackupDeviceID The ID of the backup device.  
PUBLISHER PublisherName A 64-character producer name.  
HOST_SERIES_NAME DeviceSeries A way of categorizing devices. A Device Series is a collection of device models that are physically identical  
DESCRIPTION Notes Extra information about a device provided by the producer.  
EMAIL DeviceUserEmail The email address of the device user associated with the device.  
ACCOUNT_ID DeviceAccountID

The ID of the customer or partner account that owns the device.

Exception: Anonymous devices are not associated with an account.

Equivalent to:

  • account: AccountID
  • entitlement: CustomersAndPartners.EndCustomerAccountID
  • fulfillment: AccountID
  • user: AccountID
  • usage: accountId
ACCOUNT_NAME DeviceAccountName

The name of the customer or partner account that owns the device.

Exception: Anonymous devices are not associated with an account.

Equivalent to:

  • account: AccountName
  • entitlement: CustomersAndPartners.EndCustomerAccountName
  • fulfillment: AccountName
  • user: AccountName
EVENT_TYPE EventType

The data returned by this API represents events that occur on the device. This field indicates the event type name for the event ID number in EVENT_ID. EventType may be one of the following values:

  • ACTIVATABLE_ITEM_ADDED
  • ACTIVATABLE_ITEM_REMOVED
  • ACTIVATABLE_ITEM_INCREASED
  • ACTIVATABLE_ITEM_DECREASED
  • ACTIVATABLE_ITEM_MARK_REMOVED
  • CAPABILITY_RESPONSE_SENT
  • CAPABILITY_RESPONSE_GENERATED
 
LASTMODIFIED_DATE LastModifiedDate The last date that the device was changed, or had entitlements mapped or licenses removed. For served devices, the date is updated when a license server sends information about the served device to be processed.  
CREATE_DATE CreateDate The date the device was created.  
CONSUMED_COUNT_DELTA ConsumedCountDelta The change to the count of an entitlement that the device is consuming, as the result of the event identified by the EVENT_ID, such as CAPABILITY_RESPONSE_SENT or CAPABILITY_RESPONSE_GENERATED. The value is the difference between the current consumed count and the old consumed count.  
ENTITLEMENT_ID EntitlementID

The ID of the entitlement whose line item has been mapped to the device.

Exception: Anonymous devices are not associated with an entitlement ID.

Equivalent to:

  • entitlement: EntitlementID
REQUESTED_COUNT_DELTA QtyOnDevice The count of a license item mapped to the device.  

EVENT_DATE

Note: Available only in device history.

DeviceAddOnEventDateAndTime The date and time that an add-on was mapped to the device.  
LICENSE_STATUS LicenseStatus The status of the license mapped to the device. For example, License not generated or License generated.  
ACTIVATION_ID ActivationID

The Activation ID of a line item mapped to the device.

Exception: Anonymous devices are not associated with an activation ID.

Equivalent to:

  • entitlement: ActivationID
  • fulfillment: ActivationID
  • usage: activationId
LICENSEOWNERID LicenseOwnerID The ID of the account owning the license mapped to the device. This is the same value as AccountID in the accounts API.  
LICENSEOWNERNAME LicenseOwnerName

The name of the account owning the license mapped to the device. This is the same value as the AccountName field in the accounts API.

 
BASE_PRODUCT BaseProduct The name of the base product mapped to the device. Usually this is the factory-installed software on a device, before add-ons are mapped.  
PRODUCT_NAME ProductName

The name of the product entitled by the line item mapped to the device.

Note:  A product is uniquely identified by its name and version.

Exception:  Products cannot be specified for anonymous devices.

Equivalent to:

  • entitlement: ProductName
  • fulfillment: ProductName
  • product-feature: ProductName 
PRODUCT_VERSION ProductVersion

The version of the product entitled by the line item mapped to the device.

Note:  A product is uniquely identified by its name and version.

Equivalent to:

  • entitlement: ProductVersion
PART_NUMBER PartNumber The part number of the product entitled by the line item mapped to the device.

Equivalent to:

  • entitlement: ProductVersion

Derived from EXPIRATION_DATE_ID

Note:  -1 or -2 represents PERMANENT.

IsPermanent

Indicates whether the license mapped to the device is permanent or will expire by specifying one of the following:

  • NONE: If it is set to NONE, the decision to decide if these licenses are permanent or expiring is deferred until the time an entitlement line item is configured.
  • PERMANENT: These licenses never expire.
  • EXPIRING: These licenses will expire in a duration of n days, weeks, months, or years, which are specified in EndDurationUnits and EndDuration in the entitlement entity.
 
EXPIRATION_DATE ExpirationDate The expiration date of the license mapped to the device.

Equivalent to:

  • entitlement: EndDate or EndDuration *
  • fulfillment: ExpirationDate

* Depends on how Expiration is defined for the line item.

 

LICENSEMODEL1

LicenseModel1

The license model for the primary activation on the device at the time of this event on the device.

Equivalent to:

  • entitlement: LicenseModel
  • fulfillment: LicenseModel
LICENSEMODEL2 LicenseModel2

The license model of a second activation that has occurred on the device. This field may be empty.

 
LICENSEMODEL3 LicenseModel3

The license model of a third activation that has occurred on the device. This field may be empty.

 
DWH_LASTUPDATED_DATE DWH_LASTUPDATED_DATE The last date that the record was refreshed in the data warehouse.  
PRODUCT_DELETED ProductDeleted List of products that were deleted.

Also referred to in:

  • entitlement: ProductDeleted
  • fulfillment: ProductDeleted
  • product-feature: ProductDeleted
ACTIVATION_DELETED ActivationDeleted List of activations that were deleted.

Also referred to in:

  • entitlement: ActivationDeleted
  • fulfillment: ActivationDeleted
ACCOUNT_DELETED AccountDeleted List of accounts that were deleted.

Also referred to in:

  • account: AccountDeleted
  • served-device: AccountDeleted
  • fulfillment: AccountDeleted
USER_DELETED UserDeleted List of users that were deleted.

Also referred to in:

  • served-device: UserDeleted
  • fulfillment: UserDeleted
  • user: UserDeleted

served-device

A served device is a device that requests licenses from an FlexNet Embedded license server. The following fields are in the served-device entity:

field in database Field in dapi Description Equivalent To
SERVEDCLIENTHOSTID ServedClientHostID The ID of the served device. This ID is always of type SERVED-DEVICE.  
SERVERHOSTID ServerHostID The ID of the server that the device requests licenses from.

Equivalent to:

  • device: DeviceID
DEVICE_ALIAS DeviceAlias A short, alternate name for the device.  
SITE_NAME SiteName Site name used for additional information purposes only.  
DESCRIPTION Notes Extra information about a device provided by the producer.  
USER_STRING DeviceUser

This field lists the user assigned to the device. This is dependent on the value set for the Device user option under System > Configure > FlexNet Operations > Embedded Device Settings. You use the Device user option setting to elect to offer the option to assign a user to a device, as well as whether the system will check the validity of the user. There are three possible values:

  • Off: Nothing to be validated.
  • On with no validation: This means any user can be added to the device, basically any string.
  • On with validation: Only the user belonging to the device owner account can be added to the device.

For more information, see About the Device–Device User Association In the FlexNet Operations User Guide.

 
SERVED_STATUS Status

The status of the served device. A served device status can be one of the following:

  • NORMAL
  • EXPIRED
  • DROPPED
 
ACCOUNT_ID DeviceAccountID

The ID of the customer or partner account that owns the device.

Exception: Anonymous devices are not associated with an account.

Equivalent to:

  • entitlement: CustomersAndPartners.EndCustomerAccountID
  • fulfillment: AccountID
  • user: AccountID
  • usage: accountId
ACCOUNT_NAME DeviceAccountName

The name of the customer or partner account that owns the device.

Exception: Anonymous devices are not associated with an account.

Equivalent to:

  • entitlement: CustomersAndPartners.EndCustomerAccountName
  • fulfillment: AccountName
  • user: AccountName
LAST_SYNC_TIME_ID LastSyncTime

The time of the last update about this served device sent by the license server for processing.

 
FEATURE_NAME FeatureName

The name of the feature request by the served device from the license server.

Note:  A feature is uniquely identified by its name and its version.

 Equivalent to: 

  • product-feature: FeatureName
VERSION FeatureVersion

The version of the feature request by the served device from the license server.

Note:  A feature is uniquely identified by its name and its version.

 Equivalent to: 

  • product-feature: FeatureVersion
FEATURE_COUNT Quantity The quantity of the feature request by the served device from the license server.  
OVERAGE Overage

This is an internal field used by the license server and FlexNet Operations.

Note:  This value is not the same as “overdraft”, which would be caused by a served device requesting more of a feature than is available on the license server.

 
EXPIRATIONDATE ExpirationDate The date and time at which the served device’s use of a feature will expire. After that time, the feature count will be returned to the license server’s count, and will be available for other served devices to request.  
LASTMODIFIED_DATE LastModifiedDate

The time when the served client was last modified.

A served client is modified whenever a synchronization message is sent to the back office (FlexNet Operations) from the Local License Service or Cloud License Server for this device as a result of a capability request.

 
DWH_LASTUPDATED_DATE DWH_LASTUPDATED_DATE The last date that the record was refreshed in the data warehouse.  
VENDOR_DICTIONARY VendorDictionary

The vendor dictionary provides a way for an implementer to send custom data in a capability request (in addition to the FlexNet Embedded–specific data) to the license server and vice-versa. Basically, the vendor dictionary provides a means to send information back and forth between the client and server for any producer-defined purposes, as needed; FlexNet Embedded does not interpret this data.

Vendor dictionary data is stored as key-value pairs. The key name is always a string, while a value can be a string or a 32-bit integer value, or an array of those types (arrays are only supported when using the Cloud Monetization REST API). Keys are unique in a dictionary and hence allow direct access to the value associated with them.

Communicate the available vendor dictionary data to your enterprise customer’s license server administrator if you want to enable them to use the vendor dictionary rule.

 
ACCOUNT_DELETED AccountDeleted List of accounts that were deleted.

Also referred to in:

  • account: AccountDeleted
  • device: AccountDeleted
  • fulfillment: AccountDeleted
USER_DELETED UserDeleted List of users that were deleted.

Also referred to in:

  • device: UserDeleted
  • fulfillment: UserDeleted
  • user: UserDeleted

entitlement

The following fields are in the entitlement report:

field in database Field in dapi Description Equivalent To
ENTITLEMENT_ID EntitlementID

A 19-digit unique identifier of the entitlement record as defined in FlexNet Operations.

Equivalent to:

  • device: EntitlementID
STATUS EntitlementState

An entitlement is created in a DRAFT, TEST, or DEPLOYED state.

Once an entitlement is no longer required, it can be made INACTIVE or OBSOLETE.

 
COMMENTS EntitlementDescription A brief, optional description of the entitlement.  
ALLOW_PORTAL_LOGIN AllowPortalLogin If Yes is specified, the end customer can use the entitlement ID or activation ID to log into the End-User Portal.  
SHIP_TO_EMAIL ShipToEmail Email address that FlexNet Operations sends the license to.  
SHIP_TO_ADDRESS Address Postal address that FlexNet Operations sends the license to.  
EMAIL_TEMPLATE_VARIATION EmailTemplateVariation

(Optional) Specify an email template.

  • If no template is specified, then the email template configured for the license technology is used.
  • If there is no email template configured for the license technology, then the default email template is chosen.
  • If the chosen template is not active or the send indicator is not switched on, no email is sent.
 
CURRENTOWNER CurrentOwner The account or partner that the entitlement is owned by at the time of this update.  
ACTIVATION_ID ActivationID The unique identifier of the entitlement line item as defined in FlexNet Operations.

Equivalent to:

  • device: ActivationID
  • fulfillment:ActivationID
  • usage: activationId
STATE ActivationState Whether the line item has been activated on a device.  
SEAT_COUNT LineItemQuantity

The quantity of the product entitled by the line item.

 
ORDERED_SEAT_COUNT OrderedSeatCount Net copies available for the line item. This includes all new, upgrade, upsell and renew orders, and excludes all upgraded, upsold, renewed, obsolete, and inactive orders for a line item.  
EXTENDED_SEAT_COUNT ExtendedSeatCount Count of the activated products. This count includes the number of copies of a given product purchased on its own as well as those copies included in a suite.  
ORDER_LINE_NUMBER OrderLineNumber

Order line number.

Note: This may be imported from your ERM/CRP application.

 
ORDER_ID OrderID

Order ID.

Note: This may be imported from your ERM/CRP application.

 
START_DATE_OPTION StartDateType

Type of defined start date, as one of the following:

  • Specify at each activation: (Not available for FlexNet Embedded licensing.) The user is prompted to specify a start date each time the line item is activated. Each fulfillment record gets a new start date, and for duration-based entitlements, each fulfillment record’s expiration date is set to start date specified + duration.
  • Specify value now: The start date was specified at the time of the entitlement’s creation. All fulfillment records of this line item get this start date.
  • Use first activation date: The date of the first activation is used as the start date. All fulfillment records for this line item get the same start date.
  • Specify at first activation: (Not available for FlexNet Embedded licensing.) The user is prompted to specify a start date when first activating the line item. This start date is used for all fulfillment records.
  • Use each activation date: Every time the line item is activated, the activation date is used as the start date. Each fulfillment record gets a new start date. As a result, for duration-based entitlements, each fulfillment record’s expiration date is set to activation date + duration.
 
START_DATE StartDate Start date of the line item  
EXPIRATION_DATE EndDate

Expiration date of the line item.

Equivalent to:

  • device: ExpirationDate
  • fulfillment: ExpirationDate

Derived from EXPIRATION_DATE_ID

Note:  -1 or -2 represents PERMANENT.

IsActivationPermanent

Indicates whether the activation ID or line item is permanent or will expire by specifying one of the following:

  • NONE: If it is set to NONE, the decision to decide if these licenses are permanent or expiring is deferred until the time an entitlement line item is configured.
  • PERMANENT:These licenses never expire.
  • EXPIRING: These licenses will expire in a duration of n days, weeks, months, or years, which are specified in EndDurationUnits and EndDuration.
 
DURATION_UNITS EndDurationUnits

If IsActivationPermanent is set to EXPIRING, specify the end duration units as one of the following:

  • DAYS
  • WEEKS
  • MONTHS
  • YEARS
 
DURATION EndDuration If IsActivationPermanent is set to EXPIRING, specify number of days, weeks, months, or years in which the licenses will expire, according to the EndDurationUnits specified.

Equivalent to:

  • device: ExpirationDate
  • fulfillment: ExpirationDate

VERSIONDATETYPE

VERSION_DATE

VERSION_DATE_DUR_UNITS

VERSION_DATE_DURATION

VersionDateType

VersionDate

VersionDurationUnits

VersionDuration

These fields describe your Date-Based Versioning configuration

as described in the following topic:

Creating a FlexNet Publisher Licensing Toolkit License Generator (VCG) Configuration

 
ORDER_TYPE OrderType

Possible Order Types are:

  • UPSELL
  • UPGRADE
  • RENEWAL
  • NEW
 
PARENT_LINE_ITEM_ID OrderParent The original order that this order originated from.  
DESCRIPTION LineItemDescription A free-form description added to the line item.  
PRODUCT_NAME ProductName

The name of the product entitled by the line item.

Note: A product is uniquely identified by its name and version.

Equivalent to:

  • device: ProductName
  • fulfillment: ProductName
  • product-feature: ProductName
PRODUCT_TYPE ProductType

Identifies the product type as one of the following:

  • PRODUCT
  • SUITE
  • MAINTENANCE
 
PRODUCT_VERSION ProductVersion

The version of the product entitled by the line item.

Note: A product is uniquely identified by its name and version.

Equivalent to:

  • device: ProductVersion
PRODUCT_COUNT ProductCount

Identifies the quantity of product features entitled by this line item. The format of the ProductCount is as follows:

productID|featureID-n.featureID-n.featureID-n

where:

  • productID|: A database identifier for the product, followed by a pipe (|) character. This ID appears in the URL when viewing a product in the FlexNet Operations Producer Portal.
  • featureID-n: A database identifier for a product feature or feature bundle of the specified product, followed by a hyphen and a number identifying the quantity of that feature. Multiple features/feature bundles are separated by a period.

For example, this entry:

37850|37830-1.37831-1.37832-1

... means that Product ID 37850 has three features (37830, 37831, and 37832), each with an entitled quantity of 1.

 
PART_NUMBER PartNumber The part number of the product entitled by the line item.

Equivalent to:

  • device: PartNumber
  • fulfillment: PartNumber
LICENSEMODEL LicenseModel The license model used for the Line Item.

Equivalent to:

  • device: LicenseModel1, LicenseModel2, LicenseModel3
  • fulfillment: LicenseModel
REMAINING_COPIES RemainingCopies The number from the value given in lineItemQuantity that have not yet been mapped to a device or license server.  
CREATED_ON CreatedOn The date on which the line item was created.  
ENDCUSTOMER_ACCOUNT_ID CustomersAndPartners.EndCustomerAccountID

The account ID for the end user (customer) account that owns the entitlement.

Note: Only applicable if this line item was sold through a Channel Partner.

Equivalent to:

  • account: AccountID
  • device: DeviceAccountID
  • fulfillment: AccountID
  • user: AccountID
  • usage: accountId
ENDCUSTOMER_ACCOUNT_NAME CustomersAndPartners.EndCustomerAccountName

A display name for the end user (customer) account that owns the entitlement.

Note: Only applicable if this line item was sold through a Channel Partner.

Equivalent to:

  • account: AccountName
  • device: DeviceAccountName
  • fulfillment: AccountName
  • user: AccountName
ENDCUSTOMER_USEREMAIL CustomersAndPartners.EndCustomerUserEmail

Email address for the end user (customer) account that owns the entitlement.

Note: Only applicable if this line item was sold through a Channel Partner.

 
ENDCUSTOMER_USERFIRSTNAME CustomersAndPartners.EndCustomerUserFirstName

First name for the end user (customer) account that owns the entitlement.

Note: Only applicable if this line item was sold through a Channel Partner.

 
ENDCUSTOMER_USERLASTNAME CustomersAndPartners.EndCustomerUserLastName

Last name for the end user (customer) account that owns the entitlement.

Note: Only applicable if this line item was sold through a Channel Partner.

 
ENDCUSTOMER_USERNAME CustomersAndPartners.EndCustomerUserName

User name for the end user (customer) account that owns the entitlement.

Note: Only applicable if this line item was sold through a Channel Partner.

 
ENDCUSTOMER_USERPHONE CustomersAndPartners.EndCustomerUserPhone

Phone number for the end user (customer) account that owns the entitlement.

Note: Only applicable if this line item was sold through a Channel Partner.

 
PARTNER_TIER_ACCOUNT_ID CustomersAndPartners.PartnerTier1AccountID

The account ID for the Partner Tier 1 account that owns the entitlement.

Note: Only applicable if this line item was sold through a Channel Partner.

 
PARTNER_TIER_ACCOUNT_NAME CustomersAndPartners.PartnerTier1AccountName

The account name for the Partner Tier 1 account that owns the entitlement.

Note: Only applicable if this line item was sold through a Channel Partner.

 
PARTNER_TIER_USEREMAIL CustomersAndPartners.PartnerTier1UserEmail

The email address for the Partner Tier 1 account that owns the entitlement.

Note: Only applicable if this line item was sold through a Channel Partner.

 
PARTNER_TIER_USERFIRSTNAME CustomersAndPartners.PartnerTier1UserFirstName

First name for the Partner Tier 1 account that owns the entitlement.

Note: Only applicable if this line item was sold through a Channel Partner.

 
PARTNER_TIER_USERLASTNAME CustomersAndPartners.PartnerTier1UserLastName

Last name for the Partner Tier 1 account that owns the entitlement.

Note: Only applicable if this line item was sold through a Channel Partner.

 
PARTNER_TIER_USERNAME CustomersAndPartners.PartnerTier1UserName

User name for the Partner Tier 1 account that owns the entitlement.

Note: Only applicable if this line item was sold through a Channel Partner.

 
PARTNER_TIER_USERPHONE CustomersAndPartners.PartnerTier1UserPhone

Phone number for the Partner Tier 1 account that owns the entitlement.

Note: Only applicable if this line item was sold through a Channel Partner.

 
LASTMODIFIED_DATE LastModifiedDate The date and time when the line item was last modified.  
MAINTENANCE_ACTIVATION_ID Maintenance.Maintenance_ActivationID

The activation ID of Maintenance, if it is associated with this line item.

 
MAINTENANCE_PRODUCT Maintenance.Maintenance_ProductName

The product name of Maintenance, if it is associated with this line item.

 
MAINTENANCE_PART_NUMBER Maintenance.Maintenance_PartNumber

The part number of Maintenance, if it is associated with this line item.

 
MAINTENANCE_START_DATE Maintenance.Maintenance_StartDate

The date on which Maintenance begins, if it is associated with this line item.

 
MAINTENANCE_END_DATE Maintenance.Maintenance_EndDate

The date on which Maintenance ends, if it is associated with this line item.

 

 
MAINTENANCE_ORDER_LINE_NUMBER Maintenance.Maintenance_OrderLineNumber

The order line number of Maintenance, if it is associated with this line item.

 
MAINTENANCE_ORDER_ID Maintenance.Maintenance_OrderID

The order ID of Maintenance, if it is associated with this line item.

 
MAINTENANCE_PRODUCT_VERSION Maintenance.Maintenance_ProductVersion

The product version of Maintenance, if it is associated with this line item.

 
LINEITEM_ACTIVATION_ID Maintenance.Maintenance_Link_LineItemActivationID

The line item activation ID link of Maintenance, if it is associated with this line item.

 
DWH_LASTUPDATED_DATE DWH_LASTUPDATED_DATE The last date that the record was refreshed in the data warehouse.  
ENDCUSTOMER_ACCOUNT_DELETED EndCustomerAccountDeleted List of end customer accounts that were deleted.

 

ENDCUSTOMER_USER_DELETED EndCustomerUserDeleted List of end customer users that were deleted.

 

PARTNER_ACCOUNT_DELETED PartnerAccountDeleted List of partner accounts that were deleted.  
PARTNER_USER_DELETED PartnerUserDeleted List of partner users that were deleted.  
ACTIVATION_DELETED ActivationDeleted List of activations that were deleted.

Also referred to in:

  • device: ActivationDeleted
  • fulfillment: ActivationDeleted
PRODUCT_DELETED ProductDeleted List of products that were deleted.

Also referred to in:

  • device: ProductDeleted
  • fulfillment: ProductDeleted

fulfillment

The following fields are in the fulfillment report:

Note: This API only applies to FlexNet Publisher fulfillments.

field in database Field in dapi Description Equivalent To
ID FulfillmentID A unique identifier for the fulfillment record.  
STATUS Status

The state of the line item:

  • MASTER
  • INACTIVE
  • OBSOLETE
 
PARENT_FULFILLMENT_ID ParentFulfillmentID A unique identifier for the parent fulfillment record of this fulfillment record.  
ACTIVATION_ID ActivationID The unique identifier of the entitlement line item as defined in FlexNet Operations.

Equivalent to:

  • device: ActivationID
  • entitlement: ActivationID
  • usage: activationId
ACTIVATION_TYPE ActivationType

The method of activation, which is one of the following:.

  • SHORTCODE—Trusted storage fulfillment records generated using short code activation.
  • MANUAL—Trusted storage fulfillment records generated using manual (or offline activation) processing of the request and response XML files.
  • PROGRAMMATIC—Trusted storage fulfillment records generated using regular online activation from the client.
  • CERTIFICATE—Certificate licenses.
  • TRUSTED—Legacy trusted storage fulfillment records which do not have specific information about how they were activated.
  • EMBEDDED—Licenses generated using FlexNet Embedded for hardware devices.
  • CUSTOM—Fulfillment records that belong to any non-FlexNet licensing technology.
 
START_DATE FulfillmentDate Date fulfillment record was created.  
EXPIRATION_DATE ExpirationDate Date fulfillment record expires.

Equivalent to:

  • device: ExpirationDate
  • entitlement: EndDate or End Duration *

* Depends on how Expiration is defined for the line item.

OVERDRAFT_COUNT OverdraftCount Specifies the number of users that can run a software package during peak usage times, even after the application’s license limit has been reached.  
SHIP_TO_EMAIL ShipToEmail

Email address that FlexNet Operations sends the license to.

 
USER_ID CreatedBy

User who created the fulfillment.

 
FULFILLMENT_SOURCE FulfillmentSource

The activation process used for fulfillment. Fulfillment Source can be:

  • ONLINE—For fulfillment records generated using web services.
  • APPLICATION—For fulfillment records generated using the FlexNet Operations user interface.
  • LEGACY—Used for legacy fulfillment records that do not have information about how the fulfillment records were generated.
 
LIFECYCLE_STATUS LifeCycleStatus    
HOST_ID HostEntityID

The host on which the license was activated.

  • For certificate licenses, Host ID is the usual host identifier (such as INTERNET=64.0.0.1).
  • For trusted licenses, Host ID is UMN or Machine Identifier.
  • For non-FlexNet technologies, Host ID is the custom host identifier.

Note: See Special Host ID Types in the FlexNet Operations User Guide for more information about host ID types.

 
HOST_OWNER HostUserID    
IS_SERVER IsServer Whether this fulfillment is used on a License Server.  
IS_REDUNDANT_SERVER Redundant    
IS_TRUSTED Trusted Whether this fulfillment record is for Trusted Storage, which would result in the value true.  
IS_NODELOCKED_TYPE IsNodelocked Whether this fulfillment is locked to a single device (which would show TRUE), or provisioned on a license server for concurrent licensing.  
IS_CUSTOM IsCustom    
FULFILL_COUNT FulfillmentCount The count from the line item that this fulfillment record consumes.  
LASTMODIFIED_DATE LastModifiedDate The date and time that this fulfillment record was last modified.  
LICENSEMODEL LicenseModel The name of the License Model used in the Line Item from which this fulfillment record was generated.

Equivalent to:

  • device: LicenseModel1, LicenseModel2, LicenseModel3
  • entitlement: LicenseModel
PRODUCT_NAME ProductName The name of the Product entitled by the Line Item from which this fulfillment record was generated.

Equivalent to:

  • device: ProductName
  • entitlement: ProductName
  • product-feature: ProductName 
PART_NUMBER PartNumber The part number to which the fulfillment is linked, if any.

Equivalent to:

  • device: PartNumber
  • entitlement: PartNumber
ACCOUNT_ID AccountID

A unique identifier of an organization’s account as defined in FlexNet Operations. (For example, Stark International Enterprises.)

Equivalent to:

  • account: AccountID
  • device: DeviceAccountID
  • served-device: DeviceAccountID
  • entitlement: CustomersAndPartners.EndCustomerAccountID
  • user: AccountID
  • usage: accountId
ACCOUNT_NAME AccountName

A display name for an organization’s account as defined in FlexNet Operations. (For example, Stark.) The Account Name is what FlexNet Operations displays on most of the Producer Portal and End-User Portal pages.

Equivalent to:

  • account: AccountName
  • device: DeviceAccountName
  • entitlement: CustomersAndPartners.EndCustomerAccountName
  • user: AccountName
DWH_LASTUPDATED_DATE DWH_LASTUPDATED_DATE The last date that the record was refreshed in the data warehouse.  
PRODUCT_DELETED ProductDeleted List of products that were deleted.

Also referred to in:

  • device: ProductDeleted
  • entitlement: ProductDeleted
  • product-feature: ProductDeleted
ACTIVATION_DELETED ActivationDeleted List of activations that were deleted.

Also referred to in:

  • device: ActivationDeleted
  • entitlement: ActivationDeleted
ACCOUNT_DELETED AccountDeleted List of accounts that were deleted.

Also referred to in:

  • account: AccountDeleted
  • device: AccountDeleted
  • served-device: AccountDeleted
USER_DELETED UserDeleted List of users that were deleted.

Also referred to in:

  • device: UserDeleted
  • served-device: UserDeleted
  • user: UserDeleted

product-feature

The product-feature entity is provided to be able to build a report in which all the features used in a product can be presented. The ProductName and ProductVersion fields are provided so the feature list can be filtered to find all the features included in the product.

The following fields are in the product-feature entity:

FIELD IN DATABASE FIELD IN DAPI Description Equivalent To
PRODUCT_NAME ProductName Name of product feature is associated with.

Equivalent to:

  • entitlement: ProductName
  • fulfillment: ProductName
  • device: ProductName
PRODUCT_VERSION ProductVersion Version of product feature is associated with.  
q_sku_id SKU_ID The unique identifier of the Part Number as defined in FlexNet Operations.  
SkuName SKU_NAME Name of the Part Number defined in FlexNet Operations.

Equivalent to:

  • entitlement: PartNumber
  • fulfillment: PartNumber
  • device: PartNumber
SkuDescription SKU_DESCRIPTION Description of the Part Number.  
SkuTrialAvailable SKU_TRIAL_AVAILABLE Whether the Part Number is available for trial or not.  
SkuLicenseModel SKU_LICENSE_MODEL License Model linked to Part Number.  
FEATURE_NAME FeatureName Name of feature.  
FEATURE_VERSION FeatureVersion Version of feature.  
FEATURE_COUNT FeatureCount

Specifies count of the feature in the Product.

For example, if the count of Feature A is 2, a license generated for the product contains 2 counts of Feature A.

 
FEATURE_STATUS FeatureStatus

A feature can be in one of two states: DRAFT or DEPLOYED.

  • DRAFT: A feature is created as a draft that can be modified or deleted. Both draft and deployed features can be added to a feature bundle or a product in a draft state.
  • DEPLOYED: A deployed feature cannot be modified or deleted. If a feature bundle or product is deployed, all the draft features it contains are also deployed. After a feature is deployed to use in production, it cannot be deleted or modified.
 
FEATURE_COUNTED FeatureCounted

Counts the number of seats deployed to customers.

  • YES: Counts the number of seats deployed to customers.
  • NO: Provides unlimited copies.
  • DO NOT OVERRIDE: If this is set at the feature level, the license model will decides the countedness of the feature.
 
FEATURE_UNITS FeatureUnits

Applies only for metered features.

Specifies the units to be used for usage reporting. For example, if usage-capture clients are capturing usage of data, producers may want to label the reported counts as bytes or kilobytes or gigabytes.

FeatureUnits and FeatureScale(below) work together to describe what the metered feature is counting.

 
FEATURE_SCALE FeatureScale

Applies only for metered features.

Represents how much is a unit for usage reporting purposes. For example, if usage-capture clients are capturing usage of data in bytes but the usage should be reported in kilobytes, entering 1024 for FeatureScale will achieve this.

FeatureUnits (above) and FeatureScale work together to describe what the metered feature is counting.

 
FEATURE_DESCRIPTION FeatureDescription Description of feature.  
FEATURE_VERSION_FORMAT FeatureVersionFormat

FeatureVersionFormat is either FIXED or DATE BASED.

  • FIXED
  • DATE BASED: Using date-based versions is a product versioning strategy. The version number that the application asks for when it checks out a license is a representation of the date it was built. Therefore, a customer has the right to use a version (the build date) of the application less than or equal to the date that the maintenance expires (the version in the license)

The date-based version in the license varies from license certificate to license certificate, whereas a fixed version is the same for all licenses generated for that product-version combination. If a feature is created that uses a date-based version format, the date that is expressed in that format is specified when an entitlement line item containing that product is configured.

For a date of May 15, 2009, yyyy.MM gives 2009.05 and yyyy.MMdd gives 2009.0515.

 
FEATURE_CREATE_DATE FeatureCreateDate Date and time feature was created.  
FEATURE_LAST_MODIFIED FeatureLastModified Date and time feature was last updated.  
DWH_LASTUPDATED_DATE DWH_LASTUPDATED_DATE The last date that the record was refreshed in the data warehouse.  
PRODUCT_DELETED ProductDeleted List of products that were deleted.

Also referred to in:

  • device: ProductDeleted
  • entitlement: ProductDeleted
  • fulfillment: ProductDeleted
PRODUCT_FEATURE_DELETED ProductFeatureDeleted List of product features that were deleted.

 

user

The following fields are in the user report:

FIELD IN DATABASE FIELD IN DAPI Description Equivalent To
FIRSTNAME FirstName

User's first name.

 
LASTNAME LastName

User’s last name.

 
DISPLAYNAME DisplayName

Display name for the user.

 
EMAIL EmailAddress

User’s email address.

 
USER_ID UserName The ID by which the User is uniquely identified.  
ROLE_NAME Role List of user's roles.  
STATUS Status

The status of the User. Possible values are:

  • ACTIVE
  • INACTIVE
 
ACCOUNT_ID AccountID The ID of the account to which the user belongs. This is the same value as AccountID in the account entity.

Equivalent to:

  • account: AccountID
  • device: DeviceAccountID
  • served-device: DeviceAccountID
  • entitlement: CustomersAndPartners.EndCustomerAccountID
  • fulfillment: AccountID
  • usage: accountId
ACCOUNT_NAME AccountName The name of the Account to which the user belongs. This is the same value as AccountName in the account entity.

Equivalent to:

  • account: AccountName
  • device: DeviceAccountName
  • entitlement: CustomersAndPartners.EndCustomerAccountName
  • fulfillment: AccountName
SHAREDLOGIN SharedLogin

If this user account is a shared login, logged in history is not written to the database. It is useful when the same user account is used to log into FlexNet Operations simultaneously from different instances, like web services.

Shared users should only be used for integration users. This is to allow concurrent requests from this user through APIs. For example, the same user can be used to authenticate the API to create an entitlement, while there is another API that is being used to add users to an account. If shared login is not enabled for the user that is being used to authenticate these web service requests, the requests will fail.

 
PORTAL_LOGIN PortalLogin Whether the user is allowed to log into the End User Portal.  
STREET_ADDRESS Street

User’s street address.

 
CITY City

User’s city.

 
STATE State

User’s state.

 
POSTALCODE ZipCode

Users' zip code.

 
COUNTRY Country

User’s country.

 
TIMEZONE TimeZone

User’s time zone.

 
LOCALE Locale The locale setting for the user.  
PHONE PhoneNumber

User’s phone number.

 
FAX FaxNumber

User’s fax number.

 
OPTIN ReceiveEmail Whether the user has opted into receiving marketing emails from the Producer.  
RENEWAL_SUBSCRIPTION ReceiveExpiringEmails Whether the user has opted into receiving emails about expiring entitlements.  
SELF_REGISTERED_USER SelfRegisteredUser Whether the user is a self-registered user.  
CREATEDATE CreateDate

The date and time at which the user was created in the FlexNet Operations system.

 
LASTUPDATED LastUpdatedDate The date and time at which the user’s details were last updated.  
EXPIRY_DATE ExpiryDate

User expiration date. This will be displayed if the configuration Enable User Expiration’ under System > Configure > FlexNet Operations > General Options is enabled.

This is applicable to all users except Contacts and Shared Users. When this is enabled, an option to provide expiration date is displayed next to the account on the View user page.

The user expiration date will be displayed if the Enable User Expiration option under System > Configure > FlexNet Operations > General Options is enabled. It is applicable to all users except Contacts and Shared Users. When this option is enabled, an option to provide expiration date is displayed next to the account on the View user page.

 
LASTAUTHENTICATED LastLoginDate

The date and time of the user’s last login to FlexNet Operations.

Note: This date and time may or may not include authentications to API calls. If a user is a shared login, its last login date will not be updated when an API call is made . However, when a normal user fires an API call, it will be considered as a login and the last login date will get updated.

 
USER_TYPE Type

The type of the user. Possible values are:

  • PRODUCER
  • CUSTOMER
  • PARTNER
  • SELF-REGISTERED
 
DWH_LASTUPDATED_DATE DWH_LASTUPDATED_DATE The last date that the record was refreshed in the data warehouse.  
USER_DELETED UserDeleted List of users that were deleted.

Also referred to in:

  • device: UserDeleted
  • served-device: UserDeleted
  • fulfillment: UserDeleted

downloads

The following fields are in the downloads report:

FIELD IN DATABASE FIELD IN DAPI Description Equivalent To
DOWNLOAD_ID DownloadID A unique identifier of a download initiated as recorded in FlexNet Operations Electronic Software Delivery.
DOWNLOAD_STATUS DownloadStatus Refers to the current state or progress of a file, application, or data being transferred. The values are COMPLETE or INCOMPLETE.
DOWNLOAD_TYPE DownloadMethod Identifies the technique or process of how the download operation is carried out. The methods can be AKAM, FDLM, HTTP, or ADLM.
LICENSE_HOST_NAME DownloadOrigin The source location from which a file, application, or data is being downloaded. 
DOWNLOAD_COUNTRY_REGION DownloadCountryRegion The geographic location of the user based on the IP address where the download was initiated
DOWNLOAD_IP_ADDRESS DownloadIPAddress The IP address from where the download was initiated
DOWNLOAD_START_DATETIME DownloadStartTime A timestamp that marks the initiation of the download process after the user clicks a download button or a system initiates the request.
DOWNLOAD_END_DATETIME DownloadEndTime A timestamp that marks the conclusion of the download process, after all data packets have been successfully transferred and written to the target location.
DOWNLOAD_PACKAGE_NAME DownloadPackageName A unique ID used to associate the download package with products and files. It is referred to as the Download Package ID in FlexNet Operations
DOWNLOAD_PACKAGE_VERSION DownloadPackageVersion Version of the download package.
BYTES_DOWNLOADED TotalBytesDownloaded The complete amount of data or size of the file(s) downloaded measured in bytes.
N/A TotalKbytesDownloaded The complete amount of data or size of the file(s) downloaded measured in Kilobytes (KBs).
N/A TotalMbytesDownloaded The complete amount of data or size of the file(s) downloaded measured in Megabytes (MBs).
N/A TotalGbytesDownloaded The complete amount of data or size of the file(s) downloaded measured in Gigabytes (GBs).
N/A DownloadDurationInSeconds Total time it takes for a download process to complete, measured in seconds. Measures the absolute time from the moment the download starts until it ends, including all pauses, delays, and reattemps.
DOWNLOAD_DURATION DownloadDurationInMinutes Total time it takes for a download process to complete, measured in minutes. Measures the absolute time from the moment the download starts until it ends, including all pauses, delays, and reattemps.
DOWNLOADS_ATTEMPTED_COUNT DownloadsAttemptedCount The total number of times a user or system initiates a download. This tracks how many download attempts were made, regardless of whether the downloads were completed, interrupted, or failed.
CONTACT_ACCOUNT_DISPLAY_ID AccountID A unique identifier of an organization’s account as defined in FlexNet Operations. (For example, StarkLLC.)

Equivalent to:

  • device: DeviceAccountID
  • entitlement: CustomersAndPartners.EndCustomerAccountID
  • fulfillment: AccountID
  • user: AccountID
  • usage: accountId
CONTACT_ACCOUNT_DISPLAY_NAME AccountName Display name of an account or organization as defined in FlexNet Operations. (For example, Stark International Enterprises.)

Equivalent to:

  • device: DeviceAccountName
  • entitlement:

    CustomersAndPartners.EndCustomerAccountName

  • fulfillment: AccountName
  • user: AccountName
CONTACT_COUNTRY UserCountry User’s country as recorded in the FlexNet Operations.

Equivalent to:

  • user: Country
CONTACT_FIRST_NAME UserFirstName User's first name as recorded in the FlexNet Operations.

Equivalent to:

  • user: FirstName
CONTACT_LAST_NAME UserLastName User’s last name as recorded in the FlexNet Operations.

Equivalent to:

  • user: LastName
CONTACT_EMAIL_ADDRESS UserEmailAddress User’s email address as recorded in the FlexNet Operations.

Equivalent to:

  • user: EmailAddress
CONTACT_ADDRESS UserAddress User’s address(street name and city) as recorded in the FlexNet Operations.

Equivalent to:

  • user: Street, City
CONTACT_CREATED_DATE UserCreateDate The date and time at which the user was created in the FlexNet Operations system.

Equivalent to:

  • user: CreateDate
N/A UserDownloadDurationInSeconds The amount of time, measured in seconds, that a user experiences for a file or data download to complete. It includes only the active time the user is downloading the file, excluding any paused or interrupted states initiated by the user or system. This metric reflects the real-world download time from the user's perspective.
USER_DOWNLOAD_DURATION UserDownloadDurationInMinutes The amount of time, measured in minutes, that a user experiences for a file or data download to complete. It includes only the active time the user is downloading the file, excluding any paused or interrupted states initiated by the user or system. This metric reflects the real-world download time from the user's perspective.
ENTITLEMENT_ID EntitlementID A 19-digit unique identifier of the entitlement record as defined in FlexNet Operations.

Equivalent to:

  • device: EntitlementID
  • entitlement: EntitlementID
FILE_NAME FileName Your company's unique identifier for this file. This is the File ID in FlexNet Operations.

Equivalent to:

  • file: File Name
FILE_DESCRIPTION FileDescription Full name of the file. This is the name displayed for this file in the FlexNet Operations End-User Portal.
FILE_STATUS FileStatus Indicates whether or not the file has been uploaded into the FlexNet Operations ESD download repository. The values are LOADED or DELETED,

Equivalent to:

  • file: File Status
FILE_CREATE_USER_EMAIL FileCreatedUserEmail Email address of the user who created the file in the FlexNet Operations.

Equivalent to:

  • file: File Created User Email
FILE_CREATE_DATE FileCreatedDate Timestamp when the file was first created and stored.

Equivalent to:

  • file: File Created Date
FILE_LAST_UPDATE_DATE FileLastUpdatedDate Timestamp when the file was last modified and stored.

 

FILE_LAST_UPLOADED_DATE FileLastUploadedDate Timestamp when the file was most recently uploaded and stored.

Equivalent to:

  • file: Last Uploaded Date
FILE_SIZE FileSizeInBytes Exact number of bytes used to store a file’s data.

Equivalent to:

  • file: File Size in Bytes
N/A FileSizeInKbytes The size of the file in Kilobytes (KBs).

Equivalent to:

  • file: File Size in KB
N/A FileSizeInMbytes Size of the file in Megabytes (MBs).

Equivalent to:

  • file: File Size in MB
N/A FileSizeInGbytes Size of the file in Gigabytes (GBs).

Equivalent to:

  • file: File Size in GB
AGREEMENT_ID EndUserLicenseAgreementID End User License Agreement ID associated with this Download Package.
AGREEMENT_VERSION_NUMBER EndUserLicenseAgreementVersion End User License Agreement ID version associated with this Download Package.
AGREEMENT_ACCEPTED_DATETIME EndUserLicenseAgreementAcceptedDate Timestamp when the end user read and accepted the End User License Agreement.
PRODUCT_ID ProductID Combination of the name of the product and the product version defined in FlexNet Operations. ProductName::ProductVersion
PRODUCT_NAME ProductName Product description as defined in FlexeNet Operations. If it is not defined, it assumes the Product ID value.
PRODUCT_LINE_NAME ProductLineName Product line defined in FlexNet Operations which is associated to the Product ID.
PRODUCT_STATUS ProductStatus The status used to indicate order availability of the product. The values are ACTIVE or INACTIVE

files

The following fields are in the files report:

FIELD IN DATABASE FIELD IN DAPI Description Equivalent To
FILE_NAME_ID FileID Your company's unique identifier for this file. This is the File ID in FlexNet Operations.  
FILE_NAME FileName The full name of the file. This is the name that is displayed in the FlexNet Operations End User Portal for the file.

Equivalent to:

  • file: File Name
FILE_SIZE FileSizeInBytes The size of the file in bytes.

Equivalent to:

  • file: File Size in Bytes
N/A FileSizeInKilobytes The size of the file in KBs.

Equivalent to:

  • file: File Size in KB
N/A FileSizeInMegabytes The size of the file in MBs.

Equivalent to:

  • file: File Size in MB
N/A FileSizeInGigabytes The size of the file in GBs.

Equivalent to:

  • file: File Size in GB
FILE_STATUS FileStatus Indicates whether or not the file has been uploaded into the FlexNet Operations ESD download repository. The possible values are LOADED, NOT LOADED, or DELETED.

Equivalent to:

  • file: File Status
FILE_LAST_UPLOADED_DATE FileLastUploadedDate The timestamp when the file was most recently uploaded and stored.

Equivalent to:

  • file: Last Uploaded Date
FILE_CREATE_DATE FileCreatedDate The timestamp when the file was first created and stored.

Equivalent to:

  • file: File Created Date
FILE_CREATE_USER_EMAIL FileCreatedUserEmail The user email address of the individual who created the file in FlexNet Operations.

Equivalent to:

  • file: File Created User Email
FILE_LAST_UPDATE_USER_EMAIL FileLastUpdatedUserEmail The email address of the individual who last modified or updated the file in FlexNet Operations.  

usage

The following fields are in the usage report:

FIELD IN DATABASE FIELD IN DAPI Description Equivalent To
CORRELATION_ID correlationId

An ID that relates this row with a specific access request.

For Cloud License Servers/Local License Servers, this field is populated from each capability/access request.

 
TENANT_ID N/A

The ID of the producer owning the Product Activation Server/Cloud License Server/Local License Server instance this charge was made to.

 
USAGE_TIME usageTime

The time the usage occurred in the Product Activation Server or Cloud License Server expressed as milliseconds since 1970-01-0.

 
WRITE_TIME writeTime The time the usage was written to the Snowflake Data Warehouse.  
CONSUMER_ID consumerId

The value of the requester name in the access request.

For Cloud License Servers, this is the device ID of the served device.

 
CONSUMER_TYPE consumerType

The value of the Type field in the requester object provided for the item request.

For Cloud License Servers or Local License Servers, this will be the device ID type.

 
ACCOUNT_ID accountId

The ID of the account owning the Product Activation Server/Cloud License Server/Local License Server instance

Equivalent to:

  • account: AccountID
  • device: DeviceAccountID
  • served-device: DeviceAccountID
  • entitlement: CustomersAndPartners.EndCustomerAccountID
  • fulfillment: AccountID
  • user: AccountID
INSTANCE_ID instanceId

The instance of Product Activation Server, or Cloud License Server, or Local License Server used in this row.

 
ACTIVATION_ID activationId

A array of activation IDs for the line items used in this row. Will be blank (represented with null value) for denied items, such as ["act0"].

  • For Elastic Access, this will always be a single activation ID.
  • For Cloud License Servers/Local License Servers, the array will have one or more activation IDs.

Equivalent to:

  • device: ActivationID
  • entitlement: ActivationID
  • fulfillment: ActivationID
MAPPED_ENTITLED_COUNT mappedEntitledCount

The count from the line item mapped to this instance.

  • Denied items: For denited items, will be blank (represented with null value).
  • Uncounted features: For Cloud License Servers/Local License Servers, this value will be blank for uncounted features.
 
USED used

The total number from the mapped line item quantity currently being used across all item requests.

  • Elastic—The total tokens charged so far from the line-item
  • Concurrent—The total count currently in use.
  • Metered—The total charged from the line-item so far.
  • Denied items—Will be blank (represented with null value).
 
ITEM Item

The item requested. It might be a feature, or product, or some other technology item that can be requested.

 
ITEM_VERSION itemVersion

The version of the item requested. This might not be applicable to the item type.

For Cloud License Servers/Local License Servers, this will be version requested.

 
ITEM_QUANTITY itemQuantity

The quantity of the item requested.

 
SESSION_ID sessionId

For elastic meter activity using a session, the unique identifier of the session.

 
SESSION_STATE sessionState

For elastic meter activity using a session, the state of the session.

 
REQUEST_RESPONSE requestResponse

The status value in the access request and capability request response. Differs according to the monetization service in use—consult licensing documentation. This is used to indicate denials.

  • For successful capability requests, REQUEST_RESPONSE is blank.
  • For denied (unsuccessful) capability requests, REQUEST_RESPONSE contains a status value. Refer to the FlexNet Embedded Producer Guide for a list of status values and their descriptions.

For status values returned for Dynamic Monetization access requests, refer to the Dynamic Monetization API Reference.

 
CONTROLS_APPLIED controlsApplied

Access controls applied to the feature.

For Cloud License Servers/Local License Servers, this will be the named license pool used to fulfill the request, in JSON format. For example:

{
  "partition": ["p1", "p2", ...]
}

 
METER_TYPE meterType

The type of license model applicable to the line item used in this row.

Examples are “concurrent”, “metered”, “elastic”.

 
METER Meter

The unit applicable to the meter cost.

Feature count when the METER_TYPE is concurrent or metered on a Cloud License Server or Local License Server.

 
METER_COST_LIST meterCostList

For elastic meter type, the rate table being used to calculate the cost.

  • For denied items, will be blank (represented with null value).
  • For concurrent or metered METER_TYPE, this will remain empty.
 
METER_COST meterCost

For elastic meter type, the rate read from the rate table.

  • For denied items, will be blank (represented with null value).
  • For concurrent or metered METER_TYPE, this will remain empty.
 
METER_QUANTITY meterQuantity

The number used from the mapped line item count by the transaction given in this row

  • For elastic, this will be zero for denied items.
  • For concurrent or metered on Cloud or Local License Servers, this will be the quantity of feature requested.
 
META_DATA metadata

Some data provided by the requester for supplementary analytics purposes. A valid JSON object.

For Cloud or Local License Servers, this is the Vendor Dictionary data, converted from key-pair form to a valid JSON object.

 
PARTIAL isPartial

If set to True, the capability request is “partial”.

Note: For Elastic Access, this field will be blank (represented with null value).

 
INCREMENTAL isIncremental

If set to True, a concurrent capability request is "incremental".

Note:  For Elastic Access this field will be blank (represented with null value)

 
OVERDRAFT_COUNT overdraftCount

The count by which the MAPPED_ENTITLED_COUNT may be exceeded for this METER. See METER for more information.

Value will be blank for unlimited overdraft and zero when no overdraft limit is set.

 
ENTITLED_ARTICLES entitledArticles

The articles that the line item entitles.

  • For Cloud License Servers/Local License Servers, this will be a JSON array of the names of the products in the line items.
  • For elastic access, this will be null.
 
ENTITLED_ARTICLE_VERSIONS entitledArticleVersions

The versions of the articles that the line item entitles.

  • For Cloud License Servers/Local License Servers, this will be a JSON array of the versions of the products in the line items.
  • For elastic access, this will be null.
  • The order of the elements will correspond to the order of ACTIVATION_ID and ENTITLED_ARTICLES.
 
BORROWED_UNTIL borrowedUntil

The time expressed as milliseconds since 1970-01-0, of the borrow expiration.

  • For Cloud License Servers/Local License Servers, this will be the expiration of the concurrent usage.
  • For metered usages, it will be blank (represented with null value).
 
SERVED_CLIENT_STATUS servedClientStatus

The served status of the Cloud License Server or Local License Server client associated with the usage. It can be NORMAL, RETURNED, EXPIRED or DROPPED.

It could be used as an indicator for marking the end of a "session" if it is either RETURNED or EXPIRED.

 

Data Access API Custom Attributes

If custom attributes have been configured for any of the above entities (and the option has been chosen to copy the custom attribute values to the Data Warehouse), then they will be reported in the relevant API.

Custom Attribute Description Example
Account Account custom attribute presented in the account API.

"OrgUnitCustomAttribute": {
    "NAME": "VALUE",
    "NAME": "VALUE"
}

Entitlement Entitlement custom attribute presented in the entitlement API/

"EntitlementCustomAttribute": {
    "NAME": "VALUE",
    "NAME": "VALUE"
}

License Model License model custom attribute presented in the entitlement API

LicenseModelCustomAttribute": {
    "NAME": "VALUE",
    "NAME": "VALUE"
}

License Model Predefined License model predefined custom attribute in the entitlement API.

"LicenseModelAttribute": {
    "NAME": "VALUE",
    "NAME": "VALUE"
}

Line Item Line item custom attribute presented in the entitlement API.

"LineItemCustomAttribute": {
    "NAME": "VALUE",
    "NAME": "VALUE"
}

Maintenance Line Item Maintenance line item custom attribute presented in the entitlement API.

MaintenanceLineItemCustomAttribute": {
    "NAME": "VALUE",
    "NAME": "VALUE"
}

User User custom attribute presented in the user API.

"UserCustomAttribute": {
    "NAME": "VALUE",
    "NAME": "VALUE"
}

Custom Attributes in Database

The following tables list the custom attributes in the database.

Account | Entitlement | Fulfillment | Line Item | License Model Attribute | License Model Custom Attribute | Maintenance Line Item | Product | User

Account

Field in Database Description Equivalent To
ID Unique identifier in the database.  
ORG_ID Unique identifier in the database of the account from the Account table.

Equivalent to:

  • ID in SEC_VW_ACCOUNT view
NAME Name of the custom attribute as defined in FlexNet Operations.  
VALUE

Value of the custom attribute.

 

DWH_LASTUPDATED_DATE

The last date that the record was refreshed in the data warehouse.

 

LASTMODIFIED

Last timestamp the custom attribute was updated.

 

REPORTING_ORDER

Order in which the custom attribute was defined in FlexNet Operations.

 

TYPE

Data type of the custom attribute defined in FlexNet Operations.

 

 

Entitlement

Field in Database Description Equivalent To
ID

Unique identifier in the database.

 

ENTITLEMENT_ID

Unique identifier in the database of the entitlement from the Entitlement table.

Equivalent to:

  • ENTITLEMENT_ID_ID in SEC_VW_ENTITLEMENT view
NAME

Name of the custom attribute as defined in FlexNet Operations.

 

VALUE

Value of the custom attribute.

 

DWH_LASTUPDATED_DATE

The last date that the record was refreshed in the data warehouse.

 

LASTMODIFIED

Last timestamp the custom attribute was updated.

 

REPORTING_ORDER

Order in which the custom attribute was defined in FlexNet Operations.

 

TYPE

Data type of the custom attribute defined in FlexNet Operations.

 

 

Fulfillment

Field in Database Description Equivalent To
ID

Unique identifier in the database.

 

FULFILLMENT_ID

Unique identifier in the database of the fulfillment from the Fulfillment table.

Equivalent to:

  •  ID in SEC_VW_ENTITLEMENT view
NAME

Name of the custom attribute as defined in FlexNet Operations.

 

VALUE

Value of the custom attribute.

 

DWH_LASTUPDATED_DATE

The last date that the record was refreshed in the data warehouse.

 

LASTMODIFIED

Last timestamp the custom attribute was updated.

 

REPORTING_ORDER

Order in which the custom attribute was defined in FlexNet Operations.

 

TYPE

Data type of the custom attribute defined in FlexNet Operations.

 

 

Line Item

Field in Database Description Equivalent To
ID

Unique identifier in the database.

 

ACTIVATION_ID

Unique identifier in the database of the Activation Id from the Entitlement table.

Equivalent to:

  • LINEITEM_ID_ID in SEC_VW_ENTITLEMENT view
NAME

Name of the custom attribute as defined in FlexNet Operations.

 

VALUE

Value of the custom attribute.

 

DWH_LASTUPDATED_DATE

The last date that the record was refreshed in the data warehouse.

 

LASTMODIFIED

Last timestamp the custom attribute was updated.

 

REPORTING_ORDER

Order in which the custom attribute was defined in FlexNet Operations.

 

TYPE

Data type of the custom attribute defined in FlexNet Operations.

 

 

License Model Attribute

Field in Database Description Equivalent To
ID

Unique identifier in the database.

 

LINE_ITEM_ID

Unique identifier in the database of the Activation Id from the Entitlement table.

Equivalent to:

  • LINEITEM_ID_ID in SEC_VW_ENTITLEMENT view
NAME

Name of the custom attribute as defined in FlexNet Operations.

 

VALUE

Value of the custom attribute.

 

DWH_LASTUPDATED_DATE

The last date that the record was refreshed in the data warehouse.

 

LASTMODIFIED

Last timestamp the custom attribute was updated.

 

REPORTING_ORDER

Order in which the custom attribute was defined in FlexNet Operations.

 

TYPE

Data type of the custom attribute defined in FlexNet Operations.

 

 

License Model Custom Attribute

Field in Database Description Equivalent To
ID

Unique identifier in the database.

 

LICENSE_MODEL_ID

Unique identifier in the database of the License Model from the Entitlement table.

Equivalent to:

  • LICENSEMODEL_ID_ID in SEC_VW_ENTITLEMENT view
NAME

Name of the custom attribute as defined in FlexNet Operations.

 

VALUE

Value of the custom attribute.

 

DWH_LASTUPDATED_DATE

The last date that the record was refreshed in the data warehouse.

 

LASTMODIFIED

Last timestamp the custom attribute was updated.

 

REPORTING_ORDER

Order in which the custom attribute was defined in FlexNet Operations.

 

TYPE

Data type of the custom attribute defined in FlexNet Operations.

 

 

Maintenance Line Item

Field in Database Description Equivalent To
ID

Unique identifier in the database.

 

ACTIVATION_ID

Unique identifier in the database of the Activation Id from the Entitlement table.

Equivalent to:

  • MAINT_ID_ID in SEC_VW_ENTITLEMENT view
NAME

Name of the custom attribute as defined in FlexNet Operations.

 

VALUE

Value of the custom attribute.

 

DWH_LASTUPDATED_DATE

The last date that the record was refreshed in the data warehouse.

 

LASTMODIFIED

Last timestamp the custom attribute was updated.

 

REPORTING_ORDER

Order in which the custom attribute was defined in FlexNet Operations.

 

TYPE

Data type of the custom attribute defined in FlexNet Operations.

 

 

Product

Field in Database Description Equivalent To
ID

Unique identifier in the database.

 

PRODUCT_ID

Unique identifier in the database of the Activation Id from the Entitlement table.

Equivalent to:

  • PRODUCT_ID in SEC_VW_ENTITLEMENT view
NAME

Name of the custom attribute as defined in FlexNet Operations.

 

VALUE

Value of the custom attribute.

 

DWH_LASTUPDATED_DATE

The last date that the record was refreshed in the data warehouse.

 

LASTMODIFIED

Last timestamp the custom attribute was updated.

 

REPORTING_ORDER

Order in which the custom attribute was defined in FlexNet Operations.

 

TYPE

Data type of the custom attribute defined in FlexNet Operations.

 

 

User

Field in Database Description Equivalent To
ID

Unique identifier in the database.

 

USER_ID

Unique identifier in the database of the User Id from the User table.

Equivalent to:

  • ID in SEC_VW_USER view
NAME

Name of the custom attribute as defined in FlexNet Operations.

 

VALUE

Value of the custom attribute.

 

DWH_LASTUPDATED_DATE

The last date that the record was refreshed in the data warehouse.

 

LASTMODIFIED

Last timestamp the custom attribute was updated.

 

REPORTING_ORDER

Order in which the custom attribute was defined in FlexNet Operations.

 

TYPE

Data type of the custom attribute defined in FlexNet Operations.

 

Revision Date: 13 January 2025