CSV File Formats for Importing and Exporting Data
NOTE "Contacts" in the CSV files refer to the Users entity.
You can use the information in this section to create a CSV file with data for entities such as customers, features, products, entitlements, or downloads. You can then import the data contained in the CSV file to create one or more instances of the relevant entity, such as five new features or a new product. When you define the CSV file, make sure to consider and handle any dependencies. For example, you need to define a feature before you can include the feature details in a product.
You can also use the data and examples in this section to understand what you might receive when you export data in CSV format. The examples are from the sample CSV files that you can download from Sentinel EMS. For instructions on how to download the sample CSV files, see Importing and Exporting Entity Data.
Important
>Header names are case-sensitive. The data values that you provide for the headers are not case-sensitive.
>Any header name other than those defined in the CSV is treated as a custom attribute. The custom attributes must exist in Sentinel EMS before you import the data. For details on creating custom attributes, see Custom Attributes.
>Custom attributes for some entities require a prefix. To ensure that the header name is processed correctly, make sure to append the relevant prefix, as defined in Using Custom Attributes
> When importing the data contained in the CSV file, ensure that the maximum number of records does not exceed 5000.
>To ensure that a CSV file containing special characters is imported successfully, save the CSV file in UTF-8 format.
>
Third-party enforcement data depends on your implementation and is not covered on this page.
Using Custom Attributes
If you use custom attributes, you can add them to a CSV file before you import the data.
To add custom attributes to a CSV file:
1.Create the custom attributes in Sentinel EMS. For details, see Custom Attributes
2.In the relevant CSV file for the entitles listed in the table below, enter the custom attribute name exactly as defined in the Custom Attributes page. For example, if you use a custom attribute for customers named "Alternate Name", enter the header value as Alternate Name.
Some custom attributes require a prefix as shown in the table below. The prefix is not case-sensitive, but the custom attribute header name is case-sensitive. Make sure to enter the name exactly as defined in the Custom Attributes page. For example, if you use a custom attribute for downloads named "Alternate Download", enter the header value as CA_DWNLD.Alternate Download. Any entity that is not listed in the table does not require a prefix.
| Entity | Prefix (not case-sensitive) | Notes |
|---|---|---|
| Download | CA_DWNLD. | |
|
Entitlement |
CA_ENT. |
Date-type custom attribute values use the YYYY-MM-DD format. |
|
Entitlement > Product Key |
CA_ENT_LI. |
CSV File Format for Customers
The following sample displays the CSV file format for importing customer data. The first line shows the headers. The next lines show sample data.
name,customerCRMId,description,enabled,refId,customerIdentifier,externalId,timeZone Smith Associates,3,reseller,TRUE,1,someIdentifier,321468527,UTC-5 Customer2,4,Customer2 Description,TRUE,2,CustomerIdentifier2,externalId2,UTC
The following table describes the headers in a customer CSV file. For more details on adding a customer, see Customers. For details on adding a custom attribute, see Using Custom Attributes.
| Header | Description |
|---|---|
| name | (Required) Customer name |
| customerCRMId | CRM ID. Used to connect to an external CRM. |
| description | Customer description |
| enabled | Identifies if a customer is active. |
| refId | Ref ID. Used to connect to an external CRM. |
| customerIdentifier | Unique identifier for the customer. |
| externalId |
External reference identifier that uniquely identifies the customer in an external system. |
| timeZone | Customer time zone. Used for the start date and the end date of a license. |
CSV File Format for Users (also known as Contacts)
The following sample displays the CSV file format for importing end user data. The first line shows the headers. The next lines show sample data.
contactEmail,contactPassword,contactName,contactUserId,contactExternalId,contactNumber,locale,refId1,refId2,loginAllowed,shipAddr,shipAddrCity,shipAddrState,shipAddrCountry,shipAddrZip,billAddr,billAddrCity,billAddrState,billAddrCountry,billAddrZip,customerName,identityProviderName jsmith@example.com,xxxxxxx,J. Smith,601a00,369f,(213) 555-1234,en,2,3,TRUE,148 Humberto Street,Los Angeles,CA,United States,12345,148 Humberto Street,Los Angeles,CA,United States,12345,Trace Purdy,SentinelIDP jjones@example.com,xxxxxxx,Jean Jones,80bn88,908g,(518) 555-1234,en,2,3,TRUE,444 Lark Street,Albany,NY,United States,12222,444 Lark Street,Albany,NY,United States,12222,Clark Kent,SentinelIDP
The following table describes the headers in a users CSV file. For more details on adding a user, see Users. For details on adding a custom attribute, see Using Custom Attributes.
| Header | Description |
|---|---|
| contactEmail | (Required) Email address for the user. |
| contactPassword | Password for the user. |
| contactName | Name of the user. |
| contactNumber | User's telephone or mobile number. |
| contactUserId | Unique identifier of the user. |
| contactExternalId |
External reference identifier that uniquely identifies the user in an external system. Required only if you specify an identity provider other than "SentinelIDP". |
| locale | Language for the user. |
| refId1 | Reference identifier that identifies the user in an external system. Used to connect to an external CRM. |
| refId2 | Reference identifier that identifies the user in an external system. Used to connect to an external CRM. |
| loginAllowed |
Specified whether the user is allowed to log on to the Sentinel EMS customer portal. |
| shipAddr | Street address or post office box details for shipping. |
| shipAddrCity | City for the shipping address. |
| shipAddrState | State, province, county, territory, or other any other regional information required for the shipping address. |
| shipAddrCountry | Country for the shipping address. |
| shipAddrZip | ZIP or postal code for the shipping address. |
| billAddr | Street address or post office box details for billing statements (for example credit card statements). |
| billAddrCity | City for the billing address. |
| billAddrState | State, province, county, territory, or other any other regional information required for the billing address. |
| billAddrCountry | Country for the billing address. |
| billAddrZip | ZIP or postal code for the billing address. |
| customerName | Name of the customer associated with the user. |
| identityProviderName |
Name of the identity provider that manages user identities and authentication processes when accessing the vendor’s application or service. If you do not specify a value, Sentinel EMS automatically assigns SentinelIDP to the user. SentinelIDP is the default identity provider for Sentinel EMS. If you are using your own identity provider and specify a value other than SentinelIDP, you must also provide a value for contactExternalId. Possible values: >SentinelIDP >Your identity provider |
CSV File Format for Features
The following sample displays the CSV file format for importing feature data. The sample also shows what might be generated when exporting a CSV file from the Features page. The first line shows the headers. The next lines show sample data.
If at least two enforcements are supported, including Sentinel LDK, the following sample is available:.
namespaceName,externalFtrId,featureIdentifier,featureName,featureVersion,description,refId1,refId2,licenseModelName,isDefaultLM General,135b,,Save_File,V1.1,Allows users to make changes to saved files,101,201,Auto Checkout,TRUE DEMOMA,137d,,Edit_File,,Permanently saves the unsaved changes in a file,102,202,,FALSE
If only Sentinel LDK is supported, the following sample is available:
namespaceName,externalFtrId,featureIdentifier,featureName,description,refId1,refId2 DEMOMA,137d,,Edit_File,Permanently saves the unsaved changes in a file,102,202
The following table describes the headers in a feature CSV file. For more details on adding a feature
| Header | Description |
|---|---|
| namespaceName | (Required) Associated namespace. |
| externalFtrId | External feature ID used for integration with external systems. |
| featureIdentifier |
Unique feature identifier provided by customer.
|
| featureName | (Required) Name of the feature. |
| featureVersion |
|
| description | Feature description. |
| refId1 | Reference ID. Used to connect to an external CRM. |
| refId2 | Alternate reference ID. Used to connect to an external CRM. |
| licenseModelName |
|
| isDefaultLm |
Flag specifying whether or not the license model associated with the feature is marked as default.
|
CSV File Format for Products
The following
The headers included in the sample CSV file depend on the enforcements available in Sentinel EMS.
If one or more enforcements are supported, excluding Sentinel LDK, the following sample is available:
NamespaceName,ExternalPrdId,ProductName,ProductVersion,RefId1,RefId2,Description,State,ExternalFtrId,FeatureName,FeatureVersion,ProductFeatureState,DefaultLicenseModel,IsLicenseModelFixed,componentMultiplier,familyName,ActivationMethod,FixedQuantity,productType,ProductIdentifier,isProvisioning,isAutoActivation,Prd_Enf.ACTION_REQUIRED,Prd_Enf.ALLOW_VM_DETECTION,Prd_Enf.BATCH_CODE,Prd_Enf.CLIENT_1_CRITERIA,Prd_Enf.CLIENT_1_FINGERPRINT,Prd_Enf.CLIENT_2_CRITERIA,Prd_Enf.CLIENT_2_FINGERPRINT,Prd_Enf.CLIENT_3_CRITERIA,Prd_Enf.CLIENT_3_FINGERPRINT,Prd_Enf.CLIENT_4_CRITERIA,Prd_Enf.CLIENT_4_FINGERPRINT,Prd_Enf.CLIENT_5_CRITERIA,Prd_Enf.CLIENT_5_FINGERPRINT,Prd_Enf.CLIENT_6_CRITERIA,Prd_Enf.CLIENT_6_FINGERPRINT,Prd_Enf.CLIENT_7_CRITERIA,Prd_Enf.CLIENT_7_FINGERPRINT,Prd_Enf.DEVICE_FINGER_PRINT,Prd_Enf.IS_DEVICE_ENABLED,Prd_Enf.LICENSE_SIGNING,Prd_Enf.LICENSE_VERSION,Prd_Enf.Locking Code,Prd_Enf.NAMED_USER_LICENSE,Prd_Enf.NO_OF_NAMEDUSERS,Prd_Enf.NUM_CLIENT_LOCKED,Prd_Enf.NUM_SERVERS,Prd_Enf.NUM_USERNODE,Prd_Enf.PRIMARY_10_CRITERIA,Prd_Enf.PRIMARY_10_FINGERPRINT,Prd_Enf.PRIMARY_11_CRITERIA,Prd_Enf.PRIMARY_11_FINGERPRINT,Prd_Enf.PRIMARY_1_CRITERIA,Prd_Enf.PRIMARY_1_FINGERPRINT,Prd_Enf.PRIMARY_2_CRITERIA,Prd_Enf.PRIMARY_2_FINGERPRINT,Prd_Enf.PRIMARY_3_CRITERIA,Prd_Enf.PRIMARY_3_FINGERPRINT,Prd_Enf.PRIMARY_4_CRITERIA,Prd_Enf.PRIMARY_4_FINGERPRINT,Prd_Enf.PRIMARY_5_CRITERIA,Prd_Enf.PRIMARY_5_FINGERPRINT,Prd_Enf.PRIMARY_6_CRITERIA,Prd_Enf.PRIMARY_6_FINGERPRINT,Prd_Enf.PRIMARY_7_CRITERIA,Prd_Enf.PRIMARY_7_FINGERPRINT,Prd_Enf.PRIMARY_8_CRITERIA,Prd_Enf.PRIMARY_8_FINGERPRINT,Prd_Enf.PRIMARY_9_CRITERIA,Prd_Enf.PRIMARY_9_FINGERPRINT,Prd_Enf.SECONDARY_1_CRITERIA,Prd_Enf.SECONDARY_1_FINGERPRINT,Prd_Enf.USERNODE_1_CRITERIA,Prd_Enf.USERNODE_1_FINGERPRINT,Prd_Enf.USERNODE_2_CRITERIA,Prd_Enf.USERNODE_2_FINGERPRINT,Prd_Enf.USERNODE_3_CRITERIA,Prd_Enf.USERNODE_3_FINGERPRINT,Prd_Enf.USERNODE_4_CRITERIA,Prd_Enf.USERNODE_4_FINGERPRINT,Prd_Enf.USERNODE_5_CRITERIA,Prd_Enf.USERNODE_5_FINGERPRINT,Prd_Enf.USERNODE_6_CRITERIA,Prd_Enf.USERNODE_6_FINGERPRINT,Prd_Enf.USERNODE_7_CRITERIA,Prd_Enf.USERNODE_7_FINGERPRINT General,369a,Easiest E-Editor,v2023,1001,A-1001,Easiest E-Editor is a word processing program that allows for the creation of both simple and complex documents,ENABLE,137d,Edit_File,V1.1,DefaultOn,Support License Model,FALSE,1,Default,FULL,,DEFAULT,,FALSE,FALSE,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, General,428a,Spreadsheet-4U,,2001,D-2001,Spreadsheet-4U is a spreadsheet program for business applications,ENABLE,135b,Save_File,V1.1,DefaultOn,Auto Checkout,TRUE,1,Default,SAOT,,PARENT,,FALSE,FALSE,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, General,428b,Spreadsheet-4U,v2023,2002,D-2002,Spreadsheet-4U is a spreadsheet program for business applications,ENABLE,135b,Save_File,V1.1,DefaultOn,Auto Checkout,TRUE,1,Default,Fixed,1,CHILD,,FALSE,FALSE,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
If at least two enforcements are supported, including Sentinel LDK, the following sample is available:
IsLDKEnforcement,NamespaceName,ExternalPrdId,ProductName,ProductVersion,RefId1,RefId2,Description,State,ExternalFtrId,FeatureName,FeatureVersion,ProductFeatureState,DefaultLicenseModel,IsLicenseModelFixed,componentMultiplier,familyName,ActivationMethod,FixedQuantity,productType,ProductIdentifier,isProvisioning,isAutoActivation,Prd_Enf.ACTION_REQUIRED,Prd_Enf.ALLOW_VM_DETECTION,Prd_Enf.BATCH_CODE,Prd_Enf.CLIENT_1_CRITERIA,Prd_Enf.CLIENT_1_FINGERPRINT,Prd_Enf.CLIENT_2_CRITERIA,Prd_Enf.CLIENT_2_FINGERPRINT,Prd_Enf.CLIENT_3_CRITERIA,Prd_Enf.CLIENT_3_FINGERPRINT,Prd_Enf.CLIENT_4_CRITERIA,Prd_Enf.CLIENT_4_FINGERPRINT,Prd_Enf.CLIENT_5_CRITERIA,Prd_Enf.CLIENT_5_FINGERPRINT,Prd_Enf.CLIENT_6_CRITERIA,Prd_Enf.CLIENT_6_FINGERPRINT,Prd_Enf.CLIENT_7_CRITERIA,Prd_Enf.CLIENT_7_FINGERPRINT,Prd_Enf.DEVICE_FINGER_PRINT,Prd_Enf.IS_DEVICE_ENABLED,Prd_Enf.LICENSE_SIGNING,Prd_Enf.LICENSE_VERSION,Prd_Enf.Locking Code,Prd_Enf.NUM_CLIENT_LOCKED,Prd_Enf.NUM_SERVERS,Prd_Enf.NUM_USERNODE,Prd_Enf.PRIMARY_10_CRITERIA,Prd_Enf.PRIMARY_10_FINGERPRINT,Prd_Enf.PRIMARY_11_CRITERIA,Prd_Enf.PRIMARY_11_FINGERPRINT,Prd_Enf.PRIMARY_1_CRITERIA,Prd_Enf.PRIMARY_1_FINGERPRINT,Prd_Enf.PRIMARY_2_CRITERIA,Prd_Enf.PRIMARY_2_FINGERPRINT,Prd_Enf.PRIMARY_3_CRITERIA,Prd_Enf.PRIMARY_3_FINGERPRINT,Prd_Enf.PRIMARY_4_CRITERIA,Prd_Enf.PRIMARY_4_FINGERPRINT,Prd_Enf.PRIMARY_5_CRITERIA,Prd_Enf.PRIMARY_5_FINGERPRINT,Prd_Enf.PRIMARY_6_CRITERIA,Prd_Enf.PRIMARY_6_FINGERPRINT,Prd_Enf.PRIMARY_7_CRITERIA,Prd_Enf.PRIMARY_7_FINGERPRINT,Prd_Enf.PRIMARY_8_CRITERIA,Prd_Enf.PRIMARY_8_FINGERPRINT,Prd_Enf.PRIMARY_9_CRITERIA,Prd_Enf.PRIMARY_9_FINGERPRINT,Prd_Enf.SECONDARY_1_CRITERIA,Prd_Enf.SECONDARY_1_FINGERPRINT,Prd_Enf.USERNODE_1_CRITERIA,Prd_Enf.USERNODE_1_FINGERPRINT,Prd_Enf.USERNODE_2_CRITERIA,Prd_Enf.USERNODE_2_FINGERPRINT,Prd_Enf.USERNODE_3_CRITERIA,Prd_Enf.USERNODE_3_FINGERPRINT,Prd_Enf.USERNODE_4_CRITERIA,Prd_Enf.USERNODE_4_FINGERPRINT,Prd_Enf.USERNODE_5_CRITERIA,Prd_Enf.USERNODE_5_FINGERPRINT,Prd_Enf.USERNODE_6_CRITERIA,Prd_Enf.USERNODE_6_FINGERPRINT,Prd_Enf.USERNODE_7_CRITERIA,Prd_Enf.USERNODE_7_FINGERPRINT,LDK.lockingType,LDK.rehostState,LDK.upgradeToDriverless,LDK.vclock,LDK.isNotLockedToDevice,LDKMemory.fileName,LDKMemory.text,LDKMemory.fileId,LDKMemory.fileType,LDKMemory.size,LDKMemory.fileSize,LDKMemory.segmentName,LDKMemory.offset,LDKMemory.applyMemory,LDKMemory.allowTextOverwrite FALSE,General,369a,Easiest E-Editor,,1001,A-1001,Easiest E-Editor is a word processing program that allows for the creation of both simple and complex documents,ENABLE,135b,Save_File,V1.1,DefaultOn,Auto Checkout,FALSE,1,Default,SAOT,0,PARENT,,FALSE,FALSE,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, FALSE,General,369b,Easiest E-Editor,v2023,2001,D-2001,Easiest E-Editor is a word processing program that allows for the creation of both simple and complex documents,DRAFT,135b,Save_File,V1.1,DefaultOn,Auto Checkout,TRUE,1,Default,Fixed,1,CHILD,,FALSE,FALSE,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, TRUE,DEMOMA,428b,Spreadsheet-4U,v2023,2002,D-2002,Spreadsheet-4U is a spreadsheet program for business applications,DRAFT,137d,Edit_File,V1.1,DefaultOn,Perpetual,FALSE,1,Default,SAOT,0,DEFAULT,,FALSE,FALSE,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,SL_UserMode,LEAVE_AS_IS,,,FALSE,,,,,,,,
If only Sentinel LDK is supported, the following sample is available:
IsLDKEnforcement,NamespaceName,ExternalPrdId,ProductName,ProductVersion,RefId1,RefId2,Description,State,ExternalFtrId,FeatureName,FeatureVersion,ProductFeatureState,DefaultLicenseModel,IsLicenseModelFixed ,componentMultiplier,familyName,ActivationMethod,FixedQuantity,productType,ProductIdentifier,isProvisioning,isAutoActivation,LDK.lockingType,LDK.rehostState,LDK.upgradeToDriverless,LDK.vclock,LDK.isNotLockedToDevice,LDKMemory.fileName,LDKMemory.text,LDKMemory.fileId,LDKMemory.fileSize,LDKMemory.segmentName,LDKMemory.applyMemory,LDKMemory.allowTextOverwrite TRUE,DEMOMA,428b,Spreadsheet-4U,,2002,D-2002,Spreadsheet-4U is?a spreadsheet program for business applications,DRAFT,137d,Edit_File,,DefaultOn,Perpetual,FALSE,1,Default,SAOT,0,DEFAULT,,FALSE,FALSE,HL_or_SL_AdminMode_or_SL_UserMode,DISABLE,FALSE,FALSE,FALSE,TestMemory,44656661756c74,1,2048,Segment1,ADD,TRUE
The following table describes some of the headers in a product CSV file. For more details on adding a product and associating features, license models
| Header | Description |
|---|---|
| IsLDKEnforcement |
(Displayed only if Sentinel LDK is supported.) Specifies whether the product is defined for Sentinel LDK.
|
| NamespaceName | (Required) Associated namespace. |
| ExternalPrdId | External product identifier used for integration with external systems. |
| ProductName | (Required) The name of the product. |
| ProductVersion |
Required for default and variant products. Optional for versionless products.
|
| RefId1 | Reference ID. Used to connect to an external CRM. |
| RefId2 | Alternate reference ID. Used to connect to an external CRM. |
| Description | Product description. |
| State |
Status of the product. Possible values: >DRAFT >ENABLE >DISABLE Default if no value is specified: DRAFT |
| ExternalFtrId |
External feature ID used for integration with external systems. |
| FeatureName | Feature name. |
| FeatureVersion |
|
| ProductFeatureState |
Defines behavior of feature in a product when the product is added in an entitlement. Possible values: >DefaultOff (same as Excluded (Optional) in Sentinel EMS) >DefaultOn (same as Included (Optional) in Sentinel EMS) >Mandatory (same as Mandatory in Sentinel EMS) |
| DefaultLicenseModel |
Name and behavior of the Possible values: >SAOT (also known as "Define in Entitlement"). Enables the required license model to be associated with a feature later while creating an entitlement. >Any
|
| IsLicenseModelFixed |
Specifies whether the order taker can change a feature's license model when creating an entitlement. Relevant only if multiple license models are associated with a feature. Possible values: >TRUE. The license model is fixed and cannot be changed. >FALSE. The license model can be changed. |
| componentMultiplier |
(Required) Multiplying factor at product feature relationship level. Minimum value: 1 |
| familyName | Product family name |
| ActivationMethod | The activation method (SAOT (also known as "Define in Entitlement"), Fixed, Partial, |
| FixedQuantity | For Fixed activation method: the quantity that must be consumed for each activation. |
| productType |
Possible values: >DEFAULT (same as Default in Sentinel EMS) >PARENT (same as Versionless in Sentinel EMS) >CHILD (same as Variant in Sentinel EMS) Default if no value is specified: DEFAULT |
| ProductIdentifier | Custom-defined or system-generated identifier of the product. |
| isProvisioning |
Whether provisioning requests are supported for the product. For more information, see Provisioning. Possible values: >TRUE >FALSE Default if no value is specified: FALSE |
| isAutoActivation |
When isProvisioning is set to TRUE, specifies whether the product is activated automatically without any intervention when an entitlement is marked as complete. For more information, see Automatic Activation for Provisioning-Enabled Products. Possible values: >TRUE >FALSE Default if no value is specified: FALSE |
| Prd_Enf.<license model attribute> |
|
| LDK.lockingType |
Possible values: > HL: Sentinel HL keys only >SL_UserMode: Sentinel SL UserMode keys only >SL_AdminMode: Sentinel SL AdminMode keys only >HL_or_SL_AdminMode: Either Sentinel HL keys or Sentinel SL AdminMode keys >HL_or_SL_AdminMode_or_SL_UserMode: Sentinel HL keys, Sentinel SL AdminMode keys, or Sentinel SL UserMode keys Default: HL_or_SL_AdminMode_or_SL_UserMode |
| LDK.rehostState |
Possible values: >ENABLE: Enables rehosting of an SL key for the product. > DISABLE: Disables rehosting of an SL key for the product. >LEAVE_AS_IS: Uses the existing rehosting value in the SL key. Default: LEAVE_AS_IS |
| LDK.upgradeToDriverless |
Possible values: >TRUE >FALSE Default: FALSE |
| LDK.vclock |
Possible values: >TRUE >FALSE Default: FALSE |
| LDK.isNotLockedToDevice |
Possible values: >TRUE >FALSE Default: FALSE |
| LDKMemory.fileName |
Maximum: 50 alphanumeric characters |
| LDKMemory.text |
Contents of the memory file in hexadecimal format. |
| LDKMemory.fileId |
File ID of the memory file. Range: 1-65471 |
|
LDKMemory.fileSize |
For details, see File Size (Bytes). |
|
LDKMemory.size |
For details, see Size (Bytes). |
|
LDKMemory.segmentName |
For details, see Size (Bytes). Maximum: 50 alphanumeric characters. Cannot contain the following special characters: < > |
|
LDKMemory.offset |
The hexadecimal starting point of the memory segment in bytes. |
| LDKMemory.applyMemory |
Possible values: >ADD: Adds the new data to the memory file. Existing information remains unchanged. >OVERWRITE: Overwrites the existing information in the memory file by the new data. >DELETE: Permanently deletes the memory file associated with a license. Default: ADD |
| LDKMemory.allowTextOverwrite |
Possible values: >TRUE >FALSE Default: FALSE |
CSV File Format for Product Suites
The following sample displays the CSV file format for importing product suite data. The sample also shows what might be generated when exporting a CSV file from the Product Suites page. The first line shows the headers. The next lines show sample data.
namespaceName,suiteName,suiteVersion,externalSuiteId,refId1,refId2,description,activationMethod,fixedQuantity,externalId,productName,productVersion,state General,Example Suite,v2023,501a,101,201,Example suite is a collection of multiple products,Fixed,1,369a,Easiest E-Editor,v2023,DRAFT General,Example Suite,v2023,501a,101,201,Example suite is a collection of multiple products,Fixed,1,428b,Spreadsheet-4U,v2023,DRAFT
The following table describes the headers in a product CSV file. For more details on adding a product suite, see Product Suites. For details on adding a custom attribute, see Using Custom Attributes.
| Header | Description |
|---|---|
| namespaceName | (Required) Associated namespace |
| suiteName | (Required) Product suite name |
| suiteVersion | (Required) Version number |
| refId1 | Reference ID. Used to connect to an external CRM. |
| refId2 | Alternate reference ID. Used to connect to an external CRM. |
| externalSuiteId |
External reference identifier that uniquely identifies the product suite in an external system. |
| description | Product suite description. |
| activationMethod |
Method used for activating the product suite in an entitlement. |
| fixedQuantity | Value of fixed quantity if activation method is specified as Fixed. |
| externalId | External reference identifier that uniquely identifies the product in an external system. |
| productName | Name of associated product. |
| productVersion | Version of associated product. |
| state |
Status of the product suite. Possible values: >DRAFT >ENABLE >DISABLE |
CSV File Format for Entitlements
NOTE Data import is not supported for cloud-served lease and cloud-served connected entitlements.
The following sample displays the CSV file format for importing entitlement data. The first line shows the headers. The next lines show sample data.
For Sentinel RMS, Sentinel Fit, and Services:
entId,eId,externalId,dummyEid,revision,startDate,endDate,customer,custIdentifier,ccEmail,contact,contactExternalId,channelPartner,userRegistration,refId1,refId2,activationAllowed,allowActivationBy,revocationAllowed,lifeCycleStage,sendNotification,comments,productKey,PK_StartDate,PK_ExternalId,PK_EndDate,totalQuantity,availableQuantity,activationMethod,fixedQuantity,enforcementName,enforcementVersion,licenseType,suiteName,suiteVersion,externalPrdId,productId,productName,productVersion,externalFtrId,featureId,featureName,featureVersion,licenseModelIdentifier,itemFeatureState,EntitlementAsWhole,CAPACITY,CAPACITY_FLAG,COLLECT_USAGE,DURATION,FINGERPRINT_REGISTRATION,IS_SL_LEASE,RENEW_FREQUENCY,USAGE_SYNC_FREQUENCY,END_DATE,GRACE_TIME,LICENSE_DURATION_IN_DAYS,LICENSE_GENERATION_TIME,START_DATE,START_LICENSE_FROM_ACTIVATION_DATE,CONCURRENCY_CRITERIA,CONCURRENCY_LIMIT,FLOATING_SOFT_USER_LIMIT,FLOATING_USER_LIMIT,GRACE_LIMIT,GRACE_TIME_DURATION,KEY_LIFETIME_MINUTES,TRIAL_DURATION_DAYS,TRIAL_DURATION_HOURS,USAGE_LIMIT,CLIENT_1_CRITERIA,CLIENT_1_INFO,CLIENT_2_CRITERIA,CLIENT_2_INFO,CLIENT_3_CRITERIA,CLIENT_3_INFO,CLIENT_4_CRITERIA,CLIENT_4_INFO,CLIENT_5_CRITERIA,CLIENT_5_INFO,CLIENT_6_CRITERIA,CLIENT_6_INFO,CLIENT_7_CRITERIA,CLIENT_7_INFO,CODE_TYPE,CRITERIA,LOCAL_REQUEST_LOCKCRIT_FLAG,LOCAL_REQUEST_LOCKCRIT_FLOAT,LOCAL_REQUEST_LOCKCRIT_MIN_NUM,LOCAL_REQUEST_LOCKCRIT_REQUIRED,LOCKING_MODE,NUM_CLIENT_LOCKED,NUM_SERVERS,NUM_SUBNET,NUM_USERNODE,PRIMARY_10_CRITERIA,PRIMARY_10_INFO,PRIMARY_11_CRITERIA,PRIMARY_11_INFO,PRIMARY_1_CRITERIA,PRIMARY_1_INFO,PRIMARY_2_CRITERIA,PRIMARY_2_INFO,PRIMARY_3_CRITERIA,PRIMARY_3_INFO,PRIMARY_4_CRITERIA,PRIMARY_4_INFO,PRIMARY_5_CRITERIA,PRIMARY_5_INFO,PRIMARY_6_CRITERIA,PRIMARY_6_INFO,PRIMARY_7_CRITERIA,PRIMARY_7_INFO,PRIMARY_8_CRITERIA,PRIMARY_8_INFO,PRIMARY_9_CRITERIA,PRIMARY_9_INFO,REDUNDANT_SERVERS,SECONDARY_10_CRITERIA,SECONDARY_10_INFO,SECONDARY_11_CRITERIA,SECONDARY_11_INFO,SECONDARY_1_CRITERIA,SECONDARY_1_INFO,SECONDARY_2_CRITERIA,SECONDARY_2_INFO,SECONDARY_3_CRITERIA,SECONDARY_3_INFO,SECONDARY_4_CRITERIA,SECONDARY_4_INFO,SECONDARY_5_CRITERIA,SECONDARY_5_INFO,SECONDARY_6_CRITERIA,SECONDARY_6_INFO,SECONDARY_7_CRITERIA,SECONDARY_7_INFO,SECONDARY_8_CRITERIA,SECONDARY_8_INFO,SECONDARY_9_CRITERIA,SECONDARY_9_INFO,SITE_LIC_1_INFO,SITE_LIC_2_INFO,SITE_LIC_3_INFO,SITE_LIC_4_INFO,SITE_LIC_5_INFO,SITE_LIC_6_INFO,SITE_LIC_7_INFO,USERNODE_1_CRITERIA,USERNODE_1_INFO,USERNODE_2_CRITERIA,USERNODE_2_INFO,USERNODE_3_CRITERIA,USERNODE_3_INFO,USERNODE_4_CRITERIA,USERNODE_4_INFO,USERNODE_5_CRITERIA,USERNODE_5_INFO,USERNODE_6_CRITERIA,USERNODE_6_INFO,USERNODE_7_CRITERIA,USERNODE_7_INFO,ALLOW_COMMUTER,ALLOW_GRACE,COMMUTER_MAX_CHECKOUT_DAYS,GRACE_PERIOD_DAYS,GRACE_PERIOD_ELAPSED_HOURS,HOLDING_CRITERIA,IS_NETWORK,KEY_HOLDTIME_MINUTES,SHARING_CRITERIA,SHARING_LIMIT,DEPLOYMENT_TYPE,LICENSE_TYPE,NAMED_USER_LICENSE,NO_OF_NAMEDUSERS,USAGE_TYPE,ALLOW_REDUNDANCY,ALLOW_VM_DETECTION,ELAN_KEY_FLAG,ENFORCE_CLOCK_TAMPERED,ENFORCE_LICENSE_EXCLUSIVE,ENFORCE_REDUNDANCY_MAJORITY,IS_REDUNDANT,IS_TRIAL,KEY_TYPE,LICENSE_VERSION,LOG_ENCRYPT_LEVEL,NUMERIC_TYPE,OUTPUT_TYPE,REDUNDANCY_MAJORITY_RULE,USE_AUTH_CODE,LICENSE_VENDOR_INFO,VENDOR_COMMENTS,VENDOR_INFO,VENDOR_NUM_OF_SECRETS,VENDOR_PRIVATE_INFO,VENDOR_PUBLIC_INFO,VENDOR_SECRETS_1,VENDOR_SECRETS_2,VENDOR_SECRETS_3,VENDOR_SECRETS_4,VENDOR_SECRETS_5,VENDOR_SECRETS_6,VENDOR_SECRETS_7,ENF_ENT.DURATION,ENF_ENT.FINGERPRINT_REGISTRATION,ENF_ENT.RENEW_FREQUENCY,ENF_ENT.USAGE_SYNC_FREQUENCY,ENF_ENT.REDUNDANT_SERVERS,ENF_ENT.IS_REDUNDANT,ENF_ENT.REDUNDANCY_MAJORITY_RULE,USER_LIMIT,EXPIRY_DATE ,,externalId1,,,2023-01-15,,Trace Purdy,64a31c4c-7f30-4322-8544-3659925c5854,,,,,none,refId11,refI21,TRUE,ALL_USERS,TRUE,DRAFT,TRUE,comments1,,,,,1,1,FIXED,1,Sentinel RMS,9.8,,,,,,RMS,1,,,feature1,,Auto Checkout,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
For Sentinel LDK:
entId,eId,externalId,startDate,endDate,customer,custIdentifier,ccEmail,contact,contactExternalId,channelPartner,userRegistration,refId1,refId2,activationAllowed,allowActivationBy,lifeCycleStage,sendNotification,comments,productKey,PK_ExternalId,PK_StartDate,PK_EndDate,totalQuantity,availableQuantity,activationMethod,fixedQuantity,LDK.rehostState,LDKMemory.fileName,LDKMemory.text,LDKMemory.fileId,enforcementName,enforcementVersion,externalPrdId,productName,productVersion,featureId,featureName,licenseModelIdentifier,EntitlementAsWhole,LIC_TYPE,EXECUTIONS,COPY_DATES_FROM_ENTITLEMENT_LINE_ITEM,START_DATE,EXPIRATION_DATE,ENABLE_CONCURRENCY,CONCURRENT_INSTANCES,COUNT_EACH,ALLOW_DETACHING,REMOTE_DESKTOP,NETWORK,VIRTUAL_MACHINE,APPLY_LICENSE,NUMBER_OF_DAYS
,eId1,,,,,,,,,,,,,TRUE,ALL_USERS,DRAFT,,,,,,,10,10,FIXED,1,ENABLE,Default (Read-Only),656e7469746c656d656e742076616c7565,65525,Sentinel LDK,10.0,,LDKTest,1,,LDKTest,Perpetual,FALSE,,,,,,TRUE,10,,,TRUE,TRUE,FALSE,1,
,eId2,,,,,,,,,,,,,TRUE,VENDOR_ONLY,DRAFT,,,,,,,100,100,FIXED,1,,,,,Sentinel LDK,10.0,,LDKSample,1,,LDKSample,,TRUE,,,,,,,,,,,,,,
The following table describes some of the headers in an entitlement CSV file. For more details on adding an entitlement, see Creating Entitlements. For details on adding a custom attribute, see Using Custom Attributes.
| Header | Description |
|---|---|
| entId | Entitlement ID to identify entitlement in database uniquely. |
| eId | Entitlement ID to identify entitlement in the Sentinel EMS user interface and REST APIs. |
| externalId | External reference identifier that uniquely identifies the entitlement in an external system. |
| dummyEid |
This field identifies all records of an entitlement in CSV data load. The dummy EID is not saved in database. It is only used for identification during entitlement load file processing. |
|
NOTE When importing entitlement data from a CSV file, you must provide one of the following to identify the entitlement: >eId (if the Allow Manual Creation of EID and PKID property is set to Yes in Administration Console) >externalId >dummyEid |
|
| revision |
Entitlement revision number. Only for output. |
| startDate | (Required) Entitlement start date. The format is YYYY-MM-DD. If left blank, the current date is inserted. |
| endDate | (Required) Entitlement end date. The format is YYYY-MM-DD. If left blank, the date "2500-12-31" is inserted. |
|
NOTE For date-type custom attributes (CA_ENT.date-attribute-name), the format is YYYY-MM-DD format, similar to startDate and endDate. |
|
| customer | Customer name |
| custIdentifier | Custom-defined or automatically generated unique identifier of the customer. |
| ccEmail |
Email addresses to receive entitlement certificate (up to 15 comma-separated email addresses). |
| contact | Email address of the user. |
| channelPartner | Channel partner name. |
| userRegistration |
Specifies whether end user registration is required when logging on to the Sentinel EMS customer portal. Possible values: > None >Optional >Mandatory |
| refId1 | Reference identifier that identifies the entitlement in an external system. |
| refId2 |
Reference identifier that identifies the entitlement in an external system. |
| activationAllowed |
Whether the entitlement can be activated to generate a license. Requires lifeCycleStage be set to Complete. Possible values: >TRUE >FALSE Default if another value or no value is provided: TRUE |
| allowActivationBy |
The type of user that can activate the entitlement. Possible values: >ALL_USERS >VENDOR_ONLY Default if another value or no value is provided: ALL_USERS |
| revocationAllowed |
Possible values: > TRUE >FALSE Default if another value or no value is provided: TRUE |
| lifeCycleStage |
The state of the entitlement. Possible values: >DRAFT >COMPLETE Default if another value or no value is provided: DRAFT |
| sendNotification |
Whether notification must be sent for entitlements marked as "complete". Possible values: > TRUE >FALSE. If another value is provided or no value is provided, its value will be derived from Administration Console configuration. |
| productKey | The product key ID to be displayed. |
| PK_ExternalId | External reference identifier that uniquely identifies the product key in an external system. Can be used to identify the entitlement in an external system. |
| PK_StartDate |
Product key start date (line item start date). Format: YYYY-MM-DD If left blank, the value will be same as startDate. |
| PK_EndDate |
Product key end date (line item end date). Format: YYYY-MM-DD If left blank, the value will be same as endDate. |
| totalQuantity |
The total quantity available for activation. If left blank, the value is automatically set to 1. |
| availableQuantity | The remaining quantity for entitlement item activation. Relevant only for activated entitlements. For draft entitlements, the value is always totalQuantity, irrespective of input. |
| activationMethod |
The method of defining and allocating the quantity of licenses available for the product in the entitlement. Possible values: >FIXED >PARTIAL >FULL >UNLIMITED |
| fixedQuantity | The fixed number of licenses to consume in each activation. |
| LDK.rehostState |
Possible values: >ENABLE >DISABLE >LEAVE_AS_IS |
| LDKMemory.fileName |
Name of the memory file. |
| LDKMemory.text |
The memory data in text format. |
| LDKMemory.fileId |
Integer that identifies the memory file and is used by your application to refer to that file. |
| enforcementName |
(Required) The enforcement name for the entitlement item being created. If you enter a value here, you must also enter a value for enforcementVersion. If multiple enforcements exist in the system, you must provide the enforcementName and enforcementVersion for each enforcement. |
| enforcementVersion |
(Required) The enforcement version for the entitlement item being created. Specify the enforcement version used in Sentinel EMS. Entering any other enforcement version will prevent the entitlement from being generated correctly. You can use the GET call (Get Application Property endpoint) to get the enforcement version. If you enter a value here, you must also enter a value for enforcementName. If multiple enforcements exist in the system, you must provide the enforcementName and enforcementVersion for each enforcement. |
| licenseType |
Not in use. Leave blank. |
| suiteName |
Name of the product suite* in the entitlement. |
| suiteVersion |
Version of product suite* in the entitlement. |
|
NOTE You must provide a combination of |
|
| externalPrdId | External reference identifier that uniquely identifies the product in an external system. |
| productId |
Product Identifier of product to identify a product for entitlement item. |
| productName |
Product name to identify a product for entitlement item. If this is provided then product version must not be blank. |
| productVersion |
Product version identify a product version for entitlement item. If this is provided then product name must not be blank, else error is thrown and entitlement is not saved.
|
|
NOTE When importing products to associate them with an entitlement (using CSV or JSON), use a unique product identifier, such as externalPrdId or a combination of productName and productVersion. However, do not use productId alone, because it is not unique in Sentinel LDK. |
|
| externalFtrId |
External reference identifier that uniquely identifies the feature in an external system. |
| featureId | Feature ID that identifies the product feature in the entitlement. |
| featureName | Feature name that identifies the product feature in the entitlement. |
| featureVersion |
|
| licenseModelIdentifier |
Name of the license model associated with the feature. |
| itemFeatureState |
Possible values: >INCLUDED >EXCLUDED |
| EntitlementAsWhole |
Whether to perform activations Default: false |
|
COPY_DATES_FROM_ENTITLEMENT_LINE_ITEM |
Specifies if Sentinel EMS should automatically update the start date and/or end date defined in a feature's license models to match the line item in an entitlement when the line item's start date and/or end date are set. |
|
START_DATE |
The date before which the licensed software cannot be run. The date format is MM/DD/YYYY. |
|
EXPIRATION_DATE |
The date after which the licensed software cannot be run. The date format is MM/DD/YYYY. |
| Various license model attributes |
Specify only the relevant license model values for the entitlement.
|
CSV File Format for Downloads
The following sample displays the CSV file format for importing download data. The first line shows the headers. The next lines show sample data.
Action,name,version,externalId,releasedDate,description,isEnable,eol,isAttachable,fileName,fileSize,logobinary,downloadLocation,Productid,ProductIdentifier,ProductExtenalId,ProductName,ProductVersion,ProductAssociationState,AssociateDownloadId,AssociateDownloadName,AssociateDownloadVersion,AssociateDownloadExternalId,CustomerId,CustomerName,CustIdentifier,CustExternalId,ISLEGACY CREATE,D501,1.2,501a,2014-08-08,Test,TRUE,FALSE,TRUE,P1_Logo.jpg,115kb,22sd23232090hfgfgfgfgfgfggrfgfgfgfg,http://localhost:8080/P1.Logo,1,,,,,Active,1,,,,1,,,,1 CREATE,D501,1.2,801e,8/8/2014,Test,TRUE,FALSE,TRUE,P1_Logo.jpg,115kb,22sd23232090hfgfgfgfgfgfggrfgfgfgfg,http://localhost:8080/P1.Logo,1,,,,,Active,1,,,,1,,,,1
The following table describes the headers in a download CSV file. For more details on adding a download file, see Downloads. For details on adding a custom attribute, see Using Custom Attributes.
| Header | Description |
|---|---|
| Action |
Operation performed during data-load through CSV. Possible value: CREATE |
| name | (Required) Download name. |
| version | Download version. |
| externalId | External reference identifier that uniquely identifies the download in an external system. |
| releasedDate |
Date from which the content will be available for download. Format: YYYY-MM-DD |
| description | Download description. |
| isEnable |
Download status, where true creates an enabled download and false creates a disabled download that cannot be downloaded. Possible values: > TRUE >FALSE |
| eol | Marks download as End of Life. This value is always specified as FALSE as downloads cannot be created in EOL state. |
| isAttachable |
Specifies whether to attach the download link to entitlement and license certificate emails.. Possible values: > TRUE >FALSE |
| fileName | (Required) Name of the attached download file. |
| fileSize | Size of the attached download file . |
| logobinary | Binary input of the logo. |
| downloadLocation | URL for downloading a product. |
| Productid |
Product Identifier for the product linked to the download. |
| ProductIdentifier |
For internal use. Leave blank. |
| ProductExtenalId | External reference identifier that uniquely identifies the product in an external system. This is for the product linked to the download. |
| ProductName | Name of the product linked to the download. |
| ProductVersion | Version of the product linked to the download. |
| ProductAssociationState |
State of product association. Possible values: > Active >Inactive Default value: Active |
| AssociateDownloadId | Associated download ID for the main download. |
| AssociateDownloadName | Associated download name for the main download. |
| AssociateDownloadVersion | Associated download version for the main download. |
| AssociateDownloadExternalId | External reference identifier that uniquely identifies the download in an external system. Used to identify the associated download. |
| CustomerId | Customer Identifier. |
| CustomerName | Name of the customer. |
| CustIdentifier | Unique identifier for the customer. |
| CustExternalId |
External reference identifier that uniquely identifies the customer in an external system. |
| ISLEGACY | Record exists from a version of Sentinel EMS earlier than 5.3. |
CSV File Format for Named Users
The following sample displays the CSV file format for importing named users.
Named Users User_1 User_2 User_3 User_4 User_5