Appendix B:
CSV File Formats for Data Import
|
Related Topic
|
You can use the information in this section to create a CSV document with data for entities such as customers, contacts, features, products, entitlements, or downloads. This CSV file can then be used for importing data.
Important
>When uploading data for an entity using CSV files, any header name other than those defined in the CSV is treated as a custom attribute.
>All required attribute (header) names are reserved and a custom attribute with the same name cannot be created.
>To ensure that a CSV file containing special characters is imported successfully, save the CSV file in UTF-8 format.
CSV File Format for Customer
The following is a sample CSV file format for importing customer data:
name,customerCRMId,description,enabled,refId Customer1,3,Customer1 Description,true,1 Customer2,4,Customer2 Description,true,2 Customer3,5,Customer3 Description,true,3 Customer4,6,Customer4 Description,true,4
The following table describes the headers in a customer CSV file:
| 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. |
CSV File Format for Contacts
The following is a sample CSV file format for importing contact data:
contactEmail,contactPassword,contactName,contactNumber,locale,refId1,refId2,shipAddr,shipAddrCity,
shipAddrCountry,shipAddrState,shipAddrZip,billAddr,billAddrCity,billAddrCountry,billAddrState,billAddrZip,
customerName
contact1@domain.com,xxxxxxx,Contact1,Contact Number,en,2,3,Shiping Address,Shiping City,Shiping Country,Shiping State,Shiping Zip,Billing Address,Billing City,Billing Country,Billing State,Billing Zip,Customer1
contact2@domain.com,xxxxxxx,Contact2,Contact Number,en,2,3,Shiping Address,Shiping City,Shiping Country,Shiping State,Shiping Zip,Billing Address,Billing City,Billing Country,Billing State,Billing Zip,Customer2
The following table describes the headers in a contact CSV file:
| Header | Description |
|---|---|
| contactEmail | (Required) Contact's email addresses |
| contactPassword | Contact's Password |
| contactName | Name of the contact |
| contactNumber | Contact's telephone/mobile number |
| locale | Locale |
| refId1 | Reference ID. Used to connect to an external CRM. |
| refId2 | Alternate reference ID. Used to connect to an external CRM. |
| shipAddr | Shipping address |
| shipAddrCity | Shipping address city |
| shipAddrCountry | Shipping address country |
| shipAddrState | Shipping address state |
| shipAddrZip | Shipping address zip code |
| billAddr | Billing address |
| billAddrCity | Billing address city |
| billAddrCountry | Billing address country |
| billAddrState | Billing address state |
| billAddrZip | Billing address zip code |
| customerName | Name of the customer associated with the contact. |
CSV File Format for Features
The following is a sample CSV file format for importing feature data:
namespaceName,externalFtrId,featureId,featureIdentifier,featureName,featureVersion,description,refId1,refId2,licenseModelName,isDefaultLm NM1,122,15,123,Ftr1,1.1,desc,r1,r2FALSE
The following table describes the headers in a feature CSV file:
| Header | Description |
|---|---|
| namespaceName | (Required) Associated namespace |
| externalFtrId | External feature ID |
| featureId | Feature ID is generated in database and should be excluded in the CSV input. A custom attribute of the same name cannot be created. |
| featureIdentifier | Unique feature identifier provided by customer. This field is mandatory for lease licenses. |
| featureName | (Required) Name of the feature. |
| featureVersion | Feature version. |
| 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 | (Required) Name of associated license model |
| isDefaultLm | (Required) Flag specifying whether or not the license model associated with the feature is marked as default. |
CSV File Format for Products
The following is a sample CSV file format for importing product data:
NamespaceName,ExternalPrdId,ProductId,ProductName,ProductVersion,RefId1,RefId2,Description,State,ExternalFtrId,FeatureId,FeatureName,FeatureVersion,ProductFeatureState,DefaultLicenseModel,IsLicenseModelFixed ,componentMultiplier,familyId,familyName,ActivationMethod,FixedQuantity,productType,Prd_Enf.LICENSE_VERSION,Prd_Enf.NUM_CLIENT_LOCKED,Prd_Enf.CLIENT_1_CRITERIA,Prd_Enf.CLIENT_2_CRITERIA,Prd_Enf.CLIENT_3_CRITERIA,Prd_Enf.CLIENT_4_CRITERIA,Prd_Enf.CLIENT_5_CRITERIA,Prd_Enf.CLIENT_6_CRITERIA,Prd_Enf.CLIENT_7_CRITERIA,Prd_Enf.NUM_SERVERS,Prd_Enf.PRIMARY_1_CRITERIA,Prd_Enf.PRIMARY_2_CRITERIA,Prd_Enf.PRIMARY_3_CRITERIA,Prd_Enf.PRIMARY_4_CRITERIA,Prd_Enf.PRIMARY_5_CRITERIA,Prd_Enf.PRIMARY_6_CRITERIA,Prd_Enf.PRIMARY_7_CRITERIA,Prd_Enf.PRIMARY_8_CRITERIA,Prd_Enf.SECONDARY_1_CRITERIA,Prd_Enf.SECONDARY_2_CRITERIA,Prd_Enf.SECONDARY_3_CRITERIA,Prd_Enf.SECONDARY_4_CRITERIA,Prd_Enf.SECONDARY_5_CRITERIA,Prd_Enf.SECONDARY_6_CRITERIA,Prd_Enf.SECONDARY_7_CRITERIA,Prd_Enf.SECONDARY_8_CRITERIA,Prd_Enf.PRIMARY_9_CRITERIA,Prd_Enf.PRIMARY_10_CRITERIA,Prd_Enf.PRIMARY_11_CRITERIA,Prd_Enf.SECONDARY_9_CRITERIA,Prd_Enf.SECONDARY_10_CRITERIA,Prd_Enf.SECONDARY_11_CRITERIA,Prd_Enf.ALLOW_VM_DETECTION,Prd_Enf.NUM_USERNODE,Prd_Enf.USERNODE_1_CRITERIA,Prd_Enf.USERNODE_2_CRITERIA,Prd_Enf.USERNODE_3_CRITERIA,Prd_Enf.USERNODE_4_CRITERIA,Prd_Enf.USERNODE_5_CRITERIA,Prd_Enf.USERNODE_6_CRITERIA,Prd_Enf.USERNODE_7_CRITERIA,Prd_Enf.DURATION,Prd_Enf.USAGE_SYNC_FREQUENCY,Prd_Enf.RENEW_FREQUENCY,Prd_Enf.IS_REDUNDANT,Prd_Enf.REDUNDANCY_MAJORITY_RULE,Prd_Enf.REDUNDANT_SERVERS,Prd_Enf.FINGERPRINT_REGISTRATION,
The following table describes the headers in a product CSV file:
| Header | Description |
|---|---|
| NamespaceName | (Required) Associated namespace |
| ExternalPrdId | External product ID |
| ProductId | Product ID is generated in database and should be excluded in the CSV input. A custom attribute of the same name cannot be created. |
| ProductName | (Required) Product name |
| ProductVersion | (Required) Version number |
| 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 | Product state |
| ExternalFtrId | (Required) External feature ID |
| FeatureId | (Required) Associated feature ID |
| FeatureName | (Required) Feature name |
| FeatureVersion | (Required) Feature version |
| DefaultLicenseModel | Default license model name associated with the feature |
| ProductFeatureState |
Defines behavior of feature in a product when the product is added in an entitlement. Values: DefaultOff/DefaultOn/Mandatory |
| IsLicenseModelFixed | Flag specifying whether the license model associated with the feature is fixed when an entitlement is created. |
| componentMultiplier | Multiplying factor at product feature relationship level. |
| familyId | Product family ID |
| familyName | Product family name |
| ActivationMethod | The activation method (Fixed, Partial, |
| FixedQuantity | For Fixed activation method: the quantity that must be consumed for each activation. |
CSV File Format for Entitlements
The following is a sample CSV file format for importing entitlement data:
entId,eId,externalId,dummyEid,revision,startDate,endDate,customer,contact,channelPartner,userRegistration,refId1,
refId2,activationAllowed,lifeCycleStage,sendNotification,productKey,PK_StartDate,PK_EndDate,totalQuantity,availableQuantity,isNoOfActivationBased,enforcementName,enforcementVersion,licenseType,suiteName,
externalPrdId,productId,productName,productVersion,externalFtrId,featureId,featureName,
featureVersion,licenseModel,START_DATE,END_DATE,START_LICENSE_FROM_ACTIVATION_DATE,LICENSE_DURATION_IN_DAYS,CA_ENT.attr1,
The following table describes the headers in an entitlement CSV file:
| Header | Description |
|---|---|
| entId | Entitlement ID to identify entitlement in database uniquely. |
| eId | Entitlement ID to identify entitlement on user interface. |
| externalId | User entry to uniquely identify entitlement. |
| 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. |
| revision | Entitlement revision number. Only for output. |
| startDate | Entitlement start date, format YYYY-MM-DD. If blank, current date is inserted. |
| endDate | Entitlement end date, format YYYY-MM-DD .If blank, the date "2500-12-31" is inserted. |
| customer | Customer name |
| contact | Email address of contact |
| channelPartner | Channel partner name |
| userRegistration | Type of registration required for entitlement. Possible values None, Optional, and Mandatory. If blank, the value is derived from user registration configuration in Administration Console. Input is case-insensitive. |
| refId1 | Reference ID 1 |
| refId2 | Reference ID 2 |
| activationAllowed | Entitlement license activation allowed (entitlement enabled). The possible values are TRUE and FALSE. Both values case-insensitive. If other value provided or no value provided, default will be TRUE. |
| lifeCycleStage | The state of entitlement. Possible values are DRAFT and COMPLETE. Both case insensitive. If any other value is provided or if input is blank then value will be DRAFT. |
| sendNotification | Flag to tell whether notification must be send for entitlement marked as "complete". Possible values are TRUE or FALSE. Both values case-insensitive. If other value provided or no value provided, its value will be derived from Administration Console configuration. |
| productKey | The product key ID to be displayed on user interface. |
| PK_StartDate | Product key start date( entitlement-item start date). Format YYYY-MM-DD. If blank ,it will be same as entitlement start date |
| PK_EndDate | Product key end date( entitlement-item end date). Input format is YYYY-MM-DD. If blank, value will be same as entitlement end date. |
| totalQuantity | The total available quantity of entitlement item activation. If blank default is 1. |
| availableQuantity | The remaining quantity for entitlement item activation. For draft stage entitlement irrespective of input it is equal to total quantity. Its significance will be only for activated entitlements. |
| isNoOfActivationBased | This field is used to decide whether line item is based on the number of activations or the seat count. Possible values are TRUE or FALSE. Both values case-insensitive. If not provided its value will be derived from Administration Console configuration. If provide value is other than possible value, it will be TRUE. |
| enforcementName | The name of enforcement for which entitlement item is being created. |
| enforcementVersion | The version of enforcement for entitlement item is being created. If enforcement is provided, enforcementVersion is must. Also if multiple enforcement exists in the system. It is mandatory to provide input in both enforcement name enforcement version field. |
| licenseType |
|
| externalPrdId | External ID of product to identify a product for entitlement item. |
| productId | Product ID 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. |
| externalFtrId | External ID of feature to identify a feature for entitlement item product. |
| featureId | Feature ID of feature to identify a feature for entitlement item product. |
| featureName | Feature name of feature to identify a feature for entitlement item product |
| featureVersion | Feature version of feature to identify a feature for entitlement item product. |
| licenseModel | Name of license model for feature. |
| CA_ENT.attr1 |
Custom attributes input for date type of custom attribute will be in YYYY-MM-DD format. Note that custom attribute name in custom attribute header is case-sensitive. However prefix (CA_ENT.) is not case-sensitive. NOTE All custom attributes in the CSV file are preceded by the prefix CA. |
CSV File Format for Downloads
The following is a sample CSV file format for importing download data:
Action name version releasedDate license vendor description isEnable eol
isAttachable fileName fileSize logobinary downloadLocation
Productid ProductExtenalId ProductName ProductVersion LinkedProductType
ProductAssociationState AssociateDownloadId AssocaiteDownloadName AssocaiteDownloadVersion
DownloadAssociationType CREATE D501 1.2 8/8/2014 Trial Test Test TRUE FALSE TRUE
P1_Logo.jpg 115kb 22sd23232090hfgfgfgfgfgfggrfgfgfgfg http://localhost:8080/P1.Logo
1 Base Active 1 Base
The following table describes the headers in a download CSV file:
| Header | Description |
|---|---|
| Action | Operation performed during data-load through CSV, such as, CREATE,UPDATE,ATTACH,DETACH. |
| name | Download name |
| version | Download version |
| releasedDate | Date of release of product download. |
| license | Download license |
| vendor | Download vendor |
| description | Download description |
| isEnable | Download state as enabled or disabled. Valid values are true or false where true is for enable and false creates download in disabled state. |
| eol | Marks download as End of Life. This value is always specified as false as download cannot be created in EOL state. |
| isAttachable | Attach license certificate email in download or not. Certificate valid values are true or false. |
| fileName | Name of attached file download. |
| fileSize | Size of attached file download. |
| logobinary | Binary input of logo. |
| downloadLocation | URL for downloading a product. |
| Productid | Product ID to link download. |
| ProductExtenalId | Extenal ID of product to link download. |
| ProductName | Name of product to link download. |
| ProductVersion | Version of product to link download. |
| LinkedProductType | Type of linked product. Default value is "Base". Other existing values are Alternative and Patch. If any other value is provided than the existing options then that value is also saved as a choice and linked with association of product. |
| ProductAssociationState | State of product association. Valid values are "Active" and "Inactive" . Default value is active. |
| AssociateDownloadId | Associated download ID for the main download. |
| AssocaiteDownloadName | Associated download name for the main download. |
| AssocaiteDownloadVersion | Associated download version for the main download. |
| DownloadAssociationType | Type of associated product. Existing options are Documentation and Prerequisites. If any other value is provided than the existing options then that value is also saved as a choice and linked with association of product. |