Data Access API Entity Relationship Diagram and Field Descriptions

This topic details the data that is returned by the FlexNet Operations Data Access API. 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.

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

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

account

The following fields are in the account report:

Field Description Equivalant To
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

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

AccountDescription The description associated with the account.  
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.

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

The state of the account as one of the following:

  • ACTIVE
  • INACTIVE
 
Visible

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

 
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.  

device

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

Field Description Equivalant To
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

DeviceMachineType

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

  • PHYSICAL
  • VIRTUAL
  • UNKNOWN

This field may be empty.

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

The status of the device:

  • ACTIVE
  • OBSOLETE
  • RETURNED
 
Type

Identifies the device type as one of the following:

  • CLIENT— Standalone devices (including anonymous devices).
  • SERVER—FlexNet Embedded Local License Server or Cloud License Server.
 
VMName A 64-character VM name for the device. VMName is null if MACHINE_TYPE is not VIRTUAL. This field may be empty.  
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
 
BackupDeviceID The ID of the backup device.  
PublisherName A 64-character producer name.  
DeviceSeries A way of categorizing devices. A Device Series is a collection of device models that are physically identical  
Notes Extra information about a device provided by the producer.  
DeviceUserEmail The email address of the device user associated with the device.  
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

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

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
 
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.  
CreateDate The date the device was created.  
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.  
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

QtyOnDevice The count of a license item mapped to the device.  
DeviceAddOnEventDateAndTime The date and time that an add-on was mapped to the device.  
LicenseStatus The status of the license mapped to the device. For example, License not generated or License generated.  
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
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

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.

 
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.  
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 
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
PartNumber The part number of the product entitled by the line item mapped to the device.

Equivalent to:

  • entitlement: ProductVersion
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 ite 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.

 
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

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

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

 
LicenseModel3

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

 

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 Description Equivalant To
ServedClientHostID The ID of the served device. This ID is always of type SERVED-DEVICE.  
ServerHostID The ID of the server that the device requests licenses from.

Equivalent to:

  • device: DeviceID
DeviceAlias A short, alternate name for the device.  
SiteName Site name used for additional information purposes only.  
Notes Extra information about a device provided by the producer.  
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.

 
Status

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

  • NORMAL
  • EXPIRED
  • DROPPED
 
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
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
LastSyncTime

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

 
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
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
Quantity The quantity of the feature request by the served device from the license server.  
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 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.  
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.

 

entitlement

The following fields are in the entitlement report:

Field Description Equivalant To
EntitlementID

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

Equivalent to:

  • device: EntitlementID
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.

 
EntitlementDescription A brief, optional description of the entitlement.  
AllowPortalLogin If Yes is specified, the end customer can use the entitlement ID or activation ID to log into the End-User Portal.  
ShipToEmail Email address that FlexNet Operations sends the license to.  
Address Postal address that FlexNet Operations sends the license to.  
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 The account or partner that the entitlement is owned by at the time of this update.  
ActivationID The unique identifier of the entitlement line item as defined in FlexNet Operations.

Equivalent to:

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

The quantity of the product entitled by the line item.

 
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.  
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.  
OrderLineNumber

Order line number.

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

 
OrderID

Order ID.

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

 
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.
 
StartDate Start date of the line item  
EndDate

Expiration date of the line item.

Equivalent to:

  • device: ExpirationDate
  • fulfillment: ExpirationDate
IsActivationPermanent

Indicates whether the license model 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 ite 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.
 
EndDurationUnits

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

  • DAYS
  • WEEKS
  • MONTHS
  • YEARS
 
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

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

 
OrderType

Possible Order Types are:

  • UPSELL
  • UPGRADE
  • RENEWAL
  • NEW
 
OrderParent The original order that this order originated from.  
LineItemDescription A free-form description added to the line item.  
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
ProductType

Identifies the product type as one of the following:

  • PRODUCT
  • SUITE
  • MAINTENANCE
 
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
ProductCount The number of instances of the product entitled by this line item.  
PartNumber The part number of the product entitled by the line item.

Equivalent to:

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

Equivalent to:

  • device: LicenseModel1, LicenseModel2, LicenseModel3
  • fulfillment: LicenseModel
RemainingCopies The number from the value given in lineItemQuantity that have not yet been mapped to a device or license server.  
CreatedOn The date on which the line item was created.  
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
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
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.

 
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.

 
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.

 
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.

 
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.

 
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.

 
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.

 
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.

 
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.

 
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.

 
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.

 
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.

 

LicenseModelAttributes.LM_Embedded_Counted_NOTICE

LicenseModelAttributes.LM_Embedded_Counted_SERIAL_NUMBER

LicenseModelAttributes.LM_Embedded_Counted_VENDOR_STRING

These describe the attributes set in the Embedded Counted license model.  

LicenseModelAttributes.LM_Embedded_Uncounted_NOTICE

LicenseModelAttributes.LM_Embedded_Uncounted_SERIAL_NUMBER

LicenseModelAttributes.LM_Embedded_Uncounted_VENDOR_STRING

