CSV File Formats for Data Export Reports

>CSV Attributes for the Entitlements and Activations Data Export Report

>CSV Attributes for the Channel Partners Data Export Report

>CSV Attributes for the Customers Data Export Report

>CSV Attributes for the Products Data Export Report

>CSV Attributes for the Extended Activations Data Export Report

>CSV Attributes for the Custom Entities Data Export Report

>CSV Attributes for the Sentinel LDK: Usage Data for Login Events Data Export Report

>CSV Attributes for the Sentinel LDK: Usage Data for Logout Events Data Export Report

>CSV Attributes for the Sentinel LDK: Usage Data for Detach Events Data Export Report

>CSV Attributes for the Sentinel LDK: Usage Data for Cancel Detach Events Data Export Report

See also: Data Export Reports

You use data export reports to export information of entities such as entitlements, activations, channel partners, customers, and products to a CSV file. This page describes the information that is available in the CSV file.

CSV Attributes for the Entitlements and Activations Data Export Report

The following table describes the attributes in the CSV file for the Entitlements and Activations data export report:

Header Description

RowType 

Specifies the type of record.

Possible values:

>LineItem: Record is for a line item of an entitlement.

>Activation: Record is for an activation.

>Split: Record is for a split or transfer of entitlement. 

IsLeased

Specifies whether a line item or activation is for a lease-based entitlement. 

Possible values:

>1: Line item or activation is for a lease-based entitlement.

>Any value other than 1: Line item or activation is for an entitlement, which is not lease-based.

LineItemId

Specifies an automatically generated unique ID that is assigned to line items.

EntId

Specifies an automatically generated unique ID that is assigned to entitlements. An entitlement identified by EntID may contain multiple line items.

ActivationState

Specifies the state of activation. 

Possible values:

>1: The line item has not been activated.

>2: The line item is activated. The license was generated.

>20: The activation is renewed.

ActivationId

Unique, automatically generated ID that identifies the activation record in the Sentinel EMS database. Example: 12121

PreviousActivationId

Specifies a previous ActivationId for activations that were renewed. 

EID

Specifies a unique identifier for an entitlement. The EID is shared with customers so that they can log in to the customer portal using EID and activate entitlements.

PKID

Specifies an automatically generated ID that identifies the product line item of an entitlement.

Use Case:

This information can often be used in combination with custom attributes to understand renewal.

EntState

Specifies the state of entitlement.

Possible values:

>1: Entitlement is in draft state.

>2: Entitlement is marked as Completed.

LineItemState

Specifies the state of a line item.

Possible values:

>1:Line item is in draft state.

>2: Line item is marked as Completed.

EventDate

Specifies the date of occurrence of the event. The event is identified by the RowType field.

Possible values:

>Line item start date if the record is for a line item (RowType is LineItem).

>Activation date if the record is for an activation (RowType is Activation).

EntitlementStartDate

Specifies the start date of entitlement.

Use Case:

This information can be used to calculate the number of entitlements, where multiple products or line items are associated with a single entitlement. This information can also be used to track a customer's history.

EntitlementEndDate

Specifies the end date of entitlement. 

LineItemStartDate

Specifies the start date of a line item. 

LineItemCreateDate

Specifies the date when the create operation was performed on the line item. The line item creation date may be different from the line item start date.

Use Case:

For migration from a previous system, this date can be used to calculate quantities sold in a given time frame during the migration or later.

LineItemEndDate

Specifies the end date of a line item.

ModifyDate Specifies the date when the record was last modified.

PrdId

Specifies the product identifier associated with the line item. 

PrdName

Specifies the product associated with the line item. 

Ver

Specifies the product version.

Quantity

Specifies the quantity based on the RowType field.

>Quantity activated if the record is for an activation (RowType is Activation).

>Quantity in a line item if the record is for a line item (RowType is LineItem).

ItemSplitQuantity

Specifies the quantity split from the parent line item.

CstmrId

Specifies the customer identifier associated with the line item.

CstmrName

Specifies the customer name. 

Partner1, Partner2, Partner3, Partner4, and Partner5

Specifies the channel partners associated with the line items. 

PartnerId1, PartnerId2, PartnerId3, PartnerId4, and PartnerId5.

Specifies the channel partner IDs associated with the channel partners. 

Custom Attributes for Line Items

Specifies the custom attributes associated with line items. If you configured the data export report to display custom attribute details for line items, then each custom attribute is displayed in a new column after the existing columns in the record.

Custom Attributes for Entitlements

Specifies the custom attributes associated with entitlements. If you configured the data export report to display custom attribute details for entitlements, then each custom attribute is displayed in a new column after the existing columns in the record.

Custom Attributes for Activations

