Summary
This document will provide the necessary information when importing files for updating provisioning properties using the Bulk Data application. Provisioning properties can be updated using the Bulk Data application or imported through the Orders application.
Link:
File Format
General Format
The following general characteristics apply to Provisioning Properties import files:
File naming convention must be *.csv
A header is not required if you import via the Bulk Data or Orders application. The header record is required if you use an automated method, like SFTP.
The header must be followed by one or more comma-delimited detail records
Place quotes (“) around any text fields containing a comma.
Empty (non-required) fields are acceptable.
The columns are not required to appear in a specific order.
You do not have to include all columns in an import file.
Import Identifier
The import identifier is optional if you import files via the Bulk Import web module. The correct identifier is automatically applied by selecting the type of import.
If you import using the file automation method by uploading files and placing them on the file server, the first row of the file must have the file format identifier, starting in the first position of the first row. For the provisioning properties file the identifier is:
FORMAT:IDI/CostGuardBulkData/Orders/ProvisioningProperties
Note:
“Format:” is part of the identifier and must be included.
Header Record
The import file must contain the appropriate column names. This is typically the first row if you use the Bulk Import module. It is the second row if you use the file automation method. The column names can be found in the Record Layout section of this document. The columns do not need to appear in a specific order. Import files do not need to include all of the columns, only the columns that contain data to be imported are necessary.
Clear Values
The modify provisioning properties import file supports the ability to clear previously set data. To clear data, submit a record with an empty/blank value.
Record Layout
Special Data Types:
DateTime:
Standard format is YYYY-MM-DD HH:MM:SS (e.g. 2020-04-17 11:28:00)
HH:MM:SS (time) may be omitted
Value:
The values should match the data types associated with the provisioning properties; otherwise, the record may error upon import.
For List properties, the system will validate that the value matches the values contained in the configured list.
Field | Data Type | Required | Description |
|---|---|---|---|
OrderID | Integer | Yes | Unique Identifier of the Order. |
ServiceInformationItemID | Integer | Conditionally | Unique Identifier of the service on the order. Required if Service Number and Code is not included. |
IsAccountLevel | Yes/No | No | Yes or No value that indicates if the provisioning properties are the account level. |
ServiceAction | Text | No | Service order action if the provisioning properties are assigned to a service. |
FeatureAction | Text | No | Service order action if the provisioning properties are assigned to a feature. |
ServiceNumber | Text | Conditionally | Service Number to which the provisioning properties are associated. Required if ServiceInformationItemID is not included. |
ServiceType | Text | No | Service type of the service to which the provisioning properties are associated. |
Code | Text | Conditionally | Unique identifier assigned to the Provisionable Object. Required if ServiceInformationItemID is not included. |
DataType | Text | No | Data type of the provisioning property. Review configuration of the provisionable object to determine the data type. |
ProvisioningPropertyName | Text | Yes | Name of the provisioning property configured on the provisionable object. |
Value | Text | No | Value assigned to the provisioning property. |
Errors
Each line will be individually evaluated for errors. Error messages will be written to an error file, which can be downloaded from the file details page in the Bulk Data web module.