These describe the attributes set in the Embedded Uncounted license model.

 

LicenseModelAttributes.LM_Floating_Counted_NOTICE

LicenseModelAttributes.LM_Floating_Counted_SERIAL_NUMBER

These describe the attributes set in the Floating Counted license model.  

LicenseModelAttributes.LM_Nodelocked_Uncounted_SERIAL_NUMBER

LicenseModelAttributes.LM_Nodelocked_Uncounted_NOTICE

These describe the attributes set in the Nodelocked Uncounted license model.  

LicenseModelAttributes.LM_Nodelocked_Counted_SERIAL_NUMBER

LicenseModelAttributes.LM_Nodelocked_Counted_NOTICE

These describe the attributes set in the Nodelocked Counted license model.  

LicenseModelAttributes.LM_Floating_Uncounted_NOTICE

LicenseModelAttributes.LM_Floating_Uncounted_SERIAL_NUMBER

These describe the attributes set in the Floating Uncounted license model.  
LastModifiedDate The date and time when the line item was last modified.  
Maintenance.Maintenance_ActivationID

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

 
Maintenance.Maintenance_ProductName

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

 
Maintenance.Maintenance_PartNumber

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

 
Maintenance.Maintenance_StartDate

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

 
Maintenance.Maintenance_EndDate

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

 

 
Maintenance.Maintenance_OrderLineNumber

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

 
Maintenance.Maintenance_OrderID

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

 
Maintenance.Maintenance_ProductVersion

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

 
Maintenance.Maintenance_Link_LineItemActivationID

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

 

fulfillment

The following fields are in the fulfillment report:

Note: This API only applies to FlexNet Publisher fulfillments.

Field Description Equivalant To
FulfillmentID A unique identifier for the fulfillment record.  
Status

The state of the line item:

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

Equivalent to:

  • device: ActivationID
  • entitlement: ActivationID
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.
 
FulfillmentDate Date fulfillment record was created.  
ExpirationDate Date fulfillment record expires.

Equivalent to:

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

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

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.  
ShipToEmail

Email address that FlexNet Operations sends the license to.

 
CreatedBy

User who created the fulfillment.

 
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.
 
LifeCycleStatus    
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.

 
HostUserID    
IsServer Whether this fulfillment is used on a License Server.  
Redundant    
Trusted Whether this fulfillment record is for Trusted Storage, which would result in the value true.  
IsNodelocked Whether this fulfillment is locked to a single device (which would show TRUE), or provisioned on a license server for concurrent licensing.  
IsCustom    
FulfillmentCount The count from the line item that this fulfillment record consumes.  
LastModifiedDate The date and time that this fulfillment record was last modified.  
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
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 
PartNumber The part number to which the fulfillment is linked, if any.

Equivalent to:

  • device: PartNumber
  • entitlement: PartNumber
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

 

 

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

user

The following fields are in the user report:

Field Description Equivalant To
FirstName

User's first name.

 
LastName

User’s last name.

 
DisplayName

Display name for the user.

 
EmailAddress

User’s email address.

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

The status of the User. Possible values are:

  • ACTIVE
  • INACTIVE
 
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
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

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.

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

User’s street address.

 
City

User’s city.

 
State

User’s state.

 
ZipCode

Users' zip code.

 
Country

User’s country.

 
TimeZone

User’s time zone.

 
Locale The locale setting for the user.  
PhoneNumber

User’s phone number.

 
FaxNumber

User’s fax number.

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

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

 
LastUpdatedDate The date and time at which the user’s details were last updated.  
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.

 
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.

 
Type

The type of the user. Possible values are:

  • PRODUCER
  • CUSTOMER
  • PARTNER
  • SELF-REGISTERED
 

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 Description Equivalant To
ProductName Name of product feature is associated with.

Equivalent to:

  • entitlement: ProductName
  • fulfillment: ProductName
  • device: ProductName
ProductVersion Version of product feature is associated with.  
FeatureName Name of feature.  
FeatureVersion Version of feature.  
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.

 
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.
 
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.
 
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.

 
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.

 
FeatureDescription Description of feature.  
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.

 
FeatureCreateDate Date and time feature was created.  
FeatureLastModified Date and time feature was last updated.  

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 in the form of:

ca[prefix|key] : value

The prefix can take one of the following values:

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

"ca[acct|someCustomAttributeKey]": "someCustomAttributeValue"

ent Entitlement custom attribute presented in the entitlement API/

"ca[ent|someCustomAttributeKey]": "someCustomAttributeValue"

line Line item custom attribute presented in the entitlement API.

"ca[line|someCustomAttributeKey]": "someCustomAttributeValue"

lm License model custom attribute presented in the entitlement API

"ca[lm|someCustomAttributeKey]": "someCustomAttributeValue"

maint_line Maintenance line item custom attribute presented in the entitlement API.

"ca[maint_line|someCustomAttributeKey]": "someCustomAttributeValue"

user User custom attribute presented in the user API.

"ca[user|someCustomAttributeKey]": "someCustomAttributeValue"