Specifies the custom attributes associated with activations. If you configured the data export report to display custom attribute details for activations, then each custom attribute is displayed in a new column after the existing columns in the record.

CSV Attributes for the Channel Partners Data Export Report

The following table describes the information in the CSV file for the Channel Partners data export report:

Header

Description 

PartnerId

Specifies the identifier that identifies the channel partner.

PartnerName

Specifies the channel partner name.

CreateDate

Specifies the date when the channel partner was created. 

ModifiedDate

Specifies the date when the channel partner was modified. 

Custom Attributes for Channel Partners

Specifies the custom attributes associated with channel partners. If you configured the data export report to display custom attribute details for channel partners, then each custom attribute is displayed in a new column after the existing columns in the record.

CSV Attributes for the Customers Data Export Report

The following table describes the information in the CSV file for the Customers data export report:

Header

Description 

CstmrId

Specifies the identifier that identifies the customer.

CstmrName

Specifies the customer name.

CreateDate

Specifies the date when the customer was created. 

ModifiedDate

Specifies the date when the customer was modified. 

Custom Attributes for Customers

Specifies the custom attributes associated with customers. If you configured the data export report to display custom attribute details for customers, then each custom attribute is displayed in a new column after the existing columns in the record.

CSV Attributes for the Products Data Export Report

The following table describes the information in the CSV file for the Products data export report:

Header

Description 

PrdId

Specifies the identifier that identifies the product.

PrdName

Specifies the product name.

CreateDate

Specifies the date when the product was created. 

ModifiedDate

Specifies the date when the product was modified. 

Custom Attributes for Products

Specifies the custom attributes associated with products. If you configured the data export report to display custom attribute details for products, then each custom attribute is displayed in a new column after the existing columns in the record.

CSV Attributes for the Extended Activations Data Export Report

The following table describes the attributes in the CSV file for the Extended Activations data export report:

Header Description
isLeased

Whether the activation is for a lease-based entitlement. 

Possible values:

>1: Activation is for a lease-based entitlement.

>Any value other than 1: Activation is for an entitlement that is not lease-based.

activationStatus

The state of activation. 

Possible values:

>ACTIVATED: The line item is activated. The license was generated.

>RENEWED: The activation is renewed.

>EXPIRED: The entitlement cannot be activated because the end date for the entitlement is in the past and the entitlement has expired.

activationId

A unique, automatically generated ID that identifies the activation record in the Sentinel EMS database. Example: 12121

previousActivationId

The previous activationId for activations that were renewed. 

eId

A unique identifier for the entitlement. The EID is shared with customers so that they can log in to the customer portal using EID and activate entitlements.

aId

An auto-generated GUID (Globally Unique Identifier) that is assigned to activations, for example: q5251rst-69q6-49qz-qrs5-45q225r9375s

The AID is visible in Sentinel EMS.

pkId

Automatically generated number that identifies the product key ID.

Use Case:

This information can often be used in combination with custom attributes to understand renewal.

eventDate

The date of activation.

modifyDate The date when the record was last modified.

prdId

The product identifier associated with the activation. 

prdName

The name of the product associated with the activation. 

quantity

The quantity activated.

cstmrId

The customer identifier associated with the activation.

cstmrName

The name of the customer associated with the activation. 

enf_name

The name of the enforcement associated with the activation. 

Custom Attributes for Activations

The custom attributes associated with activations. If you configured the data export report to display custom attribute details for activations, then each custom attribute is displayed in a new column after the existing columns in the record.

CSV Attributes for the Custom Entities Data Export Report

The following table describes the information in the CSV file for the Custom Entities data export report:

Header

Description 

rowId Specifies the unique identifier of the instance associated with the custom entity.

entityName

Specifies the name of the custom entity.

<entity attribute name>

...

Specifies the name of the entity attribute.

Each entity attribute is displayed in a new column after the existing columns in the record.  

CSV Attributes for the Sentinel LDK: Usage Data for Login Events Data Export Report

The following table describes the information in the CSV file for the Sentinel LDK: Usage Data for Login Events data export report:

Header

Description 

Tenant ID

A unique identifier assigned to a specific tenant (software vendor) during the vendor's deployment in the Thales-hosted cloud.

Event ID

A unique identifier that is randomly generated during the licensed application's execution and is used to identify each login, logout, detach, and cancel detach call.

Vendor ID

A unique number that is associated with a given vendor code and batch code (namespace).

Key ID

The identifier of the Sentinel protection key.

Key Name

Reserved for future use.

Product ID

The unique product identifier defined by the vendor in Sentinel EMS.

Product Name*

The product name assigned in Sentinel EMS.

Event Version

The version number associated with the usage data for the events schema, such as version 1, when the schema was initially introduced.

Licensing API Version

