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 Data Set
- Device Data Set
- Served Device Data Set
- Entitlement Data Set
- Entitlement History Data Set
- Line Item History Data Set
- Fulfillment Data Set
- Product Feature Data Set
- User Data Set
- Downloads Data Set
- Files Data Set
- Usage Data Set
- Feature Data Set
- License Model Set
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:
|
| 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:
|
| DESCRIPTION | AccountDescription | The description associated with the account. | |
| ACCOUNT_TYPE | AccountType | Identifies an account as one of the following types:
| |
| 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:
| |
| 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:
|
| ACCOUNT_CREATED_BY | AccountCreatedBy | Identifies the user who created the account. | |
| ACCOUNT_UPDATED_BY | AccountUpdatedBy | Identifies the user who updated the account. | |
| ACCOUNT_HIERARCHY_CREATED_BY | AccountHierarchyCreatedBy | Identifies the user who created the account hierarchy. | |
| ACCOUNT_HIERARCHY_UPDATED_BY | AccountHierarchyUpdatedBy | Identifies the user who updated the account hierarchy. |
The following fields are in the device report:
| 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:
|
| MACHINE_TYPE | DeviceMachineType | A 64-character machine type. This field may be empty. Possible values:
| |
| 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:
| |
| HOST_TYPE | Type | Identifies the device type as one of the following:
| |
| 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:
| |
| 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. | |
| 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_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:
|
| 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:
| |
| 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:
|
| REQUESTED_COUNT_DELTA | QtyOnDevice | The count of a license item mapped to the device. | |
| EVENT_DATE | 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:
|
| 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:
|
| 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:
|
| PART_NUMBER | PartNumber | The part number of the product entitled by the line item mapped to the device. | Equivalent to:
|
| 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:
| |
| EXPIRATION_DATE | ExpirationDate | The expiration date of the license mapped to the device. | Equivalent to:
|
| LICENSEMODEL1 | LicenseModel1 | The license model for the primary activation on the device at the time of this event. | Equivalent to:
|
| 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:
|
| ACTIVATION_DELETED | ActivationDeleted | List of activations that were deleted. | Also referred to in:
|
| ACCOUNT_DELETED | AccountDeleted | List of accounts that were deleted. | Also referred to in:
|
| USER_DELETED | UserDeleted | List of users that were deleted. | Also referred to in:
|
| ORDER_ID | OrderID | The value entered in FlexNet Operations while configuring the entitlement line items. Note: This ID may be imported from your CRM/ERP application. | Also referred to in:
|
| LINE_ITEM_START_DATE | StartDate | Start date of the line item. | Also referred to in:
|
| DEVICE_CREATED_BY | DeviceCreatedBy | Identifies the user who created the device. | |
| DEVICE_UPDATED_BY | DeviceUpdatedBy | Identifies the user who updated the device. | |
| ADDON_CREATED_BY | AddOnCreatedBy | Identifies the user who first mapped line item to the device. | |
| ADDON_UPDATED_BY | AddOnUpdatedBy | Identifies the user who updated the mapped line item to the device. |
The following fields are in the served-device report:
| 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_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:
| |
| SERVED_STATUS | Status | The status of the served device. A served device status can be one of the following:
| |
| 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_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:
|
| 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 requested by the served device from the license server. Note: A feature is uniquely identified by its name and version. | Equivalent to:
|
| VERSION | FeatureVersion | The version of the feature requested by the served device from the license server. Note: A feature is uniquely identified by its name and version. | Equivalent to:
|
| FEATURE_COUNT | Quantity | The quantity of the feature requested by the served device from the license server. | |
| OVERAGE | Overage | 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:
|
| USER_DELETED | UserDeleted | List of users that were deleted. | Also referred to in:
|
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:
|
| 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:
| |
| 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:
|
| 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:
| |
| START_DATE | StartDate | Start date of the line item. | |
| EXPIRATION_DATE | EndDate | Expiration date of the line item. | Equivalent to:
|
| 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:
| |
| DURATION_UNITS | EndDurationUnits | If IsActivationPermanent is set to EXPIRING, specify the end duration units as one of the following:
| |
| 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:
|
| 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:
| |
| 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:
|
| PRODUCT_TYPE | ProductType | Identifies the product type:
| |
| 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:
|
| 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:
| |
| PART_NUMBER | PartNumber | The part number of the product entitled by the line item. | Equivalent to:
|
| LICENSEMODEL | LicenseModel | The license model used for the Line Item. | Equivalent to:
|
| REMAINING_COPIES | RemainingCopies | The number from lineItemQuantity not yet 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:
|
| 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:
|
| 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 associated with this line item. | |
| MAINTENANCE_PRODUCT | Maintenance.Maintenance_ProductName | The product name of Maintenance, if associated with this line item. | |
| MAINTENANCE_PART_NUMBER | Maintenance.Maintenance_PartNumber | The part number of Maintenance, if associated with this line item. | |
| MAINTENANCE_START_DATE | Maintenance.Maintenance_StartDate | The date on which Maintenance begins, if associated with this line item. | |
| MAINTENANCE_END_DATE | Maintenance.Maintenance_EndDate | The date on which Maintenance ends, if associated with this line item. | |
| MAINTENANCE_ORDER_LINE_NUMBER | Maintenance.Maintenance_OrderLineNumber | The order line number of Maintenance, if associated with this line item. | |
| MAINTENANCE_ORDER_ID | Maintenance.Maintenance_OrderID | The order ID of Maintenance, if associated with this line item. | |
| MAINTENANCE_PRODUCT_VERSION | Maintenance.Maintenance_ProductVersion | The product version of Maintenance, if associated with this line item. | |
| LINEITEM_ACTIVATION_ID | Maintenance.Maintenance_Link_LineItemActivationID | The line item activation ID link of Maintenance, if 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:
|
| PRODUCT_DELETED | ProductDeleted | List of products that were deleted. | Also referred to in:
|
| ACTIVATABLE_ITEM_OWNERS | ActivatableItemOwners | Identifies users who self-register by logging in to the End-User Portal with an activation ID and set up their own user account. | |
| ENTITLEMENT_DESCRIPTION | EntitlementDescription | A brief, optional description of the entitlement as defined in FlexNet Operations. | |
| ENTITLEMENT_CREATED_BY | EntitlementCreatedBy | User who created the entitlement. | |
| ENTITLEMENT_UPDATED_BY | EntitlementUpdatedBy | User who updated the entitlement. | |
| LINEITEM_CREATED_BY | LineItemCreatedBy | User who created the line item. | |
| LINEITEM_UPDATED_BY | LineItemUpdatedBy | User who updated the line item. | |
| MAINTENANCE_LINEITEM_CREATED_BY | MaintenanceLineItemCreatedBy | User who created the maintenance line item. | |
| MAINTENANCE_LINEITEM_UPDATED_BY | MaintenanceLineItemUpdatedBy | User who updated the maintenance line item. | |
| PRODUCT_CREATED_BY | ProductCreatedBy | Identifies the user who created the product. | |
| PRODUCT_UPDATED_BY | ProductUpdatedBy | Identifies the user who updated the product. | |
| ENTITLEMENT_DELETED | EntitlementDeleted | Specifies if an entitlement has been deleted. | Also referred to in:
|
The following fields are in the entitlement-history report:
| Field in Database | Field in DAPI | Description | Equivalent To |
|---|---|---|---|
| ENTITLEMENT_UNIQUE_ID | EntitlementUniqueID | A unique identifier of the entitlement record. | |
| LASTMODIFIED_DATE | LastModifiedDate | ||
| ENTITLEMENT_ID | EntitlementID | A unique identifier of the active entitlement record as defined in FlexNet Operations. | Equivalent to:
|
| ENTITLEMENT_TYPE | EntitlementType | Identifies if an entitlement is Simple or Bulk. | |
| ENTITLEMENT_DESCRIPTION | EntitlementDescription | A brief, optional description of the entitlement. | Equivalent to:
|
| SHIP_TO_EMAIL | ShipToEmail | Email address that FlexNet Operations sends the license to. | Equivalent to:
|
| SHIP_TO_ADDRESS | ShipToAddress | Postal address that FlexNet Operations sends the license to. | Equivalent to:
|
| ENTITLEMENT_STATUS | EntitlementStatus | 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. | Equivalent to:
|
| ENTITLEMENT_CREATED_BY | EntitlementCreatedBy | User who created the entitlement. | Equivalent to:
|
| ENTITLEMENT_UPDATED_BY | EntitlementUpdatedBy | User who updated the entitlement. | Equivalent to:
|
| ENDCUSTOMER_ACCOUNT_ID | 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:
|
| EMAIL_TEMPLATE_VARIATION | EmailTemplateVariation | (Optional) Specify an email template.
| Equivalent to:
|
| ENTITLEMENT_CREATED_ON | EntitlementCreatedOn | The date on which the entitlement was created. | Equivalent to:
|
| ENTITLEMENT_UPDATED_ON | EntitlementUpdatedOn | The date on which the entitlement was updated. | |
| 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. | Equivalent to:
|
| CHANNEL_PARTNERS | ChannelPartners | The account IDs for the Partner Tier accounts that own the entitlement in JSON format. | |
| CUSTOM_ENTITLEMENT_ATTRIBUTES | CustomEntitlementAttributes | List of Entitlement custom attributes in JSON format. | |
| LASTMODIFIED_DATE | LastModifiedDate | The date and time when the entitlement was last modified. | Equivalent to:
|
| OPERATION_TYPE | OperationType | Identifies the type of event: CREATE, UPDATE, DELETE. | |
| CURRENTOWNER | CurrentOwner | The account or partner that the entitlement is owned by at the time of this update. | |
| DWH_LASTUPDATED_DATE | DWH_LASTUPDATED_DATE | The last date that the record was refreshed in the data warehouse. | Equivalent to:
|
| BULK_ORDERABLES | BulkOrderables | List of Products associated with Bulk Entitlement in JSON format. |
The following fields are in the line-item-history report:
| Field in Database | Field in DAPI | Description | Equivalent |
|---|---|---|---|
| ENTILEMENT_UNIQUE_ID | EntitlementUniqueID | A unique identifier of the entitlement record. | |
| LASTMODIFIED_DATE | LastModifiedDate | The date and time when the line item was last modified. | |
| ENTITLEMENT_ID | EntitlementID | A unique identifier of the active entitlement record as defined in FlexNet Operations. | Equivalent to:
|
| OPERATION_TYPE | OperationType | Identifies the type of event:
| |
| ENTITLEMENT_DESCRIPTION | EntitlementDescription | A brief, optional description of the entitlement. | Equivalent to:
|
| SHIP_TO_EMAIL | ShipToEmail | Email address that FlexNet Operations sends the license to. | Equivalent to:
|
| SHIP_TO_ADDRESS | ShipToAddress | Postal address that FlexNet Operations sends the license to. | Equivalent to:
|
| ENTITLEMENT_STATUS | EntitlementStatus | 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. | Equivalent to:
|
| LINEITEM_CREATED_BY | LineItemCreatedBy | User who created the line item. | Equivalent to:
|
| LINEITEM_UPDATED_BY | LineItemUpdatedBy | User who updated the line item. | Equivalent to:
|
| ENDCUSTOMER_ACCOUNT_ID | 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:
|
| EMAIL_TEMPLATE_VARIATION | EmailTemplateVariation | (Optional) Specify an email template:
| Equivalent to:
|
| LINEITEM_CREATED_ON | LineItemCreatedOn | The date on which the line item was created. | Equivalent to:
|
| LINEITEM_UPDATED_ON | LineItemUpdatedOn | The date on which the line item was updated. | |
| 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. | Equivalent to:
|
| CHANNEL_PARTNERS | ChannelPartners | The account IDs for the Partner Tier accounts that own the entitlement in JSON format. | |
| MAINTENANCE_ACTIVATION_ID | MaintenanceActivationID | The list of activation IDs of Maintenance, if associated with this line item in JSON form. | |
| ACTIVATION_ID | ActivationID | The unique identifier of the entitlement line item as defined in FlexNet Operations. | Equivalent to:
|
| LINEITEM_DESCRIPTION | LineItemDescription | A free-form description added to the line item. | Equivalent to:
|
| LICENSEMODEL1 LICENSEMODEL2 LICENSEMODEL3 | LicenseModel1 LicenseModel2 LicenseModel3 | For FlexNet licensing technologies, an entitlement line item can contain, at most, 1 certificate, 1 trusted storage, and 1 embedded license model. The same line item can be activated using a certificate license, trusted storage activation request, or embedded activation request. These capture the different license models if associated with entitlement line item. | Equivalent to:
|
| PARENT_LINE_ITEM_ID | ParentLineItemID | The original order that this order originated from. | Equivalent to:
|
| LINEITEM_STATE | LineItemState | A line item is created in a DRAFT, TEST, or DEPLOYED state. Once a line item is no longer required, it can be made INACTIVE or OBSOLETE. | Equivalent to:
|
| ORDER_ID | OrderID | Order ID. NOTE: This may be imported from your ERP/CRM application. | Equivalent to:
|
| ORDER_LINE_NUMBER | OrderLineNumber | Order line number. NOTE: This may be imported from your ERP/CRM application. | Equivalent to:
|
| LINEITEM_UNIQUE_ID | LineItemUniqueID | A unique identifier of the entitlement line item record. | |
| MAINTENANCE_END_DATE | MaintenanceEndDate | The date on which Maintenance ends, if associated with this line item. | Equivalent to:
|
| PRODUCTS | Products | List of Products associated with Entitlement Line item in JSON form. | |
| FEATURES | Features | List of Features associated with Entitlement Line item in JSON form. | |
| LICENSEMODEL_ATTRIBUTES | LicenseModelAttributes | List of license model attributes defined in Entitlement Line item in JSON form. | |
| START_DATE | StartDate | Start date of the line item. | Equivalent to:
|
| EXPIRATION_DATE | ExpirationDate | Expiration date of the line item. | Equivalent to:
|
| VERSION_DATE | VersionDate | Epoch timestamp of the Feature VERSION_DATE defined during the creation of line item. | Equivalent to: entitlement: VersionDate |
| SEAT_COUNT | SeatCount | The quantity of the product entitled by the line item. | Equivalent to:
|
| AVAILABLE_COUNT | AvailableCount | The number from the value given in lineItemQuantity that have not yet been mapped to a device or license server. | Equivalent to:
|
| IS_ACTIVATION_PERMANENT | IsActivationPermanent | Indicates whether the activation ID or line item is permanent or will expire by specifying one of the following:
| Equivalent to:
|
| ORDER_TYPE | OrderType | Possible Order Types:
| Equivalent to:
|
| CUSTOM_ENTITLEMENT_LINEITEM_ATTRIBUTES | CustomEntitlementLineItemAttributes | List of Entitlement line item custom attributes in JSON form. | |
| CUSTOM_ENTITLEMENT_ATTRIBUTES | CustomEntitlementAttributes | List of Entitlement custom attributes in JSON form. | |
| CURRENTOWNER | CurrentOwner | The account or partner that the entitlement is owned by at the time of this update. | Equivalent to:
|
| DWH_LASTUPDATED_DATE | DWH_LASTUPDATED_DATE | The last date that the record was refreshed in the data warehouse. | Equivalent to:
|
The following fields are in the fulfillment report:
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:
| |
| 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. | device: ActivationID entitlement: ActivationID usage: activationId |
| ACTIVATION_TYPE | ActivationType | The method of activation, which is one of the following:
| |
| START_DATE | FulfillmentDate | Date fulfillment record was created. | |
| EXPIRATION_DATE | ExpirationDate | Date fulfillment record expires. Equivalent to:
| |
| OVERDRAFT_COUNT | OverdraftCount | Specifies the number of users that can run a software package during peak usage times, even after the 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:
| |
| LIFECYCLE_STATUS | LifeCycleStatus | ||
| HOST_ID | HostEntityID | The host on which the license was activated:
| |
| 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 (true if yes). | |
| IS_NODELOCKED_TYPE | IsNodelocked | Whether this fulfillment is locked to a single device (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. | 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. | device: ProductName entitlement: ProductName product-feature: ProductName |
| PART_NUMBER | PartNumber | The part number to which the fulfillment is linked, if any. | device: PartNumber entitlement: PartNumber |
| ACCOUNT_ID | AccountID | A unique identifier of an organization’s account as defined in FlexNet Operations (e.g., Stark International Enterprises). | 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 (e.g., Stark). | 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:
| |
| ACTIVATION_DELETED | ActivationDeleted | List of activations that were deleted. Also referred to in:
| |
| ACCOUNT_DELETED | AccountDeleted | List of accounts that were deleted. Also referred to in:
| |
| USER_DELETED | UserDeleted | List of users that were deleted. Also referred to in:
| |
| FULFILLMENT_CREATED_BY | FulfillmentCreatedBy | Identifies the user who created the fulfillment. | |
| FULFILLMENT_UPDATED_BY | FulfillmentUpdatedBy | Identifies the user who updated the fulfillment. |
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:
|
| PRODUCT_VERSION | ProductVersion | Version of product feature is associated with. | |
| SKU_ID | q_sku_id | The unique identifier of the Part Number as defined in FlexNet Operations. | |
| SKU_NAME | SkuName | Name of the Part Number defined in FlexNet Operations. | Equivalent to:
|
| SKU_DESCRIPTION | SkuDescription | Description of the Part Number. | |
| SKU_TRIAL_AVAILABLE | SkuTrialAvailable | Whether the Part Number is available for trial or not. | |
| SKU_LICENSE_MODEL | SkuLicenseModel | 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.
| |
| FEATURE_COUNTED | FeatureCounted | Counts the number of seats deployed to customers.
| |
| 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.
| |
| 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:
|
| PRODUCT_FEATURE_DELETED | ProductFeatureDeleted | Indicates the status of the feature in relation to the product:
| |
| PRODUCT_CREATED_BY | ProductCreatedBy | Identifies the user who created the product. | |
| PRODUCT_UPDATED_BY | ProductUpdatedBy | Identifies the user who updated the product. | |
| FEATURE_CREATED_BY | FeatureCreatedBy | Identifies the user who created the feature. | |
| FEATURE_UPDATED_BY | FeatureUpdatedBy | Identifies the user who updated the feature. | |
| FEATUREBUNDLE_NAME | FeatureBundleName | The name of the feature bundle. | |
| FEATUREBUNDLE_DESCRIPTION | FeatureBundleDescription | The description of the feature bundle. | |
| BUNDLE_FEATURE_RELATION_FEATURE_ID | BundleFeatureRelationFeatureID | The feature ID of the feature that is included in the bundle. | |
| BUNDLE_FEATURE_DELETED | BundleFeatureDeleted | Indicates the relationship between the feature and the bundle:
| |
| PRODUCT_TYPE | ProductType | Indicates whether the item is a Suite or a Product. | |
| SUITE_PRODUCT_DELETED | SuiteProductDeleted | Specifies if a product has been removed from a suite. | |
| ENTITLEMENT_DELETED | EntitlementDeleted | Specifies if an entitlement has been deleted. | Also referred to in:
|
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. | |
| 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:
| |
| 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_NAME | AccountName | The name of the account to which the user belongs. This is the same value as AccountID in the account entity. | Equivalent to:
|
| 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:
| |
| 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:
|
| USER_CREATED_BY | UserCreatedBy | Identifies the user who created the user. | |
| USER_UPDATED_BY | UserUpdatedBy | Identifies the user who updated the user. |
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 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 reattempts. | |
| 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 reattempts. | |
| 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:
|
| CONTACT_ACCOUNT_DISPLAY_NAME | AccountName | Display name of an account or organization as defined in FlexNet Operations. (For example, Stark International Enterprises.) | Equivalent to:
|
| CONTACT_COUNTRY | UserCountry | User’s country as recorded in the FlexNet Operations. | Equivalent to:
|
| CONTACT_FIRST_NAME | UserFirstName | User's first name as recorded in the FlexNet Operations. | Equivalent to:
|
| CONTACT_LAST_NAME | UserLastName | User’s last name as recorded in the FlexNet Operations. | Equivalent to:
|
| CONTACT_EMAIL_ADDRESS | UserEmailAddress | User’s email address as recorded in the FlexNet Operations. | Equivalent to:
|
| CONTACT_ADDRESS | UserAddress | User’s address(street name and city) as recorded in the FlexNet Operations. | Equivalent to:
|
| CONTACT_CREATED_DATE | UserCreateDate | The date and time at which the user was created in the FlexNet Operations system. | Equivalent to:
|
| 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:
|
| FILE_NAME | FileName | Your company's unique identifier for this file. This is the File ID File ID in FlexNet Operations. | Equivalent to:
|
| 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_CREATE_USER_EMAIL | FileCreatedUserEmail | Email address of the user who created the file in the FlexNet Operations. | Equivalent to:
|
| FILE_CREATE_DATE | FileCreatedDate | Timestamp when the file was first created and stored. | Equivalent to:
|
| 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_SIZE | FileSizeInBytes | Exact number of bytes used to store a file’s data. | Equivalent to:
|
| N/A | FileSizeInKbytes | The size of the file in Kilobytes (KBs). | Equivalent to:
|
| N/A | FileSizeInMbytes | Size of the file in Megabytes (MBs). | Equivalent to:
|
| N/A | FileSizeInGbytes | Size of the file in Gigabytes (GBs). | Equivalent to:
|
| 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. | |
| DOWNLOAD_ATTEMPT_START_DATETIME | DownloadAttemptStartDatetime | Start date and time of the download attempt. | |
| DOWNLOAD_ATTEMPT_END_DATETIME | DownloadAttemptEndDatetime | End date and time of download attempt. | |
| DOWNLOAD_ATTEMPT_REQUESTED_BYTES | DownloadAttemptRequestedBytes | Number of bytes that were intended to be downloaded during a specific download attempt. | |
| DOWNLOAD_ATTEMPT_DOWNLOADED_BYTES | DownloadAttemptDownloadedBytes | Number of bytes that were successfully downloaded. If DownloadAttemptRequestedBytes = DownloadAttemptDownloadedBytes, then the download was successful. |
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_SIZE | FileSizeInBytes | The size of the file in bytes. | Equivalent to:
|
| N/A | FileSizeInKilobytes | The size of the file in KBs. | Equivalent to:
|
| N/A | FileSizeInMegabytes | The size of the file in MBs. | Equivalent to:
|
| N/A | FileSizeInGigabytes | The size of the file in GBs. | Equivalent to:
|
| 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_LAST_UPLOADED_DATE | FileLastUploadedDate | The timestamp when the file was most recently uploaded and stored. | Equivalent to:
|
| FILE_CREATE_DATE | FileCreatedDate | The timestamp when the file was first created and stored. | Equivalent to:
|
| FILE_CREATE_USER_EMAIL | FileCreatedUserEmail | The user email address of the individual who created the file in FlexNet Operations. | Equivalent to:
|
| FILE_LAST_UPDATE_USER_EMAIL | FileLastUpdatedUserEmail | The email address of the individual who last modified or updated the file in FlexNet Operations. |
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 Dynamic Monetization Instance/Cloud License Server/Local License Server instance this charge was made to. | |
| USAGE_TIME | usageTime | The time the usage occurred in the Dynamic Monetization Instance 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 Dynamic Monetization Instance/Cloud License Server/Local License Server instance
| Equivalent to:
|
| INSTANCE_ID | instanceId | The instance of Dynamic Monetization Instance, 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"].
| Equivalent to:
|
| MAPPED_ENTITLED_COUNT | mappedEntitledCount | The count from the line item mapped to this instance.
| |
| USED | used | The total number from the mapped line item quantity currently being used across all item requests.
| |
| 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
| |
| 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.
| |
| METER_COST | meterCost | For "elastic" meter type, the rate read from the rate table.
| |
| METER_QUANTITY | meterQuantity | The number used from the mapped line item count by the transaction given in this row
| |
| 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.
| |
| ENTITLED_ARTICLE_VERSIONS | entitledArticleVersions | The versions of the articles that the line item entitles.
| |
| BORROWED_UNTIL | usageExpiry | The time expressed as milliseconds since 1970-01-0, of the borrow expiration.
| |
| 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. | |
| SITE_NAME | siteName | Name of site where license usage is occurring. | |
| DESCRIPTION | description | Description of site where license usage is occurring. | |
| SECOND_CONSUMER_ID | secondConsumerID | Secondary ID for the user. | |
| SECOND_CONSUMER_TYPE | secondConsumerType | Secondary ID Type for the user. |
The following fields are in the feature report:
| Field in Database | Field In DAPI | Description |
|---|---|---|
| AGGREGATION_TYPE | AggregationType | Feature counts can be aggregated by one of the following values:
|
| COUNTED | Counted | Counts the number of features deployed to customers.
|
| CREATE_DATE | CreateDate | The date and time at which the feature was created in the FlexNet Operations system. |
| CREATED_BY | CreatedBy | Identifies the user who created the feature. |
| DESCRIPTION | Description | Description of the feature. |
| ID | ID | ID of the feature. |
| LAST_MODIFIED | LastModified | Last modified date of the feature. |
| NAME | Name | Name of the feature. |
| REF_ID | RefID | Unique reference identifier for each feature record |
| SCALE | Scale | 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 Scale will achieve this. NOTE: Units (below) and Scale work together to describe what the metered feature is counting. |
| STATUS | Status | A feature can be in one of two states: DRAFT or DEPLOYED.
|
| UNITS | Units | 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. NOTE:
|
| UPDATED_BY | UpdatedBy | Identifies the user who updated the feature. |
| VERSION | Version | Version of the feature. |
| VERSION_FORMAT | VersionFormat | Feature Version Format is either FIXED or DATE BASED.
|
The following fields are in the license-model report:
| Field in Database | Field in DAPI | Description |
|---|---|---|
| ID | ID | ID of license model. |
| NAME | Name | Name of license model. |
| TYPE | Type | Type of license model as one of the following:
|
| DESCRIPTION | Description | Description of license model. |
| LICENSE_TECHNOLOGY | LicenseTechnology | License technology associated with the model. Values could be either FlexNet Licensing FlexNet Licensing or a custom value. |
| LICENSE_TYPE | LicenseType | Type of license, could be FEATURE or INCREMENT |
| DURATION_UNITS | DurationUnits | Specify the end duration units as one of the following:
|
| STATUS | Status | Status of the license model that identifies the status as one of the following:
|
| DURATION | Duration | Specify number of days, weeks, months, or years in which the licenses will expire, according to the DurationUnits DurationUnits specified. |
| COUNTED | Counted | Indicates whether the number of seats deployed to customers are counted. |
| CREATED_BY | CreatedBy | User who created this license model. |
| LAST_MODIFIED_DATE | LastModifiedDate | Last date that this license model has been modified. |
| UPDATED_BY | UpdatedBy | User who last updated this license model. |