Summary
This document will provide the necessary information when importing files for creating equipment in Equipment Inventory using the Bulk Data application.
Link
File Format
General Format
The following general characteristics apply to the Create Equipment import files:
File naming convention must be *.csv
A header is required
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 equipment file the identifier is:
FORMAT:IDI/CostGuardBulkData/EquipmentInventory
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 the columns, only the columns that contain data to be imported are necessary.
Custom Properties
An import file may include any number of custom properties for equipment inventory. In the file header record, the custom properties must be pre-fixed as follows:
ATTR_<attribute property name>
When using custom properties, please contact customer support for the specific property name to use in the Bulk Data file header. Only property display names are visible within the IDI platform and may not match the corresponding property name.
Clear Values
This import file does not support the ability to clear previously set data.
Record Layout
Note:
If values are supplied for any ‘ServiceAddress’ fields, they are used in combination to search for matching service addresses.
When exactly one matching result is found, that service address ID is assigned to the equipment.
If no match is found, a new service address is created with those values, unless a specific ServiceAddressID was specified in which case it was invalid so an error occurs.
If more than one matching service address is found, this is also an error because a unique match could not be found.
Column Name | Required | Data Type | Description |
|---|---|---|---|
ATTR_* | No | Text | Contains the value of a custom property for the equipment inventory being added or modified. There may be zero or more custom properties included in an import file. See the Custom Properties section above.. |
AvailableDate | No | Integer | Date the equipment is available to be used. |
Cost | No | Decimal | Cost associated to the equipment. |
EquipmentDataSourceID | No | Integer | Unique identifier for the assigned EquipmentDataSource. |
EquipmentOwnerID | No | Integer | Unique identifier for the owner of the equipment. |
EquipmentTypeID | Yes | Integer | Unique identifier for the type of the equipment. |
InventoryID | Yes | Integer | Unique identifier for the inventory that the equipment is assigned to. |
InventoryItemStatusID | Yes | Integer | Unique identifier for the current inventory status of the equipment. |
Name | Yes | Text | Name of the equipment. |
ReferenceNumber | No | Text | Reference number for the equipment. |
ServiceAddressCity | No | Text | City of the service address. |
ServiceAddressDesignator1 | No | Text | Designation type for Designator1 of the service address. Valid Values: Any value from the configured list of accepted Designator1 values. |
ServiceAddressDesignator1Value | No | Text | Value for Designator1. |
ServiceAddressDesignator2 | No | Text | Designation type for Designator2 of the service address. Valid Values: Any value from the configured list of accepted Designator2 values. |
ServiceAddressDesignator2Value | No | Text | Value for Designator2. |
ServiceAddressDesignator3 | No | Text | Designation type for Designator3 of the service address. Valid Values: Any value from the configured list of accepted Designator3 values. |
ServiceAddressDesignator3Value | No | Text | Value for Designator1. |
ServiceAddressID | No | Integer | Unique identifier for the service address of the equipment. |
ServiceAddressLocation | No | Text | The location for the service address. |
ServiceAddressLoopLength | No | Decimal | The loop length for the service address. |
ServiceAddressMSAGCommunity | No | Text | MSAG community for the service address. Valid Values: Any MSAG from the configured list of MSAGs. |
ServiceAddressMSAGCounty | No | Text | MSAG county for the service address. |
ServiceAddressMSAGProviderID | No | Integer | Unique identifier for the MSAG provider of the service address. |
ServiceAddressNote | No | Text | Notes for the service address. |
ServiceAddressRateCenterID | No | Integer | Unique identifier for the rate center of the service address. |
ServiceAddressState | No | Text | State for the service address. |
ServiceAddressStatus | No | Text | Status of the service address. Valid Values: Approved, NotApproved, PendingApproval or Retired. |
ServiceAddressStreetDirectionPrefix | No | Text | Prefix indicating the direction of the street. Valid Values: E, N, NE, NONE, NW, S, SE, SW, or W. |
ServiceAddressStreetDirectionSuffix | No | Text | Suffix indicating the direction of the street. Valid Values: E, N, NE, NONE, NW, S, SE, SW, or W. |
ServiceAddressStreetName | No | Text | Name of the street for the service address. |
ServiceAddressStreetNumber | No | Integer | Street number for the service address. |
ServiceAddressStreetNumberPrefix | No | Text | Prefix for the street number of the service address. |
ServiceAddressStreetNumberSuffix | No | Text | Suffix for the street number of the service address. |
ServiceAddressTaxCounty | No | Text | Tax county of the service address. |
ServiceAddressThoroughfare | No | Text | The thoroughfare for the service address. Valid Values: Any thoroughfare from the configured list of accepted thoroughfares. |
ServiceAddressWireCenterID | No | Integer | Unique identifier for the wire center of the service address. |
ServiceAddressZipCode | No | Text | Zip code for the service address. |
StatusChangeDate | Yes | Date | Date and time that the status of the equipment was changed. |
WireCenterID | Yes | Integer | Unique identifier for the wire center of the equipment. |
Document Version History
Version | Change Description | Change Date |
|---|---|---|
1.0 | Version 19.9 | 08/29/2019 |