The Sentinel Licensing API library version.

Customer ID

The unique customer identifier that is automatically generated by Sentinel EMS in the background when a customer is created. This identifier is different from the one that vendors assign to customers.

Thales recommends ignoring this auto-generated identifier unless you have two customers with the same name, and you need to differentiate between their usage data. To determine which customer is being named, use Sentinel EMS REST API - Get Customer. This endpoint retrieves a specific customer based on the specified unique identifier.

Customer Name

The name of the customer in Sentinel EMS.

Feature ID

A custom-defined, unique identifier for a specific feature stored in a Sentinel protection key. This is the number passed to the Login function to establish access to the feature.

Feature Name*

The name of the feature in Sentinel EMS.

License Model

The license model of the Sentinel protection key.

Total Executions

The total pool of executions for the licensed software.

Consumed Executions

The number of used executions for the licensed software.

Feature Expiration Date and Time

The expiration date and time of a license. For example, 2025-01-01T23:59:59.000Z, which represents January 1, 2025, at 11:59:59 PM UTC. This applies to:

> Time from First Use licenses, where the expiration date and time are assigned based on first use and license duration.

> Expiration Date licenses, where the expiration date and time are assigned based on the expiration date set.

Feature Start Date and Time

>The start date and time of a license. For example, 2024-09-05T07:34:41.000Z, which represents September 5, 2024 at 7:34:41 AM UTC. This applies to Time from First Use licenses. The expiration date and time are assigned on the basis of first use.

>The placeholder value 1970-01-01T00:00:00.000Z, which represents January 1, 1970, at 12:00:00 AM UTC is used under the following scenarios:

For Perpetual and Execution Count licenses as the feature start date and time do not apply.

For Expiration Date licenses when the feature start date and time is not defined.

>For Trial licenses, both the feature start date and time and feature expiration date and time are assigned on the basis of first login.

License Duration

The total duration (in seconds) for which the Time from First Use license is valid.

Total Seats

The maximum number of concurrent instances permitted to run the licensed software.

Seats Currently in Use

The current number of concurrent instances running the licensed software.

Identity Code

A unique 7-character identity code, which is part of the full identity string required by remote machines to access the cloud license.

Issued To

The name of the person or entity for whom the cloud license was generated.

User ID

The unique identifier of the customer's user, as defined in Sentinel EMS.

External ID

Reserved for future use.

Identity Expiration Date and Time

The date and time on which the client identity expires. For example, 2025-01-01T23:59:59.000Z, which represents January 1, 2025, at 23:59:59 (11:59:59 PM) in UTC. "Never Expires" is displayed when the identity string does not have an expiration date.

Maximum Auto-registered Machines

The maximum number of remote client devices allowed to use the given identity string to access the cloud license.

A value of 0 (zero) means there is no limit to the number of remote client devices permitted.

Currently Registered Machines

The current number of remote client devices that have registered to use the given identity string to access the cloud license.

Application Name*

The application name specified by the software vendor.

Application Version*

The application version that corresponds to the application name specified by the software vendor.

Session ID

The unique session ID.

Status Code

The status codes related to the operation of the Sentinel Licensing API functions.

Note that not all errors returned by the hasp_login API are logged in the login events report. For example, the following errors are not logged: 88 (HASP_IDENTITY_UNAUTHENTICATED), 89 (HASP_IDENTITY_DISABLED), and 103 (HASP_IDENTITY_EXPIRED). This occurs because identity validation is processed before the login request is handled.

Executions Consumed at Login

The number of executions that were consumed for a single login.

Creation Date and Time

The creation date and time of the event data. For example, 2025-01-01T23:59:59.000Z, which represents January 1, 2025, at 11:59:59 PM in UTC.

Client Domain Name

The domain name of the logged-in machine.

Client Host Name

The host name of the logged-in machine.

Client User Name

The user name of the logged-in machine.

Client OS Info

Reserved for future use.

Client VM Info

The virtual machine information for the logged-in machine.

Client IP Address

The IP address of the logged-in machine.

* If you are using UTF-8 encoding for product names, feature names, application names, or versions, ensure that Power BI displays the characters correctly by selecting 65001: Unicode (UTF-8) as the "File origin" option when opening CSV files in Power BI.

CSV Attributes for the Sentinel LDK: Usage Data for Logout Events Data Export Report

The following table describes the information in the CSV file for the Sentinel LDK: Usage Data for Logout Events data export report:

Header

Description 

Tenant ID

A unique identifier assigned to a specific tenant (software vendor) during the vendor's deployment in the Thales-hosted cloud.

Event ID

A unique identifier that is randomly generated during the licensed application's execution and is used to identify each login, logout, detach, and cancel detach call.

Vendor ID

A unique number that is associated with a given vendor code and batch code (namespace).

Event Version

The version number associated with the usage data for the events schema, such as version 1, when the schema was initially introduced.

Licensing API Version

The Sentinel Licensing API library version.

Session ID

The unique session ID.

Session Duration

Duration of a login session (in seconds).

Status Code

The status codes related to the operation of the Sentinel Licensing API functions.

Creation Date and Time

The creation date and time of the event data. For example, 2025-01-01T23:59:59.000Z, which represents January 1, 2025, at 11:59:59 PM in UTC.

CSV Attributes for the Sentinel LDK: Usage Data for Detach Events Data Export Report

The following table describes the information in the CSV file for the Sentinel LDK: Usage Data for Detach Events data export report:

Header

Description 

Tenant ID

A unique identifier assigned to a specific tenant (software vendor) during the vendor's deployment in the Thales-hosted cloud.

Event ID

A unique identifier that is randomly generated during the licensed application's execution and is used to identify each login, logout, detach, and cancel detach call.

Vendor ID

A unique number that is associated with a given vendor code and batch code (namespace).

Product ID

The unique product identifier defined by the vendor in Sentinel EMS.

Product Name

The product name assigned in Sentinel EMS.

Total Number of Detachable Seats

The total number of seats that can be detached concurrently for the product from the cloud license manager server.

Event Version

The version number associated with the usage data for the events schema, such as version 1, when the schema was initially introduced.

Licensing API Version

The Sentinel Licensing API library version.

NOTE   In certain cases, the value may not be fully accurate. Improvements are planned for future releases.

Identity Code

A unique 7-character identity code, which is part of the full identity string required by remote machines to access the cloud license.

Issued To

The name of the person or entity for whom the cloud license was generated.

User ID

The unique identifier of the customer's user, as defined in Sentinel EMS.

External ID

Reserved for future use.

Identity Expiration Date and Time

The date and time on which the client identity expires. For example, 2025-01-01T23:59:59.000Z, which represents January 1, 2025, at 23:59:59 (11:59:59 PM) in UTC. "Never Expires" is displayed when the identity string does not have an expiration date.

Maximum Auto-registered Machines

The maximum number of remote client devices allowed to use the given identity string to access the cloud license.

A value of 0 (zero) means there is no limit to the number of remote client devices permitted.

Application Name

Reserved for future use.

Application Version

Reserved for future use.

Number of Detached Seats

The total number of seats currently detached from the cloud license manager server.

Detach Expiration Date and Time

The expiration date and time for the detached licenses. For example, 2025-01-01T23:59:59.000Z, which represents January 1, 2025, at 11:59:59 PM in UTC.

Detach Duration

The number of days that seats (licenses) were detached from the cloud license manager server during the report period.

Remaining Detachable Seats

The total number of seats for the product that were not detached from the cloud license manager server when the report was generated.

NOTE   In certain cases, the value may not be fully accurate. Improvements are planned for future releases.

Status Code

The status codes related to the operation of the Sentinel Licensing API functions.

Creation Date and Time

The creation date and time of the event data. For example, 2025-01-01T23:59:59.000Z, which represents January 1, 2025, at 11:59:59 PM in UTC.

Client Domain Name

The domain name of the logged-in machine.

Client Host Name

The host name of the logged-in machine.

Client User Name

The user name of the logged-in machine.

Client OS Info

Reserved for future use.

Client VM Info

The virtual machine information for the logged-in machine.

Client IP Address

The IP address of the logged-in machine.

CSV Attributes for the Sentinel LDK: Usage Data for Cancel Detach Events Data Export Report

The following table describes the information in the CSV file for the Sentinel LDK: Usage Data for Cancel Detach Events data export report:

Header

Description 

Tenant ID

A unique identifier assigned to a specific tenant (software vendor) during the vendor's deployment in the Thales-hosted cloud.

Event ID

A unique identifier that is randomly generated during the licensed application's execution and is used to identify each login, logout, detach, and cancel detach call.

Vendor ID

A unique number that is associated with a given vendor code and batch code (namespace).

Product ID

The unique product identifier defined by the vendor in Sentinel EMS.

Product Name

The product name assigned in Sentinel EMS.

Event Version

The version number associated with the usage data for the events schema, such as version 1, when the schema was initially introduced.

Detach Expiration Date and Time

The expiration date and time for the detached licenses. For example, 2025-01-01T23:59:59.000Z, which represents January 1, 2025, at 11:59:59 PM in UTC.

Status Code

The status codes related to the operation of the Sentinel Licensing API functions.

Creation Date and Time

The creation date and time of the event data. For example, 2025-01-01T23:59:59.000Z, which represents January 1, 2025, at 11:59:59 PM in UTC.